Administering Actuate iServer 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 - 2004 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, the Actuate logo, e.Analysis, Correlink, Correlink Framework, e.Report,
e.Reporting, e.Spreadsheet, Encyclopedia Formula One, Internet Spreadsheet, Lens,
Lens Builder, Live Report Document, Nimble, the Nimble logo, Nimble Technology,
Pace, ReportCast, Report Encyclopedia, ReportingEngines, the ReportingEngines
logo, Reportlet, Spreadsheets Everywhere, Tidestone Technologies, and XML reports.
Third party trademarks or registered trademarks of their respective owners,
companies, or organizations:
Apache Software Foundation (http://www.apache.org/): Axis, Crimson,
Jakarta-ORO, Tomcat, Xalan, Xerces, and XML4C. Apple Computer, Inc.: Mac OS,
Macintosh, TrueType. BEA Systems, Inc.: BEA Liquid Data for WebLogic, BEA
WebLogic Portal, BEA WebLogic Portal Server, BEA WebLogic Server, BEA WebLogic
Workshop. Bits Per Second, Ltd. and Graphics Server Technologies, L.P.: Graphics
Server. Borland Software Corporation: JBuilder. Bruno Lowagie and Paulo Soares:
iText, licensed under the Mozilla Public License (MPL). Codejock Software: Xtreme
Toolkit. Component One, LLC.: VSFlexGrid Pro. DataDirect Technologies Corp:
DataDirect Connect. Fred L. Drake, Jr. (http://sourceforge.net/projects/expat):
Expat XML parser, created by James Clark, licensed under the MIT License. Hewlett-
Packard Company: HP-UX. IBM Corporation: 1-2-3, AIX, DB2, Informix-ESQL/C,
ICU, Lotus, and WebSphere. Indiana University Extreme! Lab (http://
www.extreme.indiana.edu): XML Pull Parser and XPP. InstallShield Corporation:
InstallShield. InterNetivity Inc.: Databeacon. JDBM Project (http://
jdbm.sourceforge.net): JDBM. LEAD Technologies, Inc.: LEADTOOLS. Linus
Torvalds: Linux. Lucent Technologies, Inc.: FPDTOA, created by David M. Gay.
Microsoft Corporation: ActiveX, Microsoft, MS-DOS, MSN, Windows. Nanode LLC:
OpenJNLP, licensed under the Mozilla Public License (MPL). Netscape
Communications Corporation, Inc.: Netscape, Netscape Communications, Netscape
Communicator, Netscape Enterprise Server, and Netscape Navigator. The OpenSSL
Project (http://www.openssl.org/): Mac OS X, Mac OS X Server, OpenSSL Toolkit.
Oracle Corporation: Oracle Call Interface. Progress Software Corporation: Progress.
Quadralay Corporation: WebWorks. Rogue Wave Software, Inc.: NobleNet RPC and
Rogue Wave SourcePro. SAP AG: SAP, SAP BW, SAP R/3. Sun Microsystems, Inc.:
100% Pure Java, iPlanet, J2EE, Java and all Java-based marks, JavaServer Pages, ONC,
Solaris, SPARC, Sun, Sun Microsystems, and Sun ONE. Sybase, Inc.: CT-Library.
Symantec Corporation: Visual Cafe. Unicode, Inc.: Unicode. World Wide Web
Consortium (W3C): HTML Tidy and tidy.c. X/Open Company, Ltd.: UNIX. Zero G
Software, Inc.: InstallAnywhere. Zope Corporation: DCLC and Digital Creations.
All other brand or product names are trademarks or registered trademarks of their
respective owners, companies or organizations.
Document No. 040628-2-530301 June 30, 2004
 Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xix
Exploring Actuate 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Addressing diverse customer profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xx
Addressing customer requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Supporting international information delivery requirements . . . . . . . . . . . . . . . . . xxi
Providing a scalable, high-performance server . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Providing a complete information delivery solution . . . . . . . . . . . . . . . . . . . . . . xxii
Introducing the Actuate 8 and ReportingEngines product suites . . . . . . . . . . . . . . . xxiii
About the Actuate iServer System product . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxviii
About Administering Actuate iServer System . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxi
Online documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiii
Using online manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiv
Using online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiv
Using the Actuate online help system. . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiv
Using report-specific online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxvi

Part 1
Introducing Actuate iServer
Chapter 1
Actuate iServer architecture overview . . . . . . . . . . . . . . . . . . . . . . 3
Introducing Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
About the Actuate iServer architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
About Actuate Process Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
About Actuate resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Configuration overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Working with Actuate iServer System licensing . . . . . . . . . . . . . . . . . . . . . . . . . 9
Understanding Actuate iServer license features . . . . . . . . . . . . . . . . . . . . . . . .10
Understanding the Actuate iServer System options . . . . . . . . . . . . . . . . . . . . . .10
Examining a sample stand-alone configuration . . . . . . . . . . . . . . . . . . . . . . . . . .13
Examining a sample cluster configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
About default Actuate iServer configurations . . . . . . . . . . . . . . . . . . . . . . . . . . .16
About starting Actuate iServer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
About restarting Actuate iServer in a default configuration . . . . . . . . . . . . . . . . .17
About Actuate iServer cluster configuration . . . . . . . . . . . . . . . . . . . . . . . . . . .17
Understanding Encyclopedia volume configuration . . . . . . . . . . . . . . . . . . . . . . .19
Understanding partition configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

i
 Understanding how Actuate iServer uses partitions. . . . . . . . . . . . . . . . . . . . . 21
Removing partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Working with clustered volumes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Understanding Actuate iServer administration. . . . . . . . . . . . . . . . . . . . . . . . . . . 22
About administering Actuate iServer in a stand-alone configuration. . . . . . . . . . . . . 22
About administering an Actuate iServer cluster and Actuate iServer nodes . . . . . . . . . 22
About Encyclopedia volume administration. . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Part 2
Working with the Actuate iServer System environment
Chapter 2
Setting up Actuate iServer System hardware . . . . . . . . . . . . . . . . 27
Configuring Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Setting up an Actuate iServer account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Setting up an Actuate iServer account and software on a Windows machine . . . . . . 29
Setting up an Actuate iServer account on a UNIX machine . . . . . . . . . . . . . . . . . 31
About the Actuate open security feature . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Accessing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Using fonts with Actuate iServer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Generating large files on a UNIX server . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Setting a limit for UNIX file descriptors . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Controlling Actuate iServer thread stack size. . . . . . . . . . . . . . . . . . . . . . . . . 35
About Actuate iServer ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
About acpmdconfig.xml in Actuate iServer Release 8 . . . . . . . . . . . . . . . . . . . . 36
Controlling Process Manager connections . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Specifying a database configuration file. . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Specifying a global search path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Controlling Excel data output from Actuate Basic files . . . . . . . . . . . . . . . . . . . 38
Starting Actuate iServer on UNIX when you reboot . . . . . . . . . . . . . . . . . . . . . 39
Controlling stand-alone Actuate iServer startup . . . . . . . . . . . . . . . . . . . . . . . 39
Controlling how stand-alone Actuate iServer restarts . . . . . . . . . . . . . . . . . . . . 40
Starting and stopping Actuate Management Console . . . . . . . . . . . . . . . . . . . . 40
Controlling how Actuate Management Console restarts . . . . . . . . . . . . . . . . . . 41
Using automatic disk space checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
About the Actuate iServer machine’s system time . . . . . . . . . . . . . . . . . . . . . . 42
Finding the Actuate iServer home directory . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
About Actuate iServer temporary files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Displaying Actuate iServer release information . . . . . . . . . . . . . . . . . . . . . . . . . 43
Configuring Actuate iServer processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Configuring the default locale for the Factory process on a Windows system . . . . . . 44

ii
 Configuring the Factory process to search for Actuate Basic report fonts. . . . . . . . . .44
Configuring a Factory process resource group . . . . . . . . . . . . . . . . . . . . . . . . .45
Configuring View process to search for Actuate Basic report fonts . . . . . . . . . . . . .45
Disabling job notices in an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . .45
Configuring Actuate iServer to use a report generation option . . . . . . . . . . . . . . . . .46
Accessing Actuate-specific Java files for report generation . . . . . . . . . . . . . . . . . .47
Specifying the maximum heap size for the JVM that Actuate iServer uses . . . . . . . . .47
Using a JRE with Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
Configuring Actuate iServer System to use Actuate e.Spreadsheet Option. . . . . . . . .49
Configuring Actuate iServer System to use e.Report Option for a
Formula One report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Configuring open server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Configuring open server for SQRIBE on a Windows machine . . . . . . . . . . . . . . . .53
Configuring open server for Crystal Reports on a Windows machine . . . . . . . . . . .53
Configuring the Actuate iServer locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Configuring year conversion for Actuate Basic reports . . . . . . . . . . . . . . . . . . . . .55
Setting up e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
About Actuate iServer System e-mail notification . . . . . . . . . . . . . . . . . . . . . . .56
Understanding Actuate iServer e-mail notification configuration . . . . . . . . . . . . . .56
Setting up Actuate iServer e-mail notification using SMTP. . . . . . . . . . . . . . . . . .56
Setting up Actuate iServer e-mail notification using Microsoft Exchange . . . . . . . . .57
Setting up Actuate iServer e-mail notification on a UNIX machine using sendmail . . . .59
About the Actuate iServer e-mail notice . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Setting the URL prefix for e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . .60
Customizing the e-mail notice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Printing on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
About report encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Working with fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Mapping fonts for charts in Actuate Basic reports . . . . . . . . . . . . . . . . . . . . . . . .67
Using default fonts for charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Configuring text for languages in graphs. . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Configuring Actuate iServer to search for fonts for an Actuate Basic report. . . . . . . . . .69
About the font information files for Actuate iServer . . . . . . . . . . . . . . . . . . . . .69
Controlling how Actuate iServer searches for font information . . . . . . . . . . . . . . .70
About the archive driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Installing the example archive driver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Understanding the example archive driver . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Understanding Actuate iServer CPU binding . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Binding an Actuate iServer to processors on a Windows machine . . . . . . . . . . . . . . .73
Binding an Actuate process to a processor . . . . . . . . . . . . . . . . . . . . . . . . . . .73
About processors and hyperthreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
Binding Actuate iServer to processors on a Sun Solaris machine . . . . . . . . . . . . . . . .75
Binding Actuate iServer to processors on an HP-UX 11i machine. . . . . . . . . . . . . . . .75

iii
 Checking Actuate iServer bound processors . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Determining the number of processors an Actuate iServer System uses . . . . . . . . . 76
Understanding how Actuate iServer validates CPU binding while running . . . . . . . 77
Understanding how Actuate iServer validates CPU binding when taking an
Encyclopedia volume online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Understanding how Actuate iServer validates CPU binding when running
Factory and View processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Configuring e-mail for CPU license problems . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Chapter 3
Understanding Actuate iServer System performance . . . . . . . . . 79
About Actuate iServer performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Optimizing viewing for Actuate DHTML reports . . . . . . . . . . . . . . . . . . . . . . . . . 80
Caching DHTML report pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Caching temporary reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Searching a DHTML report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Creating a PDF file for download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Compressing a DHTML report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Understanding how bundling affects performance . . . . . . . . . . . . . . . . . . . . . . . 82
Optimizing Encyclopedia volume performance . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Restructuring the Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Managing report notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Moving the Encyclopedia volume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Managing space for the Encyclopedia volume. . . . . . . . . . . . . . . . . . . . . . . . . . 87
Understanding the effects of disk I/O speed . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Understanding how file system I/O affects Encyclopedia volume performance . . . . . 87
Configuring an Encyclopedia volume to work in a SAN . . . . . . . . . . . . . . . . . . 89
Improving disk I/O speed to improve Encyclopedia volume performance . . . . . . . . . 89
Running the Veritas file system on an HP-UX system . . . . . . . . . . . . . . . . . . . . . 90
Optimizing the performance of an Actuate iServer machine . . . . . . . . . . . . . . . . . . . 90
Understanding CPU resource requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
About report generation performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Sharing a CPU with a database server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Adding Factory processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Adding CPUs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Adjusting operation process timing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Adjusting TCP/IP socket usage on a Microsoft Windows system. . . . . . . . . . . . . . . 93
Estimating CPU resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Understanding memory resource requirements . . . . . . . . . . . . . . . . . . . . . . . . . 94
Understanding paging resource requirements . . . . . . . . . . . . . . . . . . . . . . . . 94
Understanding buffer pool resource requirements. . . . . . . . . . . . . . . . . . . . . . 94
Understanding Factory process recycling . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
About Actuate iServer resource groups and performance . . . . . . . . . . . . . . . . . . . 96

iv
 Understanding how operations and administrative commands affect performance . . . . .96
Running service aids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
Managing administrative information . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
Specifying privileges for report files and folders. . . . . . . . . . . . . . . . . . . . . . . .97
Optimizing View process performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
Understanding the architecture of the View process . . . . . . . . . . . . . . . . . . . . . . .97
About how the View process works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
Understanding the converter framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Setting up the View process component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Understanding View process performance features . . . . . . . . . . . . . . . . . . . . . . .99
About how Actuate iServer balances the View process workload . . . . . . . . . . . . . . 100
About how the View process minimizes communication with Actuate iServer . . . . . . . 100
Controlling cache resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Chapter 4
Configuring Actuate iServer security . . . . . . . . . . . . . . . . . . . . . 103
About the Report Server Security Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
About open security functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
About page-level security functionality for Actuate Basic reports . . . . . . . . . . . . . . 105
Working with the Actuate iServer security applications. . . . . . . . . . . . . . . . . . . . . . 105
Working with the RSSE open security application that uses LDAP . . . . . . . . . . . . . . 105
About the Actuate RSSE open security application . . . . . . . . . . . . . . . . . . . . . 106
Changing the type of Encyclopedia volume security . . . . . . . . . . . . . . . . . . . . 107
Understanding how Actuate iServer System caches external security information . . . 107
Installing the Actuate RSSE web service application . . . . . . . . . . . . . . . . . . . . . . 108
About open security LDAP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Mapping Encyclopedia volume administration information . . . . . . . . . . . . . . . . . 110
Mapping Encyclopedia volume user properties . . . . . . . . . . . . . . . . . . . . . . . 110
Mapping Actuate roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Mapping Actuate groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Mapping Actuate channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Understanding ldapconfig_<volume>.xml parameters . . . . . . . . . . . . . . . . . . . . 112
Setting ldapconfig_<volume>.xml parameters . . . . . . . . . . . . . . . . . . . . . . . . . 121
Resolving LDAP time-out and performance issues . . . . . . . . . . . . . . . . . . . . . . . 122
Using the LDAP Directory Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Importing and exporting data with open security and the sample Actuate
RSSE application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
About the Actuate iServer open utilities and the sample RSSE application . . . . . . . . . 124
Using the Actuate iServer open security utilities with the sample RSSE application . . . . 124
Converting internal IDs to external names using the Actuate open security
application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Converting an Encyclopedia volume from using external information to using
internal information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

v
 About the parameters for ldap.conf and the parameters for the RSSE library
application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Part 3
Administering Actuate iServer services
Chapter 5
Actuate iServer System administration overview. . . . . . . . . . . . 131
About Actuate iServer System administration . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
About Actuate iServer System administration tasks . . . . . . . . . . . . . . . . . . . . . . 132
About Actuate iServer System cluster administration tasks . . . . . . . . . . . . . . . . . . 133
About general Actuate iServer administration tasks . . . . . . . . . . . . . . . . . . . . . . . . 133
Understanding Actuate iServer ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
About stand-alone Actuate iServer setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
About Encyclopedia volume directory structure . . . . . . . . . . . . . . . . . . . . . . . . 136
About Encyclopedia volume metadata directories . . . . . . . . . . . . . . . . . . . . . . 136
About the Encyclopedia volume file directory . . . . . . . . . . . . . . . . . . . . . . . . 137
About the Encyclopedia volume log directory . . . . . . . . . . . . . . . . . . . . . . . . 137
About the Actuate iServer System configuration file . . . . . . . . . . . . . . . . . . . . . . 137
About the stand-alone Actuate iServer configuration file . . . . . . . . . . . . . . . . . . 138
About the Actuate iServer cluster configuration file . . . . . . . . . . . . . . . . . . . . . 138
Setting locales and time zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Monitoring Actuate iServer System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Logging in to Actuate iServer System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Logging in to the System Administration console. . . . . . . . . . . . . . . . . . . . . . . . 141
Specifying the cluster master during cluster startup . . . . . . . . . . . . . . . . . . . . . . 141
About the System Administration console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Modifying the System Administration console display settings . . . . . . . . . . . . . . . . . 143
Changing locale and time zone settings for Actuate iServer System . . . . . . . . . . . . . 144
Changing the list of Actuate iServer System nodes . . . . . . . . . . . . . . . . . . . . . . . 145
Changing the list of Encyclopedia volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Changing the list of Actuate iServer System partitions . . . . . . . . . . . . . . . . . . . . . 149
Changing the list of Actuate iServer System printers . . . . . . . . . . . . . . . . . . . . . . 151
Viewing Actuate Management Console and Actuate iServer System release
information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Understanding Actuate iServer status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Working with online Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Working with offline Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Changing advanced Actuate iServer System settings . . . . . . . . . . . . . . . . . . . . . . . 156
About groups of advanced server properties . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Adding or removing a property value for a list of values . . . . . . . . . . . . . . . . . . . 158

vi
 Adding or removing a set of values for an entry . . . . . . . . . . . . . . . . . . . . . . . . 158
Restarting after changing Actuate iServer settings . . . . . . . . . . . . . . . . . . . . . . . 160
Setting up and administering an Actuate iServer System cluster. . . . . . . . . . . . . . . . . 160
About creating an Actuate iServer System cluster . . . . . . . . . . . . . . . . . . . . . . . 161
Creating a cluster from stand-alone Actuate iServer . . . . . . . . . . . . . . . . . . . . . . 162
Adding and configuring an Actuate iServer node . . . . . . . . . . . . . . . . . . . . . . . 164
Preparing Actuate iServer to join a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Adding a new Actuate iServer node to a cluster . . . . . . . . . . . . . . . . . . . . . . . 164
About Actuate iServer node configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Starting or stopping an Actuate iServer node . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Removing a node from an Actuate iServer cluster . . . . . . . . . . . . . . . . . . . . . . . 171
Understanding file system failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
About Actuate iServer System file system failover . . . . . . . . . . . . . . . . . . . . . . . 172
Determining when an Actuate iServer file system I/O failure occurs . . . . . . . . . . . 173
About failover due to a failure to read the configuration file . . . . . . . . . . . . . . . . 173
About failover due to Encyclopedia volume read or write failure . . . . . . . . . . . . . 174
About Actuate iServer node failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
About Actuate iServer node autostart and failover . . . . . . . . . . . . . . . . . . . . . . . 174
Managing an Actuate iServer cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
About cluster networking requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
About Actuate iServer cluster option requirements . . . . . . . . . . . . . . . . . . . . . . 176
Changing start-up parameters for Actuate iServer. . . . . . . . . . . . . . . . . . . . . . . . . 177
Understanding Actuate iServer System online archive functionality . . . . . . . . . . . . . . 179
About the online archive application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
About the online archive application files . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Retaining file attributes during archiving. . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Preserving file dependencies during archiving . . . . . . . . . . . . . . . . . . . . . . . 182
Using the online archive application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Working with the Actuate iServer online archive application configuration file . . . . . 183
Consolidating Actuate iServer usage and error log data . . . . . . . . . . . . . . . . . . . . . 186
Setting up the consolidator application . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Configuring the target database for the consolidator application . . . . . . . . . . . . . 189
Configuring the consolidator application. . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Using the UNIX startup and shutdown scripts for the log consolidator
application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Using the Windows startup and shutdown utility for the log consolidator
application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Working with information objects and caching. . . . . . . . . . . . . . . . . . . . . . . . . . . 193
About the Actuate Integration service (AIS) and the Actuate Caching service (ACS) . . . 193
About information object file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
About database configuration for information object and Record Matcher caching . . . . 197
Understanding Actuate Record Matcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

vii
 About Record Matcher Framework installation and configuration . . . . . . . . . . . . 200
About Record Matcher applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Understanding the structure of the Record Matcher cache . . . . . . . . . . . . . . . . . 202
Understanding Record Matcher application limitations. . . . . . . . . . . . . . . . . . . 204

Chapter 6
Working with
system-wide Actuate iServer parameters . . . . . . . . . . . . . . . . . 205
About parameters for an Actuate iServer node or stand-alone machine . . . . . . . . . . . . . 206
Modifying general Actuate iServer parameter values . . . . . . . . . . . . . . . . . . . . . . . 206
Setting up cluster master failover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
About Actuate iServer cluster master failover . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Specifying a backup cluster master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Working with Actuate iServer System usage and error logging . . . . . . . . . . . . . . . . . 212
Configuring and using system usage logging . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Enabling system usage logging for Actuate iServer . . . . . . . . . . . . . . . . . . . . . 214
Understanding the system usage log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Configuring and using error logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Enabling error logging for Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Understanding the Actuate iServer error log . . . . . . . . . . . . . . . . . . . . . . . . . 233
Managing Actuate iServer e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Setting up Actuate iServer System to use an SMTP server for e-mail notification . . . . . . 238
Adding an SMTP e-mail server for Actuate iServer System . . . . . . . . . . . . . . . . . . 240
Limiting the number of e-mail recipients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Balancing the e-mail notice load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
About SMTP load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
About MAPI and sendmail load balancing . . . . . . . . . . . . . . . . . . . . . . . . . . 243
About errors when sending e-mail using SMTP . . . . . . . . . . . . . . . . . . . . . . . . . 243
About errors that cause Actuate iServer to resend e-mail messages . . . . . . . . . . . . 244
About errors that do not cause Actuate iServer to resend e-mail messages . . . . . . . . 244
About e-mail notification error logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Configuring default regional settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Working with Actuate iServer System license information . . . . . . . . . . . . . . . . . . . . 246
Specifying advanced Actuate iServer System parameter values . . . . . . . . . . . . . . . . . 248
Setting advanced usage and error logging property values . . . . . . . . . . . . . . . . . . 249
Setting advanced printing property values . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Setting advanced cluster operation property values . . . . . . . . . . . . . . . . . . . . . . 253
Setting advanced information display property values. . . . . . . . . . . . . . . . . . . . . 254
Setting advanced notification property values. . . . . . . . . . . . . . . . . . . . . . . . . . 254

viii
Chapter 7
Working with an Actuate iServer System server . . . . . . . . . . . . 257
Working with the list of servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
About server parameters for Actuate iServer System . . . . . . . . . . . . . . . . . . . . . . . 259
Setting general Actuate iServer parameter values for an Actuate iServer machine . . . . . . 260
Setting Message Distribution service parameter values . . . . . . . . . . . . . . . . . . . . . . 263
Setting View service parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Specifying Factory service parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Specifying Caching service parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Specifying Integration service parameter values . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Setting server parameter values for an Actuate iServer System resource group . . . . . . . . 273
Specifying the buffer pool size for an Encyclopedia volume . . . . . . . . . . . . . . . . . . . 276
Assigning backup responsibility for an Encyclopedia volume to an Actuate iServer node . . 278
Designating partition space for Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Specifying parameter values for an Actuate iServer System printer . . . . . . . . . . . . . . 281
Working with advanced Actuate iServer parameter values . . . . . . . . . . . . . . . . . . . . 283
Configuring and using diagnostic logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Changing advanced Actuate iServer parameter values . . . . . . . . . . . . . . . . . . . . 287
Setting Factory service property values for Actuate iServer . . . . . . . . . . . . . . . . . . 288
Specifying the directory to use for Excel output . . . . . . . . . . . . . . . . . . . . . . . 288
Specifying the size and location of an image that appears on an Actuate Query
output page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Specifying asynchronous job retry settings . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Setting the log level for SAP native connector . . . . . . . . . . . . . . . . . . . . . . . . 290
Specifying ports for Factory service communication . . . . . . . . . . . . . . . . . . . . 291
Specifying transient report generation settings . . . . . . . . . . . . . . . . . . . . . . . 294
Setting View service property values for Actuate iServer . . . . . . . . . . . . . . . . . . . 294
Specifying caching property values for Actuate iServer . . . . . . . . . . . . . . . . . . 294
Specifying DHTML output viewing and generation settings. . . . . . . . . . . . . . . . 298
Specifying e.Analysis display settings for Actuate iServer . . . . . . . . . . . . . . . . . 300
Specifying Excel generation settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Specifying PDF generation settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Specifying process communication settings . . . . . . . . . . . . . . . . . . . . . . . . . 311
Specifying performance-specific process management setting . . . . . . . . . . . . . . . 312
Specifying search result display settings for Actuate iServer . . . . . . . . . . . . . . . . 312
Setting Caching service property values for Actuate iServer . . . . . . . . . . . . . . . . . 313
Working with NetOSI file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Adding a NetOSI file type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Viewing and modifying NetOSI file type settings . . . . . . . . . . . . . . . . . . . . . . 316
Working with filetype drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Adding a filetype driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Viewing and modifying filetype driver settings . . . . . . . . . . . . . . . . . . . . . . . 318

ix
 Setting chart server property values for Actuate iServer . . . . . . . . . . . . . . . . . . . . 319
Specifying runtime settings for Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . . 320
Setting date property values for Actuate iServer . . . . . . . . . . . . . . . . . . . . . . . . 322
Specifying the Java Object Interface property values for Actuate iServer . . . . . . . . . . 322
Specifying Requester API property values for Actuate iServer . . . . . . . . . . . . . . . . 323
Specifying RSAPI process communication parameters for Actuate iServer . . . . . . . . . 323
Changing the cluster master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Chapter 8
Working with an Actuate iServer System partition. . . . . . . . . . . 329
Configuring an Actuate iServer System partition. . . . . . . . . . . . . . . . . . . . . . . . . . 330
Adding a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Specifying the path to an Actuate iServer System partition . . . . . . . . . . . . . . . . . . . . 333
Removing an Actuate iServer System partition . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Chapter 9
Working with an Actuate iServer System volume. . . . . . . . . . . . 337
About Encyclopedia volume tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
About the default RSAPI setup for Actuate iServer in a stand-alone configuration . . . . . . 339
Adding and configuring an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . 339
Taking an Encyclopedia volume online or putting an Encyclopedia volume offline . . . . . . 345
Modifying Actuate iServer parameter values for an Encyclopedia volume . . . . . . . . . . . 346
Changing which Actuate iServer machine owns an Encyclopedia volume . . . . . . . . . . . 351
Failing over an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
About Encyclopedia volume failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Assigning a backup server to an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . 354
Performing an administrative failover of an Encyclopedia volume . . . . . . . . . . . . . 356
Working with Actuate Open Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Assigning a partition to an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . 362
Working with advanced Encyclopedia volume parameters . . . . . . . . . . . . . . . . . . . . 363
Setting expiration times for Encyclopedia volume items . . . . . . . . . . . . . . . . . . . . 365
Specifying the server URL parameter value for e-mail notices . . . . . . . . . . . . . . . . 366
Specifying RSSE service startup and failover . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Specifying how many items an RSAPI request returns . . . . . . . . . . . . . . . . . . . . . 368
Retrying failed asynchronous jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Specifying the default Actuate Query template file . . . . . . . . . . . . . . . . . . . . . . . 370
Restoring an Encyclopedia volume snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Moving an Encyclopedia volume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Removing an Encyclopedia volume from Actuate iServer System . . . . . . . . . . . . . . . . 374

x
Chapter 10
Adding and configuring an Actuate iServer System
resource group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
About resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
About the types of resource groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
About asynchronous resource groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
About synchronous resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
About the default resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
About resource groups and IDAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
About Actuate iServer failover when using a resource group . . . . . . . . . . . . . . . . . 381
About upgrading Actuate iServer and resource groups . . . . . . . . . . . . . . . . . . . . 382
Migrating from Actuate iServer System Release 6 or Release 7 . . . . . . . . . . . . . . 382
Migrating from process groups to resource groups . . . . . . . . . . . . . . . . . . . . . 382
Using the resource group list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Adding a resource group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
Viewing or modifying general resource group parameters . . . . . . . . . . . . . . . . . . . . 386
Viewing or modifying resource group server assignments . . . . . . . . . . . . . . . . . . . . 388
Stopping a resource group from running jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

Chapter 11
Adding and configuring an Actuate iServer System
printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Working with the printer list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Adding a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Viewing or modifying printer properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Removing a printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

Chapter 12
Working with database connections . . . . . . . . . . . . . . . . . . . . . . 399
About database connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
About stored procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Defining an environment variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Connecting to a DB2 database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Defining DB2 environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Using DB2 libraries on SunOS and HP-UX . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
About Actuate support for XML Extender. . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Checking a connection to a DB2 instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Connecting to an Informix database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Defining Informix environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Specifying the Informix database environment . . . . . . . . . . . . . . . . . . . . . . . . . 407
Supplying Informix account information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

xi
 Using UNIX Factory server software with Informix . . . . . . . . . . . . . . . . . . . . . . 407
Accessing Informix libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Overriding Informix DLLPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Determining Informix version on a server running Windows . . . . . . . . . . . . . . . 408
Setting the maximum column length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Connecting to a MS/SQL database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Specifying the MS/SQL database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Retrieving data in code pages and in Unicode . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Supplying MS/SQL account information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Accessing MS/SQL libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Accessing data from a database using Microsoft Analytics Services . . . . . . . . . . . . . 410
Testing the MS/SQL connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
About driver versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Understanding Db-library limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Connecting to a database through ODBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Setting the maximum column length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Understanding language encoding considerations . . . . . . . . . . . . . . . . . . . . . . . 413
Using the PeopleSoft ODBC driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Using Red Brick ODBC drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Setting up a Microsoft Windows Red Brick configuration . . . . . . . . . . . . . . . . . 415
Setting up a UNIX Red Brick configuration. . . . . . . . . . . . . . . . . . . . . . . . . . 415
Checking the connection to Red Brick databases . . . . . . . . . . . . . . . . . . . . . . . 416
Accessing an ODBC data source on UNIX when using Actuate Analytics . . . . . . . . . . 416
Connecting to an Oracle database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
About Actuate support for Oracle 9i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
About Actuate support for Oracle 8i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Using Actuate iServer and Oracle clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
About Oracle connection strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Working with SQL*Net version 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Working with SQL*Net version 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Defining Oracle environment variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
About the Oracle listener processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Testing the Oracle connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
About Oracle 8 data type support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Setting the maximum column length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Connecting to a Progress 9.1 database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
About Actuate support for Progress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Installing Progress software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Defining Windows environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
About Actuate connection properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Working with a Progress 9.1 SQL92 connection . . . . . . . . . . . . . . . . . . . . . . . . . 424
Using stored procedures and triggers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Using the AcProgressConnection connection . . . . . . . . . . . . . . . . . . . . . . . . . . 425

xii
 Setting up the UNIX environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
About SunOS setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
About HP-UX setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
About AIX setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Connecting to an SAP data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
About required SAP JCO libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Configuring Actuate iServer to use SAP JCO files . . . . . . . . . . . . . . . . . . . . . . 428
About updating SAP JCO software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
About SAP R/3 required libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Connecting to a Sybase database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Understanding Actuate Sybase ASE 12 support . . . . . . . . . . . . . . . . . . . . . . . . 430
Using Sybase 12.5 with an Actuate report . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Defining Sybase environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Supplying Sybase database server information . . . . . . . . . . . . . . . . . . . . . . . . . 432
Supplying Sybase account information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Testing the Sybase connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Using an Open Data Access driver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Installing an Open Data Access driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
About using an Open Data Access driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
About UNIX factsrvr database compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

Chapter 13
Working with Actuate iServer utilities . . . . . . . . . . . . . . . . . . . . . 437
Using acacfconvert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Using acexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Exporting files and folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Exporting volume administration information . . . . . . . . . . . . . . . . . . . . . . . . . 441
Exporting users, security roles, and groups . . . . . . . . . . . . . . . . . . . . . . . . . 441
Exporting channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Exporting jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
About the exported volume directories and files . . . . . . . . . . . . . . . . . . . . . . . . 442
Copying the export directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
About acexport options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Using acextern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Using acimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Importing volume information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Importing users, security roles, and groups . . . . . . . . . . . . . . . . . . . . . . . . . 449
Importing directories, files, and file versions. . . . . . . . . . . . . . . . . . . . . . . . . 449
Importing channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Importing printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Importing jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
About acimport options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

xiii
Using acintern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Using acmode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Using actoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Using acupgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Using acverify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
About the UNIX PostScript font utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Installing a PostScript font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Uninstalling a PostScript font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Understanding PostScript font conversion issues . . . . . . . . . . . . . . . . . . . . . . . . 467

Chapter 14
Setting Actuate iServer parameters . . . . . . . . . . . . . . . . . . . . . . . 469
About Actuate iServer parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Actuate iServer System parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Usage and Error Logging parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Integration Service parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
Caching Service parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
iServer node parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Encyclopedia volume parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
Volume partition configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Viewing Service parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Reporting Service parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
SOAP Dispatch Service parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Server-specific Partition configuration parameters . . . . . . . . . . . . . . . . . . . . . . . 540
A Printer used by this Server parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Open server file type parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Open server file type driver parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Resource Group parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
SMTP Server parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
About registry keys and environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Setting registry keys on Microsoft Windows server operating systems . . . . . . . . . . . . 547
Setting environment variables on UNIX systems . . . . . . . . . . . . . . . . . . . . . . . . 548
About environment variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549

Part 4
Administering an Encyclopedia volume
Chapter 15
Understanding Encyclopedia volume administration . . . . . . . . 553
Encyclopedia volume administration overview . . . . . . . . . . . . . . . . . . . . . . . . . . 554

xiv
Connecting to an Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
About the Volume Administration console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Understanding the banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Using the side menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Setting display options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
About required fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Searching for data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Searching for strings that contain special characters . . . . . . . . . . . . . . . . . . . . . . 561
Searching for Encyclopedia volume data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Filtering Encyclopedia volume data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Setting properties for more than one item at a time . . . . . . . . . . . . . . . . . . . . . . . . 566
About the Administrator and the Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
About pages available to all users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
About pages available to administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Setting Encyclopedia volume limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570

Chapter 16
Managing Encyclopedia volume security . . . . . . . . . . . . . . . . . . 573
About Encyclopedia volume security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
About user accounts and passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Working with privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Planning how to assign privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
About root folder privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
About home folder privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Using the trusted execute privilege for information objects and data source maps . . . 580
Working with roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Strategies for defining security roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Defining security roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
About the Administrator user and security role . . . . . . . . . . . . . . . . . . . . . . . 586
About the Operator security role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
About the All security role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
About Actuate Active Portal roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Working with privilege templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
About file and folder access types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
About RSSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Managing users, privileges, and security roles . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
About page-level security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Viewing reports with page-level security . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Using the Report Server Security Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Enabling report page-level security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
About Actuate Open Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
About external user authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618

xv
 About external user properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
About external user registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
About externally defined Actuate security roles . . . . . . . . . . . . . . . . . . . . . . . 620
About the All security role and external registration . . . . . . . . . . . . . . . . . . . . 620
About the anonymous user and external registration . . . . . . . . . . . . . . . . . . . . 621
About the Administrator security role and external registration . . . . . . . . . . . . . . 621
About the administrator user and external registration . . . . . . . . . . . . . . . . . . . 621
About the Operator security role and external authentication . . . . . . . . . . . . . . . 622
About channels and external authentication . . . . . . . . . . . . . . . . . . . . . . . . . 622
Using the Volume Administration console with open security . . . . . . . . . . . . . . . . . . 622
Log in with open security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
About home folder privileges with externally defined users . . . . . . . . . . . . . . . . . 623
About printer properties for externally defined users . . . . . . . . . . . . . . . . . . . . . 623
About external properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
About the wildcard character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
About information object pass-through security . . . . . . . . . . . . . . . . . . . . . . . . . . 624

Chapter 17
Administering channels and notification groups . . . . . . . . . . . . 627
About channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Viewing channels and their contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Creating and maintaining channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Scheduling jobs for channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Creating notification groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638

Chapter 18
Managing printers and print jobs . . . . . . . . . . . . . . . . . . . . . . . . . 645
About Actuate iServer System printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
About printer properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Setting up printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Managing print jobs as an administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648

Chapter 19
Administering jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Understanding job administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
About scheduled jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
About job priorities and resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
About users’ job priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Administering open server jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Setting a maximum job priority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Setting the default job retry policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655

xvi
Setting the Encyclopedia volume’s default job retry policy . . . . . . . . . . . . . . . . . . . . 655
Running scheduled jobs after a system restart . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
Converting output from an Actuate Basic report to other formats . . . . . . . . . . . . . . . . 656
Understanding the conversion process for Actuate Basic output . . . . . . . . . . . . . . . 657
Working with an Actuate Caching service (ACS) cache . . . . . . . . . . . . . . . . . . . . . . 658
Configuring an Encyclopedia volume to use an Actuate Caching service (ACS) database 658
Configuring an Actuate Caching service (ACS) database . . . . . . . . . . . . . . . . . . . 661
About DBMS platforms for Actuate Caching service (ACS) databases . . . . . . . . . . . . 661
About database connections for Actuate Integration service (AIS) . . . . . . . . . . . . . . 661
Working with an information object cache. . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
About information object cache creation and configuration . . . . . . . . . . . . . . . . 662
Creating and configuring an information object cache . . . . . . . . . . . . . . . . . . . 663
Enabling an information object cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Replicating an information object cache . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Deleting an information object cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Working with a Record Matcher definition file . . . . . . . . . . . . . . . . . . . . . . . . . 667
Creating a Record Matcher definition file. . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Viewing the configuration of a Record Matcher definition file . . . . . . . . . . . . . . . 668
Running a Record Matcher definition job. . . . . . . . . . . . . . . . . . . . . . . . . . . 669
Running or updating an Actuate Caching service (ACS) cache . . . . . . . . . . . . . . . . 669
Reviewing cache update information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671

Chapter 20
Archiving files and backing up an Encyclopedia volume . . . . . 673
Archiving files and removing empty folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Understanding archiving with autoarchive . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Setting the Encyclopedia volume’s autoarchive rules . . . . . . . . . . . . . . . . . . . . . 677
Configuring autoarchiving and purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
Scheduling an aging cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Stopping an archive cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Backing up the Encyclopedia volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Setting online backup mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
Scheduling online backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685

Chapter 21
Understanding Actuate iServer options . . . . . . . . . . . . . . . . . . . 687
About Actuate open server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Using open server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
About predefined open server file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Specifying open server file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Understanding the File Types page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
Defining an open server file type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692

xvii
 Using the web server file system for viewing open server files . . . . . . . . . . . . . . . . 698
About open server for SQRIBE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Setting the SQRIBE report printing parameter . . . . . . . . . . . . . . . . . . . . . . . . 699
Using the parameter for bursting web output . . . . . . . . . . . . . . . . . . . . . . . . 699
Working with report-level parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
About the open server for Crystal reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
Using Crystal reports with an .rpt file extension . . . . . . . . . . . . . . . . . . . . . . . 700
Specifying a mutual exclusion class for Crystal reports . . . . . . . . . . . . . . . . . . . 701
Setting parameters for Crystal reports executable files . . . . . . . . . . . . . . . . . . . 701
Using Crystal web reports with an .rpw file extension . . . . . . . . . . . . . . . . . . . 701
Printing a Crystal report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
Administering Actuate Basic reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
Configuring report viewing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
Setting web browser page caching options. . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
Working with Actuate Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
About the Actuate information object ODA driver . . . . . . . . . . . . . . . . . . . . . . . 704
About the Actuate Query template file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Actuate query template report design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Using a customized Actuate Query template . . . . . . . . . . . . . . . . . . . . . . . . . 705
Administering Actuate Analytics files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
About Actuate Analytics file types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
About Actuate Analytics data source support . . . . . . . . . . . . . . . . . . . . . . . . . . 706
Accessing a Microsoft Analysis Services data cube . . . . . . . . . . . . . . . . . . . . . . . 707
About Microsoft Analytic Services parameters . . . . . . . . . . . . . . . . . . . . . . . . . 709
Administering spreadsheet reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Understanding how Actuate iServer System handles spreadsheet files . . . . . . . . . . . 710
Setting parameters for spreadsheet reports . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Administering Formula One reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
About Formula One report data source connection requirements . . . . . . . . . . . . . . 716
Using parameters with Formula One reports . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Locating fonts with ACJFontLocator.properties . . . . . . . . . . . . . . . . . . . . . . . . . 719
Specifying a port number to run a Formula One e.Report . . . . . . . . . . . . . . . . . . . 720

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721

xviii
 Introduction

Exploring Actuate 8
Actuate® Corporation is the world leader in providing enterprise reporting
application development platforms for Global 9000 companies. Actuate offers
a full suite of content-development tools that pull divergent types of data from
multiple sources and bring that data together in presentation-quality reports.
Applications built on Actuate technology ensure that 100% of corporate users
incorporate standard, accurate decision-making information into their day-by-
day activities.
The Actuate product suite provides:
■ A flexible and advanced reporting model
■ A robust security model
■ Best-of-breed server scalability
■ A leading analytics solution for decision support
■ Automated production reporting for multiple output formats
■ Unparalleled support for multilingual reporting
■ Highly customizable look and feel
■ The ability to leverage existing data warehouses and operational data
sources
■ Simplified access to complex data sources
Actuate’s scalable Business Intelligence solutions support working with a
large volume of transactional data and a challenging data model. Actuate’s
increasingly powerful design products reduce the overall cost of report
development. Actuate iServer and its options provide scalable performance, a
robust integration model using APIs, a web-capable enterprise server
application, and a broad range of output options.

Introduction xix
 In the current business climate, our enterprise customers need to meet the
demand for increasingly complex and customized information. Using the
capabilities of our sophisticated security model, users in different parts of an
organization can access different parts of the same report. The ability to
develop fewer, more powerful reports that meet the needs of many levels and
types of users addresses the workload challenges facing IT organizations.
Streamlining the reporting process reconciles reduced staffing and the ever-
present backlog of IT requests with the complex reporting needs of diverse
users within an enterprise. With Actuate products, such as Actuate
e.Spreadsheet Designer, Actuate Analytics Cube Designer, and Actuate
Analytics Cube Viewer, a business user can leverage information that the IT
staff develops to meet his additional, and perhaps unique, needs.
Actuate technology ensures that 100% of users have business agility: access to
the right information in the right form to take the right action. Today’s
information manager needs increased visibility into what business users are
doing because of internal requirements for greater accountability. For example,
new SEC regulations add to the demand on the corporate information
management infrastructure. Actuate customers also need tools that ensure that
IT organizations maintain the appropriate level of control over corporate
information assets. To meet these requirements, Actuate’s information
application platform includes three key elements:
■ An information server
■ An information application development environment
■ User empowerment tools

Addressing diverse customer profiles

Actuate’s customer list continues to include leaders in aerospace, commercial
banking, defense, entertainment, federal government, financial services,
health care, high technology, insurance, life sciences, pharmaceuticals, retail,
securities, and telecommunications.
Infrastructure software from Actuate provides the foundation for applications
that support budget variance, business analysis, customer relationship
management, customized interactive reporting, e.billing, e.procurement,
executive dashboards, human resources, information portals, key performance
indicators, service automation, spreadsheet reporting, supply-chain
management, and systems management. In the e.business environment,
Actuate’s structured content technology seamlessly integrates into corporate
web sites and packaged applications.

xx Administering Actuate iSer ver System

Addressing customer requirements
Capturing, validating, refreshing, and delivering corporate information
remain critical customer requirements. Customers need an information
application that takes corporate data and delivers it as interactive web pages,
data cubes, and Excel spreadsheets that their customers, partners, and
employees can use.
Actuate customers need to:
■ Combine data from multiple data sources associated with multiple
transaction applications.
■ Have confidence in the consistency and maintainability of the Excel
spreadsheets on their business users’ desktops and their customers’ web
pages.
■ Readily access current information over the web without overloading
internal networks.
■ Use data cubes to perform multidimensional analysis.
■ Achieve high performance and high scalability with enterprise reporting
applications.

Supporting international information delivery

requirements
To meet the growing international needs of our customer base, Actuate
products continue to provide an unprecedented level of support for
multilingual reporting, including full Unicode support and an extensive list of
supported locales. Some Actuate customers integrate Actuate reporting in
their own applications and provide information to thousands of customers,
amounting to millions of users in as many as fifty countries. Some Actuate
customers also deliver hundreds of reports translated into eighteen or more
languages.

Providing a scalable, high-performance server

Independent analysis confirms that Actuate iServer is 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.

Introduction xxi
 Providing a complete information delivery
solution
The following table summarizes the three types of e.business applications for
which Actuate provides seamless integration through its reporting application
platform.

Infrastructure element Function Actuate role

Databases, data Organize data Actuate’s design tools support
warehouses, and accessing, managing, and
operational data presenting formatted data.
sources
Content management Manage Actuate iServer supports
systems structured publishing, distributing, and
content versioning structured content.
Application servers Deploy online Actuate web applications,
applications including Actuate Active Portal
and Management Console,
support conducting complex
transactions, managing supply
chains, and interacting with
customers.

Actuate products continue to offer core solutions for fundamental enterprise

reporting and information delivery challenges, as described in the following
table.

Challenge Actuate solution

Deliver high- Solve complex data access and presentation
resolution information problems across a broad range of data sources
View structured Support viewing cubes, DHTML, information
content objects, and spreadsheet reports in standard
browsers to eliminate plug-in installation for
millions of users
Meet varied Provide:
information display ■ Template-based design and display
requirements
■ Complex formatting capabilities
■ Spreadsheet reporting
■ Multidimensional cubes
Meet increasing ■ Support well over one million hits each day on
requirements for web- a single CPU
based content delivery ■ Reduce development and maintenance costs

xxii Administering Actuate iServer System

 Challenge Actuate solution
Deliver personalized, Provide open security directory integration and
secure information page-level security
Reuse existing Provide access to content from other applications
integrated content using open server technology
Maintain data integrity Provide high-resolution printed copy from
between online and PostScript and PDF files
hard copy
Transfer information Provide XML output to support access to data
among applications across applications
Meet increasing Support clustering and fail-over
requirements for
server-based reporting

Introducing the Actuate 8 and ReportingEngines

product suites
The following section describes the broad suite of tools developed by Actuate
Corporation to meet the needs of users throughout an enterprise.

Actuate Analytics Cube Designer

An application that content developers use to define and design the structure
of a multi-dimensional, On-Line Analytical Processing (OLAP) cube. Running
a cube profile using Actuate iServer generates a cube.

Actuate Analytics Cube Viewer

An application that supports end users who need to create and view cube
reports.

Actuate End User Desktop

An application that supports end users who need 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 who need to design and distribute a wide variety of reports.
Using this application requires no programming skills. A business user can

Introduction xxiii
 modify complex reports created by an IT developer and use sophisticated
components from libraries.

Actuate e.Report Designer Professional

An object-oriented application that professional developers of structured
content use to design, build, and distribute information objects and report
object instances. The Actuate Basic Language and Actuate Foundation Class
Library support extensive customization capabilities.
Actuate Client Integration Technology extends the capabilities of Actuate
e.Report Designer Professional and includes the following products:
■ Actuate ActiveX Controls embed Actuate reporting functionality in custom
applications.
■ 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 printing.
Users access the Requester API using Actuate Basic, Visual Basic, C, or
C++.
■ Actuate Search Extension API supports developing search extensions to
transfer data to any third-party productivity or analysis tool.
■ Actuate Open Data Access Framework supports development of custom
data source drivers.

Actuate e.Spreadsheet Designer

An application that supports end users who design, create, and distribute
automated spreadsheet reports over the web. Users can dynamically generate
richly formatted spreadsheet reports in Excel format from Actuate iServer
System with the e.Spreadsheet Option. The spreadsheet reports can be part of
an application, an applet, or a JavaBean.

Actuate iServer System

A server application that generates cubes, information objects, report
documents, and spreadsheet reports. Actuate iServer provides single or
multiple Encyclopedia™ volumes in which it makes many different types of
content available to users. Actuate iServer supports managing a cluster of
multiple Actuate iServer machines. Actuate iServer System includes the
following products:
■ Actuate Active Portal for JSP, Actuate Active Portal for .NET, and Actuate
ReportCast™ transform the Encyclopedia volume into a dynamic, secure
web site. They provide the foundation for channels and seamless
integration with other web sites.

xxiv Administering Actuate iSer ver System

■ Actuate Management Console is an application that system and network
administrators use to manage and control one or more Actuate
Encyclopedia volumes.
■ Actuate iServer Integration Technology includes the following features:
■ Actuate Information Delivery API integrates Actuate web services into
existing corporate applications, automates routine or time-consuming
Actuate iServer integration tasks, and implements new feature
groupings for custom business processes. The Actuate Information
Delivery API is based on XML and supports simple object access
protocol (SOAP) messaging.
■ Actuate Report Server Security Extension supports the use of third-
party security tools.
■ The Actuate archive driver supports the use of third-party archiving
software and hardware.
■ Actuate Report Server API implements common Encyclopedia volume
functionality using C++.
In addition to the underlying server technology, Actuate 8 supports several
Actuate iServer System options. These options are licensed separately.
■ Actuate Additional Volume Option
An option that supports using more than one Encyclopedia volume in
Actuate iServer System. In Actuate 7 and earlier, this option was Actuate
Multi-Application Option.
■ Actuate Analytics Option
An application that supports analysis of multidimensional data cubes. A
developer creates the cubes using Actuate Analytics Cube Designer.
■ Actuate Data Connector Option
An option that supports running or viewing Actuate content sources from
a specific type of data source. Each data connector must be separately
licensed. Currently available Data Connector Options include:
■ Data Connector for PeopleSoft Option
■ Data Connector for SAP BW Option
■ Data Connector for SAP R/3 Option
■ Actuate Data Integration Option
An option that supports information objects to combine data from two or
more disparate sources. This option is required where data joining is not
supported through separately licensed third party databases or other
separately licensed technology.

Introduction xxv
 ■ Actuate e.Analysis Option
An application that supports the transformation of data from an Actuate
report into a format that users can view and analyze to determine
relationships and trends.
■ Actuate e.Report Option
An option that provides Encyclopedia volume functionality for e.Report
Designer and e.Report Designer Professional.
■ Actuate e.Spreadsheet Option
An open server application that generates Excel spreadsheets from
e.Spreadsheet Designer files. Using this product, customers can manage
spreadsheet reports and analysis within Actuate iServer System and save
reports as richly formatted Excel spreadsheets.
■ Formula One e.Report Engine Option
An option that provides Encyclopedia volume functionality for Formula
One e.Report Designer and Engine.
■ Actuate Information Object Caching Option
An option that provides the ability to cache data from an information object
in a third party database. This option requires separate licensing of a third
party database server for data storage. This option is not available for
information objects based on Actuate Basic technology.
■ Actuate NameSearch Option
An option that supports matching records based on textual information.
This option requires licensing both the Actuate Data Integration Option
and the Actuate Record Matcher Option.
■ Actuate Online Archive Option
An option that supports hosting more than one Encyclopedia volume
where the additional volume is an archive.
■ Actuate Page Level Security Option
An option that supports personalizing viewing privileges at the user level
for reports and parts of reports.
■ Progress Option
A server application that supports working exclusively with Progress
databases to generate Live Report Documents, manage them in the
Encyclopedia volume, and make them available to users.

xxvi Administering Actuate iSer ver System

■ Actuate Query Option
A web-based tool that supports performing ad hoc queries based on
predefined data streams.
■ Actuate Record Matcher Option
An option that supports the ability to match records in two separate
databases that do not have a common key. This option requires licensing
the Actuate Data Integration Option.

Actuate Viewer
An application end users can use to find, view, and print report documents.

Formula One e.Report Engine

A flexible Java tool for extracting, formatting, and delivering data from a
variety of data sources, including databases, Enterprise JavaBeans, Java objects
inside applications, XML files, Liquid Data for BEA WebLogic, and text files.
Users can deploy completed reports from any J2EE application, WebLogic,
WebSphere, or a web server in CVS, formatted, actionable DHTML, e-mail,
HTML, PDF, RTF, and XML formats. The application data handler supports
accessing Java objects inside applications. The reporting capabilities include
extensive support for XML data sources and output.
Formula One e.Report Engine includes a report designer, Formula One
e.Report Designer, which Java developers can use to design a variety of
reports. This designer is available only with Formula One e.Report Engine.
Written entirely in Java, Formula One e.Report Designer supports charts,
crosstab reports, grouping levels, multiple sections, and parameters.

Formula One e.Spreadsheet Engine

An application that Java developers use to create, design, and distribute
custom spreadsheet reports over the web. Spreadsheet reports can be part of
an application, an applet, or a JavaBean. Formula One e.Spreadsheet Engine
also includes a rich spreadsheet report designer, Actuate e.Spreadsheet
Designer.
Formula One e.Spreadsheet Engine supports:
■ Reading and writing fully-formatted Excel files that include charts,
formulas, merged cells, multiple worksheets, outlining, and other
formatting options
■ A scalable calculation engine for fast calculations and data analysis
■ Standard spreadsheet formulas and functions
■ Risk modeling, online calculators, and simulations

Introduction xxvii
 ■ Dynamic generation of spreadsheet-driven charts with drill-down
capabilities
■ A spreadsheet interface that developers can embed in custom Java desktop
applications and browser-based applets
■ Accessing data from JDBC databases, SAP BW, SAP R/3, XML data files
using a standard interface to any other data source

About the Actuate iServer System product

Actuate iServer System documentation includes printed manuals, installation
guides, online help, user documentation as PDF files, and release notes.
Information about the product that we cannot include before the book printing
deadline appears in the release notes.
Documentation updates that provide information developed in response to
customer requests are available on the Actuate Customer Support web site,
also known as the e.Support site, at http://support.actuate.com. When
customers download updates, the installation program updates the files in the
appropriate locations.
The e.Support site also includes documentation for less frequently used
technology. If you cannot locate the documentation you need, contact Actuate
Customer Support at the e.Support site, by phone, or by e-mail. You can find
the Customer Support telephone number and e-mail information among the
printed materials in an Actuate product box.
The Actuate web site, http://www.actuate.com, contains late-breaking news
about Actuate products and features. The Actuate web site also provides
product update information. To obtain a password to access the portion of the
Actuate web site that is available only to customers, contact Actuate Customer
Support. The engineers in Actuate Customer Support can also help you with
technical questions about Actuate products according to your service contract.

xxviii Administering Actuate iServer System

The printed and online documentation includes the materials described in the
following table.

For information about this topic See the following resource

Installing Actuate iServer System on
Linux, UNIX, and Windows systems
Installing
Deploying Actuate Active Portal for Actuate
JSP on application and web servers iServer
Installing Actuate portlets on an System
application server

Late-breaking information about the Release notes available as download

software and documentation from the e.Support site
Documentation updates in response Documentation available as
to customer requests for additional download from the e.Support site
information
Overview of Actuate iServer System
architecture
Administering
Actuate iServer System configuration Actuate
and administration iServer
Database connections System
Encyclopedia volume configuration
and administration
Working with users, groups,
privileges, and roles
Working with printers and printing
requests
Formatting report data for multiple
locales
Report encoding Working
with Multiple
Designing reports with right-to-left
Locales
orientation

Introduction xxix
 For information about this topic See the following resource
Overview of Actuate web services
and SOAP messaging
Overview and reference for the Programming
Actuate Information Delivery APIs, with Actuate
including examples iServer APIs
Overview and reference for the
Actuate iServer integration APIs,
Actuate archiving APIs, Report
Server Security Extension APIs, and
open server technology
Customizing Actuate Active Portal
Customizing Actuate Active Portal Creating
JavaServer Pages, Active Server Custom Web
Pages, JavaScript files, cascading Applications
stylesheets, and custom tags and using Actuate
controls Active Portal

Security and Actuate Active Portal

Managing files and folders in an

Encyclopedia volume
Making files available to other Using Actuate
Actuate iServer System users Management
Console

Accessing, executing, and viewing

reports
Working with
Reports using
Actuate
Active Portal

xxx Administering Actuate iServer System

 For information about this topic See the following resource
Building and displaying data cubes
for multidimensional analysis Working with
Cube Reports
using Actuate
Analytics
Option

Viewing, analyzing, and exporting

data
Customizing e.Analysis
Using
e.Analysis

Terminology map
Glossary
Actuate 8
Glossary

About Administering Actuate iServer System

Administering Actuate iServer System discusses how to administer Actuate
iServer in a stand-alone configuration, an Actuate iServer System cluster, and
an Encyclopedia volume. The chapters in this guide are:
■ Introduction. This chapter provides an overview of this guide, the Actuate
and ReportingEngines product suite, the Actuate iServer System
documentation, and the typographical conventions used.
■ Part 1. Introducing Actuate iServer. This part introduces Actuate iServer.
■ Chapter 1. Actuate iServer architecture overview. This chapter introduces
Actuate iServer architecture and provides an overview of Actuate iServer
System configuration, including the Actuate iServer System options.

Introduction xxxi
 ■ Part 2. Working with the Actuate iServer System environment. This part
introduces the Actuate iServer System environment, including hardware
configuration, performance, and security configuration.
■ Chapter 2. Setting up Actuate iServer System hardware. This chapter
introduces how to set up and configure the Actuate iServer System
environment.
■ Chapter 3. Understanding Actuate iServer System performance. This chapter
discusses issues related to Actuate iServer System performance.
■ Chapter 4. Configuring Actuate iServer security. This chapter introduces
Actuate iServer System security topics.
■ Part 3. Administering Actuate iServer services. This part introduces the
System Administration console of Actuate Management Console and
discusses how to administer Actuate iServer.
■ Chapter 5. Actuate iServer System administration overview. This chapter
introduces the System Administration console, provides task overviews for
tasks such as setting up an Actuate iServer System cluster, and discusses
how to perform basic tasks such as logging in.
■ Chapter 6. Working with system-wide Actuate iServer parameters. This chapter
introduces Actuate iServer System parameters for system-wide
configuration, which you set using the System Administration console, and
discusses related administrative tasks.
■ Chapter 7. Working with an Actuate iServer System server. This chapter
introduces the server-specific parameters that you set using the System
Administration console and discusses related administrative tasks.
■ Chapter 8. Working with an Actuate iServer System partition. This chapter
introduces the partition-specific parameters that you set using the System
Administration console and discusses related administrative tasks.
■ Chapter 9. Working with an Actuate iServer System volume. This chapter
introduces the volume-specific parameters that you set using the System
Administration console and discusses related administrative tasks.
■ Chapter 10. Adding and configuring an Actuate iServer System resource group.
This chapter introduces the resource group-specific parameters that you set
using the System Administration console and discusses related
administrative tasks.
■ Chapter 11. Adding and configuring an Actuate iServer System printer. This
chapter introduces the printer-specific parameters that you set using the
System Administration console and discusses related administrative tasks.
■ Chapter 12. Working with database connections. This chapter discusses how to
configure a database client to work with Actuate iServer System.

xxxii Administering Actuate iSer ver System

 ■ Chapter 13. Working with Actuate iServer utilities. This chapter discusses how
to use the Actuate iServer utilities to import, export, and upgrade
Encyclopedia volume data and how to install a PostScript font.
■ Chapter 14. Setting Actuate iServer parameters. This chapter lists and
discusses Actuate iServer parameter values, registry keys, and
environment variables.
■ Part 4. Administering an Encyclopedia volume. This part introduces the
Volume Administration console of Actuate Management Console and
discusses how to administer an Encyclopedia volume.
■ Chapter 15. Understanding Encyclopedia volume administration. This chapter
discusses how to connect to an Encyclopedia volume and how to use the
Volume Administration console of Actuate Management Console.
■ Chapter 16. Managing Encyclopedia volume security. This chapter discusses
how to create Encyclopedia users and security roles and how to apply
privileges to Encyclopedia files and folders. This chapter also discusses
how the Encyclopedia volume behaves when you use open security.
■ Chapter 17. Administering channels and notification groups. This chapter
discusses how to set web browser caching options, create channels, and
schedule jobs for channels.
■ Chapter 18. Managing printers and print jobs. This chapter discusses how to
set up printers and manage print jobs.
■ Chapter 19. Administering jobs. This chapter discusses how to administer
Actuate iServer System jobs.
■ Chapter 20. Archiving files and backing up an Encyclopedia volume.This chapter
discusses how to archive files and back up an Encyclopedia volume.
■ Chapter 21. Understanding Actuate iServer options. This chapter discusses
how to generate and print Actuate open server reports, spreadsheet
reports, Actuate Query output, Actuate Analytics cubes, and Formula One
reports.

Online documentation
The information in the printed manuals is also available as Adobe Acrobat
PDF files and in the online help system for Actuate products. For products
without a Windows interface, such as Actuate Active Portal, Actuate provides
HTML help files. You can view these files using a standard web browser.

Introduction xxxiii
 Using online manuals
The online manuals install with the product in the Manuals directory. The
items in the table of contents and the page numbers in the index both contain
links to the corresponding topics in the text. In the index, you access the link
by positioning the pointer over the page number, not the topic.

Using online help

Actuate products provide both context-sensitive online help about the product
and report-specific online help about a report you are viewing. In Actuate 8,
developers can also create customized, report-specific online help.

Using the Actuate online help system

In the Actuate online help system, two panes support accessing and viewing
information. The left pane displays the table of contents or the index. The right
pane displays the contents of an online help topic.
Choose Contents to view a list of help topics
Choose Index to view a list of keywords
Choose Search to locate any word in help files

The tabs at the top of the left pane access different views. Use these tabs to
switch views among Contents, Index, and Search.
The following illustration shows an example of the index and the result of an

xxxiv Administering Actuate iSer ver System

index search.
Choose Index to view a list of keywords
Choose a topic to search the Index

Choose a topic from

the search results

To view a topic, choose the topic in the list. The topic appears in the right pane.

The following illustration shows the result of a search. The topics that contain
the search word appear in the left pane. Choose a topic in the left pane to

Introduction xxxv
 display the topic contents in the right pane.

Using report-specific online help

During the design phase, report developers have the option to include report-
specific online help. For example, a report developer can add comments to
provide details about specific report objects or to explain calculations.

Report-specific online help

For detailed information about report-specific online help, see Chapter 3,

“Viewing a report using the desktop Viewer,” in Using Actuate End User
Desktop.

Typographical conventions
The following table describes the typographical conventions in this guide.

Item Convention Example

Code examples Sans serif Dim Text1 As String
File names Initial capital letter, Detail.roi
except where file names
are case-sensitive

xxxvi Administering Actuate iSer ver System

 Item Convention Example
Key combination A + sign between keys Ctrl+Shift
means to press both
keys at the same time
Menu items Capitalized, no bold File
Submenu items Separated from the File➛New
main menu item with a
small arrow
User input or user Sans serif M*16*
response
User input in XML and Italics chkjava.exe
Java code cab_name.cab

Syntax conventions
The following table describes the symbols used to present syntax.

Symbol Description Example

[] Optional item [Alias<alias name>]
Array subscript matrix[ ]
<> Argument you must <expression to format>
supply
Delimiter in XML <xsd:sequence>
{} Groups two or more {While | Until}
mutually exclusive
options or arguments,
when used with a pipe
Defines array contents {0, 1, 2, 3}
Delimiter of code block public ACJDesigner( )
{
}

| Separates mutually Exit {Do | For |

exclusive options or Function | Sub}
arguments in a group
Java OR operator int length |4

Introduction xxxvii
xxxviii Administering Actuate iServer System
 Part

Introducing Actuate iServer

Part 1
1

Pa r t 1 , In tro ducing Actua te iSer ver 1

2 Administering Actuate iSer ver System
 Chapter

Actuate iServer
Chapter 1
1
architecture overview
This chapter contains the following topics:
■ Introducing Actuate iServer
■ About the Actuate iServer architecture
■ Configuration overview
■ Understanding Actuate iServer administration

Chapter 1, Actuate iServer architecture overview 3

Introducing Actuate iServer
Actuate 8 supports developers and users performing tasks such as designing,
generating, distributing, viewing, and printing reports. While performing
reporting tasks, developers and users work with a variety of report items. An
Encyclopedia volume stores these items and data such as access privileges and
requests for report generation or printing. The services that manage the
information and requests are known collectively as Actuate iServer. For
information about the services that compose Actuate iServer, see “About the
Actuate iServer architecture,” later in this chapter.
Actuate iServer supports storing report documents in an Encyclopedia
volume, managing security and user information, viewing report documents
from an Encyclopedia volume, and handling report requests. Users can view
Actuate report documents, files, Java report documents, spreadsheet reports,
or third-party documents that reside in an Encyclopedia volume. Actuate
iServer also supports report generation and server-side printing of third-party
reports, such as Crystal and SQRIBE reports. Some Actuate iServer System
functionality requires Actuate iServer System options, which you can license
separately. For information about Actuate iServer System options, see
“Understanding the Actuate iServer System options,” later in this chapter.
An Actuate iServer System administrator uses a browser-based application,
Actuate Management Console, to configure Actuate iServer. Actuate
Management Console consists of the Volume Administration console and the
System Administration console. After installing Actuate Management Console
on a web server, an Actuate iServer System administrator can remotely
administer Actuate iServer System, including its Encyclopedia volumes. For
information about configuring and administering Actuate iServer, see
“Configuration overview,” later in this chapter, Part 2, “Working with the
Actuate iServer System environment,” and Part 3, “Administering
Actuate iServer services.” For information about setting up and administering
an Encyclopedia volume, see Chapter 9, “Working with an Actuate iServer
System volume,” and Part 4, “Administering an Encyclopedia volume.”

About the Actuate iServer architecture

Actuate iServer Release 8 consists of the following services:
■ The Encyclopedia service controls Encyclopedia volume administration
functions, such as request validation of login requests. The Encyclopedia
service also manages content, such as reports, users, roles, and notification
groups. The Encyclopedia service manages report generation and print
requests, secures access to the Encyclopedia volume and its contents, and
performs volume tasks, such as creating and deleting Encyclopedia volume

4 Administering Actuate iSer ver System

 folders and adding, moving, and deleting Encyclopedia volume files. For
more information about the Encyclopedia service, see “Understanding
Encyclopedia volume configuration,” later in this chapter.
■ The View service handles requests to view an Actuate Basic report, either a
report object instance (.roi) file or a data object instance (.doi) file. The View
process renders the report. The View service supports viewing and
searching an ROI or a DOI in DHTML format when a user views the report
using a web browser. The View service also supports conversion of Actuate
report document data to XML for use with other web applications and PDF
for printing.
The View service handles requests to download files from an Encyclopedia
volume.
■ The Factory service processes several types of requests:
■ Report execution requests:
- Report generation jobs are scheduled and batched report generation
requests. Actuate iServer stores the schedules in the Encyclopedia
volume. The Encyclopedia service dispatches the requests internally
to the Encyclopedia volume.
- Temporary reports are report requests to run and view a report with
real-time user interaction. Actuate iServer does not store these
requests as jobs in the Encyclopedia volume. You must enable both
the Factory and View services for Actuate iServer to generate the
temporary report. In a cluster configuration, the Message
Distribution service dispatches requests for temporary jobs as a part
of internode communication.
- Queries that retrieve data from information objects require the
Actuate Query Option.
■ Printing requests, which are background jobs. Printing jobs are batched
printing requests. Actuate iServer stores the schedules for printing jobs
in an Encyclopedia volume. Actuate iServer with the Encyclopedia
service can dispatch a printing request when Actuate iServer receives a
request to run and print the report. Alternatively, Actuate iServer with
the Message Distribution service can dispatch the printing request.
When the Factory service processes a request, one of the following
processes executes the request:
■ A Factory process generates a report from an Actuate executable (.dox
or .rox) file and manages the printing of reports using a printer that is
available to an Actuate iServer machine.
■ An Open Server process generates or prints a third-party report.
■ The Message Distribution service dispatches Actuate Information Delivery
API requests that come to Actuate iServer from clients, users, and
applications. The Message Distribution service authenticates each message

Chapter 1, Actuate iServer architecture overview 5

 and forwards it to the proper Actuate iServer service. Actuate iServer
cluster load balancing is a part of the Message Distribution service.
■ The Integration service controls the Actuate Integration process that runs
information object jobs and uses the Actuate Caching process as needed.
For more information about the Integration service, see “About the Actuate
Integration service (AIS) and the Actuate Caching service (ACS)” in
Chapter 5, “Actuate iServer System administration overview.”
■ The Caching service controls the Actuate Caching process that manages the
information object cache database and Record Matcher cache database. For
more information about the Caching service, see “About the Actuate
Integration service (AIS) and the Actuate Caching service (ACS)” in
Chapter 5, “Actuate iServer System administration overview.”
You can install and configure Actuate iServer in a stand-alone configuration or
as a node in an Actuate iServer System cluster. In an Actuate iServer System
cluster, each cluster node can support report viewing, scheduling, execution,
printing, and notification of users. Each node can handle multiple requests
concurrently. For information about configuring and administering Actuate
iServer, see “Configuration overview,” later in this chapter, Part 2, “Working
with the Actuate iServer System environment,” and Part 3, “Administering
Actuate iServer services.”
To support different types of functionality, you enable the appropriate Actuate
iServer services. You can enable other services to augment capabilities of
Actuate iServer System users and efficiently use an Actuate iServer machine’s
resources to reduce the load on other machines. For example, to use Actuate
iServer in a stand-alone configuration that can store, run, and print reports,
you must enable the Encyclopedia and Factory services. If you do not enable
the View service, users cannot view Actuate Basic reports in DHTML format.
Actuate iServer uses the Actuate iServer application container, an HTTP
server, to support Web Service based features such as the Formula One
e.Report Option, and the RSSE Web Service application that ships with
Actuate iServer. Actuate iServer also uses the application container as the
HTTP server for Management Console.
The Actuate Process Manager controls Actuate iServer services and Actuate
Management Console. In a cluster configuration, Process Manager also reports
the status of an Actuate iServer node to the cluster. For more information
about Process Manager, see “About Actuate Process Manager,” later in this
chapter.
To communicate with Actuate iServer, 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 nodes in an Actuate iServer System cluster environment
and with Actuate iServer in a stand-alone configuration.

6 Administering Actuate iSer ver System

Actuate iServer also supports older applications that use the Report Server
API (RSAPI). Applications that use RSAPI can communicate directly with
Actuate iServer only when it has the Encyclopedia service enabled and
running and it manages an Encyclopedia volume.
Actuate iServer supports multiple-CPU machines in both cluster and stand-
alone configurations. For information about licensing and CPUs, see
“Understanding Actuate iServer CPU binding” in Chapter 2, “Setting up
Actuate iServer System hardware.”
The following illustration shows the relationships among the Actuate iServer
components, serviceableness processes running on a single machine.

Web
browsers
Actuate iServer
View
process
SOAP
interface
Application View
Server service
Factory
Message process
Factory
Distribution service
Actuate service
Active Portal
Encyclopedia Integration Integration
and
service service process
Management
Console
Caching
service Caching
Actuate
iServer process
Application
Container RS API
interface

Actuate Information
desktop object cache and
software Record Matcher
databases

Jobs, notifications Folders

Actuate Encyclopedia
ReportCast volume
Report files Users, groups, roles

Chapter 1, Actuate iServer architecture overview 7

 About Actuate Process Manager
Actuate Process Manager manages Actuate iServer. Process Manager is a
service on Windows server platforms and a daemon on UNIX platforms.
Process Manager supports the following functionality:
■ Accesses and modifies the Actuate iServer configuration in response to
requests from Actuate Management Console and the Actuate iServer
cluster master.
■ Controls Actuate Management Console startup and shutdown, if you
install Actuate Management Console on the Actuate iServer machine. For
information about starting and stopping Actuate Management Console, see
“Starting and stopping Actuate Management Console” in Chapter 2,
“Setting up Actuate iServer System hardware.”
■ Supports Actuate iServer cluster node administration:
■ Join or leave a cluster on a request from Actuate Management Console.
■ Start and stop an Actuate iServer node on a request from Actuate
Management Console and the Actuate iServer cluster master.
■ Send Actuate iServer node status information to the Actuate iServer
cluster master.
■ Detect the availability of a node’s network connection to ensure failover
handling in a cluster.
You can configure Process Manager to start automatically when an Actuate
iServer machine boots. Alternatively, you can start Process Manager manually.

About Actuate resource groups

A resource group controls the Factory processes Actuate iServer uses to run a
synchronous or asynchronous job to create or print report output. A resource
group specifies a set of Factory processes in an Actuate iServer machine.
Actuate iServer reserves those Factory processes for executing jobs assigned to
the group.
To control how Actuate iServer System uses Factory processes, you create and
manage resource groups using the System Administration console of Actuate
Management Console. For information about using resource groups, see
Chapter 10, “Adding and configuring an Actuate iServer System resource
group.”

8 Administering Actuate iSer ver System

Configuration overview
Actuate iServer Release 8 supports two configurations:
■ In a stand-alone configuration, you install Actuate iServer and configure all
Actuate iServer services on a single machine. Actuate iServer in a stand-
alone configuration is not part of a server cluster. For an example of
Actuate iServer in a stand-alone configuration, see “Examining a sample
stand-alone configuration,” later in this chapter.
The default stand-alone Actuate iServer configuration supports
Encyclopedia volume administration and other server functionality, such
as report generation, printing, and viewing.
An administrator uses Actuate iServer in a stand-alone configuration to
create a cluster of one or more Actuate iServer machines.
■ A cluster configuration typically includes multiple Actuate iServer nodes.
An Actuate iServer node is a single machine in an Actuate iServer cluster.
You install Actuate iServer on each node in a cluster. For an example of an
Actuate iServer cluster, see “Examining a sample cluster configuration,”
later in this chapter.
One node, called the cluster master, controls the configuration of the other
machines in an Actuate iServer System cluster. You can enable one or more
services on each Actuate iServer node. To route user requests to available
server nodes, you enable the Message Distribution service on one or more
nodes. You must enable Message Distribution service on the cluster master.
In both configurations, Actuate Process Manager controls the Actuate iServer
processes that run on each Actuate iServer machine. For information about
Process Manager, see “About Actuate Process Manager,” earlier in this
chapter.

Working with Actuate iServer System licensing

Actuate iServer Release 8 supports named user-based licensing and
Encyclopedia volume-based licensing.
An Actuate iServer Release 8 license supports running Actuate iServer and
using sets of Actuate iServer features, which are grouped as Actuate iServer
System options. The following items limit Actuate iServer System option
limits are based on:
■ The maximum number of Actuate iServer named users that use an option.
A named user is an individual who receives content and value from
Actuate iServer.

Chapter 1, Actuate iServer architecture overview 9

 ■ The maximum number of Encyclopedia volumes that use an option. The
maximum number of Encyclopedia volumes managed by Actuate iServer.

Understanding Actuate iServer license features

A user can purchase can license Actuate iServer System Release 8 in either of
the following ways:
■ For a specified number of named users.
Actuate iServer Release 8 supports licensing Actuate iServer System and its
options based on a maximum number of named users. A named user is a
distinct individual who receives content and value from Actuate iServer.
For each Actuate iServer option that you license based on named users, the
license limits the number of named users who can use the features of that
option.
You can also license Actuate iServer and its options for an unlimited
number of named users.
■ For a specified number of Encyclopedia volumes. Managing multiple
Encyclopedia volumes requires the Actuate iServer Additional Volume
Option and Archive Option. For more information about Actuate iServer
System options, see “Understanding the Actuate iServer System options,”
later in this chapter.
Use the following information to determine the maximum number of
Encyclopedia volumes that Actuate iServer can manage:
■ Without the Additional Volume Option and the Archive Option,
Actuate iServer System manages one Encyclopedia volume.
■ The sum of 1 + m + n, where
- m is the maximum number of Encyclopedia volumes licensed under
the Additional Volume Option.
- n is the maximum number of Encyclopedia volumes licensed under
the Archive Option.
The System Administration console of Actuate Management Console displays
information about the Actuate iServer System license on System—
Properties—License. For information about System—Properties—License, see
“Working with Actuate iServer System license information” in Chapter 6,
“Working with system-wide Actuate iServer parameters.”

Understanding the Actuate iServer System options

The following table describes the Actuate iServer System Release 8 options.
The table also indicates which of the options are Encyclopedia volume-based
options. The options that are not Encyclopedia volume-based options are
named user-based options. Using many of the options also requires the
appropriate report generation option, such as e.Report Option or Formula One

10 Administering Actuate iServer System

 e.Report Option. Those options that work only with Actuate Basic reports
require e.Report Option.

Supported Volume-
Option Description releases based
Actuate Analytics Supports multidimensional analysis of 7, 8
data cubes. You can develop a data cube
using Actuate Analytics Cube Designer.
When you analyze the data cube, you
can aggregate or categorize data,
summarize data, and create graphs
based on data. You can save and share
views of the analysis you perform in the
Encyclopedia volume.
Actuate Query Supports information retrieval from 7, 8
predefined data sources called
information objects, which are data
object instance (.doi) files and data
object executable (.dox) files. A
developer creates information objects
using Actuate e.Report Designer
Professional.
Additional Volume Supports Actuate iServer System 8 X
managing multiple Encyclopedia
volumes. You license this option to
support a specific number of
Encyclopedia volumes.
Online Archive Supports adding an Encyclopedia 8 X
volume and using the volume with the
Actuate Online Archive application that
ships with Actuate iServer. Does not
require Additional Volume Option.
Permission to customize and use the
Actuate Online Archive application
source code. Source code ships with
Actuate iServer Integration Technology.
Data Connector for Supports viewing, generating, and 8
PeopleSoft downloading content that accesses
PeopleSoft.
Data Connector for SAP Supports viewing, generating, and 8 X
BW downloading content that accesses SAP
BW.

Chapter 1, Actuate iSer ver architecture over view 11

 Supported Volume-
Option Description releases based
Data Connector for SAP Supports viewing, generating, and 8
R/3 downloading content that accesses SAP
R/3.
Data Integration Supports viewing, generating, and 8
downloading content that depends on
the use of an information object that
accesses multiple data sources. Using an
information object that accesses only a
single data source does not require this
option.
e. Analysis Provides content viewers with 6, 7, 8
expanded analytical capabilities for
Actuate Basic reports.
e. Spreadsheet Provides content-generation capabilities 6, 7, 8
for spreadsheet reports. You develop
spreadsheet reports using Actuate
e.Spreadsheet Designer.
e.Report Provides content-generation capabilities 6, 7, 8
for Actuate Basic reports. You develop
Actuate Basic reports using Actuate
e.Report Designer or e.Report Designer
Professional.
Actuate iServer Release 8 separates the
functionality of the Release 7 e.Report
Generation Option into the Release 8
e.Report Option and the Release 8
Formula 1 e.Report Option.
Formula One e.Report Provides content generation capabilities 8
for Formula One reports. You develop
Formula One reports using Formula
One e.Report Designer.
Actuate iServer Release 8 separates the
functionality of the Release 7 e.Report
Generation Option into the Release 8
e.Report Option and the Release 8
Formula 1 e.Report Option.
Information Object Supports viewing, generating, and 8
Caching downloading content that uses the
Information Object Caching service.

12 Administering Actuate iServer System

 Supported Volume-
Option Description releases based
NameSearch Supports viewing, generating, and 8
downloading content that depends on
the use of NameSearch software.
Page Level Security Provides page-level security capabilities 6, 7, 8
for Actuate Basic reports.
Record Matcher Supports viewing, generating, and 8
downloading content that depends on
the use of the Actuate Record Matcher
feature.

For a list of Encyclopedia volume file types and the names of those files, see
“Understanding the File Types page” in Chapter 21, “Understanding Actuate
iServer options.” For complete descriptions of the Actuate file types, see
Actuate 8 Glossary.
Actuate iServer Release 8 uses a license file acserverlicense.xml that contains
the Actuate iServer license information. The license file is in the same location
as the acserverconfig.xml file. For more information about acserverconfig.xml
and for the location of the “About the Actuate iServer System configuration
file” in Chapter 5, “Actuate iServer System administration overview.”

Examining a sample stand-alone configuration

The following illustration shows an example of Actuate iServer in a stand-
alone configuration. This example shows the relationships between Actuate
iServer and its Encyclopedia volumes, your application servers, and an
RDBMS server.

Chapter 1, Actuate iSer ver architecture over view 13

 Application Application Application
server server servers,
Actuate Active
Portal, and
Actuate
Management
Console
Actuate
iServer Server

Application
databases
Encyclopedia
volumes

In the preceding illustration, Actuate iServer manages two Encyclopedia

volumes. To support multiple Encyclopedia volumes, Actuate iServer requires
the Actuate Additional Volume Option, which you purchase separately.

Examining a sample cluster configuration

The following illustration of a cluster shows the relationships between an
Actuate iServer cluster and its Encyclopedia volumes, application servers, and
an RDBMS server. In this example, the cluster uses a network router to create a
single virtual IP address to distribute the requests that come into the cluster to
two Actuate iServer nodes that handle load balancing for the cluster. Actuate
Active Portal and Actuate Management Console support distributing requests
to multiple Actuate iServer machines that handle load balancing in an Actuate
iServer cluster.

14 Administering Actuate iServer System

 Application servers,
Application Application Actuate Active
server server Portal, and Actuate
Management
Console

Router Optional hardware

router

Actuate
Actuate load
iServer cluster
balancing
Server Server

Actuate
iServer Server Server Server
nodes

Application
databases
Server Server
Encyclopedia
volumes

The preceding illustration shows the Actuate iServer cluster as three sections:
■ In the Actuate load balancing section, Actuate iServer installed on multiple
machines routes requests and performs load balancing for the Actuate
iServer cluster. Actuate iServer routes request messages to an Actuate
iServer node that can handle the request.
■ In the Actuate iServer nodes section, Actuate iServer supports report
generation and viewing.
■ In the Encyclopedia volumes section, Actuate iServer running on multiple
machines maintains Encyclopedia volume administration information and
controls access to the volumes. The volumes can be on machines that are
not running Actuate iServer but are accessible to an Actuate iServer
machine.
In the preceding illustration, separate machines handle separate functions.
You can combine these functions on one machine.

Chapter 1, Actuate iSer ver architecture over view 15

 About default Actuate iServer configurations
By default, the stand-alone Actuate iServer configuration enables all services
on one Actuate iServer machine. Similar to a stand-alone configuration, the
most basic cluster configuration is a single node on which you configure the
Actuate iServer services. A cluster can optionally contain additional nodes on
which you enable other services. If a cluster consists of two nodes, you must
enable the Message Distribution service on at least one node.
In an Actuate iServer cluster, you can configure different Actuate iServer
nodes with specific services to provide different functionality and process
different types of requests. You can base the node configuration on
characteristics, such as processing power, or access to hardware and software
resources, such as printers and database drivers.
An administrator can change the Actuate iServer cluster as necessary. For
example, an administrator can:
■ Add more Actuate iServer nodes with Factory and View services. Making
additional Factory and View services available supports an increased
workload.
■ Enable the Encyclopedia service on additional nodes. The availability of
additional Encyclopedia services supports hosting additional applications.
■ Add nodes to a cluster. Additional nodes support implementing failover of
other nodes in a cluster.
In a cluster, the cluster master has the Message Distribution service enabled.
When you create a cluster with multiple nodes, stop all Actuate iServer
machines, then restart the machines. The first cluster machine that starts with
the Message Distribution service enabled becomes the cluster master.

About starting Actuate iServer

The default behavior when starting Actuate iServer in the stand-alone
configuration is for Process Manager to start Actuate iServer and enable
services. This behavior is optional and configurable.
The default behavior when starting an Actuate iServer node in an Actuate
iServer cluster is for Process Manager not to start Actuate iServer. By default,
an administrator must log in to the cluster master using Actuate Management
Console and start a node’s services.
When you start Actuate iServer System, Actuate iServer checks the following
features of the Actuate iServer System license:
■ Validity of the license file
■ Encyclopedia volume limitations
■ CPU limitations, if applicable

16 Administering Actuate iServer System

■ License expiration date, if applicable

About restarting Actuate iServer in a default configuration

In the default configuration, Actuate iServer restarts in the following ways:
■ When an Actuate iServer node with the default configuration crashes and
reboots, the node rejoins the cluster. The node remains offline with its
services stopped until an Actuate iServer System administrator starts the
node’s services from the cluster master.
■ When Actuate iServer in the default stand-alone configuration crashes and
reboots, the Actuate iServer status changes from failed to online and its
services restart.

About Actuate iServer cluster configuration

In an Actuate iServer cluster, you can distribute Actuate iServer services
among Actuate iServer nodes. The following illustration shows an Actuate
iServer cluster configuration.

Chapter 1, Actuate iSer ver architecture over view 17

 Internet

Router

Application
servers Server Server Server

Optional Router
hardware router

Actuate iServer cluster

M V F I C E M V F I C E

M V F I C E M V F I C E2

Network
M V F I C E1 M V F I C E3

EV 1 EV 2 EV 3

In the preceding Actuate iServer cluster illustration, each node is a computer

running Actuate iServer. Four letters represent the Actuate iServer services:
■ M is the Message Distribution service.
■ V is the View service.
■ F is the Factory service.
■ E is the Encyclopedia service for EV, which is the Encyclopedia volume.
■ I is the Integration service.
■ C is the Caching service.

18 Administering Actuate iServer System

A bold letter represents an enabled service. The other letters represent
disabled services. When you enable or disable a service, an Actuate iServer
node supports different functionality within the cluster.
Two nodes have the Message Distribution service enabled in the Actuate
iServer cluster in the preceding example. In the example, the two Actuate
iServer machines share one Virtual IP address through a virtual IP address,
load-balancing router, such as Cisco Local Director or Windows Load Balancer.
Actuate Active Portal or Actuate Management Console performs load
balancing without requiring a load-balancing router. All requests to the
Actuate iServer cluster go to one of the two redirector nodes, which are the
nodes with the Message Distribution service enabled. The redirector nodes
dispatch the requests to other nodes in the cluster based on message type and
cluster load. The Actuate iServer node with the bold outline is the cluster
master.
The cluster master manages cluster configuration. One or more nodes,
including the cluster master, manage request message routing. When you
create a cluster, the cluster master is the node you use to create the cluster.
Otherwise, the cluster master is the first Actuate iServer node that starts with
the Message Distribution service enabled. A backup cluster master node is any
node that can assume the role of the cluster master if the cluster master fails. In
other words, a redirector node is a backup cluster master node, because a node
must have the Message Distribution service enabled to be a redirector node or
a cluster master.
An Actuate iServer cluster uses HTTP for communication between Actuate
iServer nodes. Actuate Process Manager also uses HTTP to communicate with
cluster nodes. The Message Distribution service uses HTTP to communicate
with other servers in a cluster.
An Actuate iServer System cluster supports unicast and mulitcast network
communication within a cluster. For information about configuring an Actuate
iServer cluster to use multicast, see “About cluster networking requirements”
in Chapter 5, “Actuate iServer System administration overview.”

Understanding Encyclopedia volume

configuration
An Encyclopedia service controls each Encyclopedia volume. The
Encyclopedia service processes requests related to the volume, such as
browsing and managing objects in the volume, validating access to objects in
the volume, and finding dependencies among objects in the volume.
To enable the Encyclopedia service on an Actuate iServer machine, an
administrator assigns an Encyclopedia volume to Actuate iServer on that
machine. When it is enabled, the Encyclopedia service dispatches volume-
related requests to the appropriate agent, such as a Factory service, a View

Chapter 1, Actuate iSer ver architecture over view 19

 service, or another part of the Encyclopedia service. After dispatching the
request, the Encyclopedia service continues to manage the request.
In a cluster, an administrator can configure an Encyclopedia service as a
failover service for an Encyclopedia volume. If the node that runs the primary
Encyclopedia service fails, the Encyclopedia service on the failover node
manages the Encyclopedia volume. An administrator can also configure an
Encyclopedia service to manage multiple volumes using the Additional
Volume Option. For more information about Actuate iServer System options,
see “Understanding the Actuate iServer System options,” earlier in this
chapter.
The default location for Encyclopedia volume data is a specific location in the
Actuate iServer installation directory. An Actuate iServer System
administrator can configure the Encyclopedia volume to reside in a different
location. To move an Encyclopedia volume, an Actuate iServer System
administrator must take the volume offline. When the volume is offline, the
administrator can move it to another location. For more information about
relocating an Encyclopedia volume, see “Moving an Encyclopedia volume” in
Chapter 9, “Working with an Actuate iServer System volume.”
An administrator can also add or remove an Encyclopedia volume at any time.
Users can access a volume as soon as the administrator adds it. After an
Actuate iServer System administrator removes a volume, any attempt to
access references to the removed volume produces an error. For information
about adding or removing an Encyclopedia volume, see “Adding and
configuring an Encyclopedia volume” or “Removing an Encyclopedia volume
from Actuate iServer System” in Chapter 9, “Working with an Actuate iServer
System volume.”

Understanding partition configuration

An Encyclopedia volume consists of one or more partitions. There are two
types of partitions, primary and secondary. Secondary partitions are optional.
Each partition is a file system directory, a physical disk location that Actuate
iServer uses to store Encyclopedia volume data.
The default location of the primary partition is the following directory:
<server_home>/encyc/volume
where <server_home> is the Actuate iServer installation location.
The primary partition contains volume-specific information (metadata). An
administrator cannot remove a primary partition from Actuate iServer System.
An administrator can only move the primary partition.
A secondary partition provides additional storage space for report executable
files and documents. An administrator can add, move, or remove a secondary

20 Administering Actuate iServer System

partition. When secondary partitions are available, Actuate iServer divides
volume content among the partitions.
For more information about partitions, see “Configuring an Actuate iServer
System partition” in Chapter 8, “Working with an Actuate iServer System
partition.”

Understanding how Actuate iServer uses partitions

Actuate iServer uses any partitions assigned to an Encyclopedia volume. As
Actuate iServer adds new files to the Encyclopedia volume, it determines the
partition on which to store the files. Actuate iServer uses the partition with the
most available space.
For example, Actuate iServer starts with a primary partition. When an
administrator adds a secondary partition, which is on another disk, Actuate
iServer System adds files to the secondary partition of the Encyclopedia
volume. When both partitions have roughly the same amount of free space,
Actuate iServer evenly distributes files to the two partitions.

Removing partitions
An administrator can remove a secondary partition by changing the
configuration for that partition. When the administrator changes the
configuration of the partition to remove it, Actuate iServer starts a background
process of moving files from that partition to other partitions. The
administrator can monitor Actuate iServer progress using Actuate
Management Console. The operation fails if the other partitions drop below
their minimum free space limits. When Actuate iServer finishes moving the
files, the state of the partition changes to inactive. At that point, the
administrator can remove the partition.

Working with clustered volumes

In an Actuate iServer cluster, the Actuate iServer System administrator can use
Encyclopedia volumes to support application-level partitioning by
configuring different applications to use different 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 example,
business needs can require the separation of billing information from sales
information. To use multiple 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 Encyclopedia
volume.
As another example, to make two Encyclopedia 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

Chapter 1, Actuate iSer ver architecture over view 21

 designer can externalize Encyclopedia volume user information using the
Actuate Open Security feature and centralize the user information in an
external security source. For example, Actuate iServer can store the
Encyclopedia volume user information in an LDAP server. Multiple
Encyclopedia volumes can use the user information from the LDAP server. For
more information about working with an LDAP server, see “About open
security LDAP configuration” in Chapter 4, “Configuring Actuate iServer
security.”

Understanding Actuate iServer administration

An Actuate iServer System administrator uses the System Administration
console of Actuate Management Console to perform administration tasks for
an Actuate iServer cluster, an Actuate iServer node, and for Actuate iServer in
a stand-alone configuration. The Volume Administration console of Actuate
Management Console supports Encyclopedia volume administration for both
Actuate iServer in both stand-alone and cluster configurations.
Actuate Management Console is a browser-based application that you can
install on a web server. The web server must have access to the Actuate iServer
cluster or stand-alone Actuate iServer machine.

About administering Actuate iServer in a stand-

alone configuration
Administering Actuate iServer in a stand-alone configuration is similar to
administering a single node in a cluster. For general information about
administering Actuate iServer, see Chapter 5, “Actuate iServer System
administration overview.”
A custom application that uses the Information Delivery API to administer
Actuate iServer in a stand-alone configuration can send a message directly to
Actuate iServer without logging in to Actuate Management Console. For
information about using the Actuate Information Delivery API, see
Programming Actuate iServer Applications.

About administering an Actuate iServer cluster

and Actuate iServer nodes
An Actuate iServer System administrator controls the configuration of a
cluster and of each node in a cluster, including:
■ Actuate iServer System services and settings
■ Services and settings for an Actuate iServer node

22 Administering Actuate iServer System

■ Cluster membership
Actuate Management Console sends configuration messages to the Message
Distribution service. The Message Distribution service routes a message to the
correct node. A custom application that uses the Information Delivery API to
administer an Actuate iServer node also sends Information Delivery API
messages to the Message Distribution service for the cluster.
You can remove an Actuate iServer node from a cluster. To do that, Actuate
Process Manager modifies the configuration of the node to indicate that the
Actuate iServer node is no longer a part of a cluster. The Actuate iServer
cluster master then removes the node from the cluster membership list. After
you remove the node from the cluster, Actuate iServer can operate in a stand-
alone configuration only if you originally installed Actuate iServer on that
Actuate iServer machine in a stand-alone configuration. Otherwise, Actuate
iServer will not start in the stand-alone configuration. For information about
the types of Actuate iServer configurations, see “Configuration overview,”
earlier in this chapter.
For more information about administering an Actuate iServer cluster, see
Chapter 5, “Actuate iServer System administration overview.”

About Encyclopedia volume administration

An Encyclopedia volume administrator controls an Encyclopedia volume and
manages the volume’s administration information, such as users and their
properties, security roles, notification groups, and channel memberships. The
Actuate iServer System administrator controls the Encyclopedia volume’s
contents, such as files and folders, and access to the volume. For information
about administering a volume, see Chapter 15, “Understanding Encyclopedia
volume administration.”

Chapter 1, Actuate iSer ver architecture over view 23

24 Administering Actuate iServer System
 Part

Working with the Actuate iServer

Part 2
2
System environment

Pa r t 2, Wor king w ith the Actuate iSe r ve r System environ me n t 25

26 Administering Actuate iServer System
 Chapter

Setting up Actuate
Chapter2
2
iServer System hardware
This chapter contains the following topics:
■ Configuring Actuate iServer
■ About the archive driver
■ Understanding Actuate iServer CPU binding

Chapter 2, Setting up Actuate iSer ver System hardware 27

Configuring Actuate iServer
This section contains the following topics:
■ Setting up an Actuate iServer account
■ Finding the Actuate iServer home directory
■ Configuring Actuate iServer processes
■ Configuring Actuate iServer to use a report generation option
■ Configuring open server
■ Configuring the Actuate iServer locale
■ Configuring year conversion for Actuate Basic reports
■ Setting up e-mail notification
■ Printing on UNIX
■ Mapping fonts for charts in Actuate Basic reports
■ Configuring Actuate iServer to search for fonts for an Actuate Basic report

Setting up an Actuate iServer account

This section describes how to set up an Actuate iServer account on a machine
running a Microsoft Windows server operating system and on a machine
running UNIX. For a list of supported products, see the Actuate Supported
Products and Obsolescence Policy at the following URL:
http://support.actuate.com/es/products/supportedprod.asp
The account you set up for the Process Manager service must have the
appropriate privileges and access to the required software and hardware, such
as database connectivity software, remote database servers, and printers.
To provide access to Actuate iServer clients, the account that runs Actuate
iServer must have access to resources such as data sources and hardware
devices. For example, if a network printer is available and accessible to
Actuate iServer, you can make the printer accessible to clients.
The account you use to run Actuate iServer affects Actuate iServer System
security. In most cases, the best option is to create a special account for Actuate
iServer. This approach simplifies Actuate iServer administration by ensuring
that the server account is associated only with Actuate iServer-specific issues
and events. If you exercise the same control over the Actuate iServer account
as your site exercises for system administrator or root accounts, you can
maintain the same level of security for Actuate iServer.

28 Administering Actuate iServer System

If you create a special Actuate iServer account, you must ensure that the
Actuate iServer account can access all necessary Windows server facilities,
such as those that manage e-mail and ODBC connections. Otherwise, Actuate
iServer features that require those facilities are unavailable.
To run Actuate iServer, an account must have the appropriate access privileges
to the server’s directory hierarchy, which contains all the Actuate iServer files
and folders. To maintain a secure server, you must control access to the
Actuate iServer account. For example, you can maintain security on UNIX
systems by installing Actuate iServer under the root account. If your site
restricts or prohibits the use of root processes to run externally obtained
software for security reasons, this approach is not an option.

Setting up an Actuate iServer account and software on a

Windows machine
During installation, the Actuate iServer setup program uses the account of the
user running the setup program and the current machine name to register
Actuate Process Manager as a service. If necessary, the Actuate iServer
administrator must work with the Microsoft Windows system administrator
to change the account the Actuate Process Manager and Actuate iServer
applications use after installing the software.
The following requirements determine how you set up an Actuate iServer
account:
■ You cannot run Actuate iServer using the Local System account.
■ The Actuate iServer account must interact with the desktop if you use
utilities that interact with the desktop, such as OLE Automation.
You can use one of the following types of accounts when you install and run
Actuate iServer:
■ An account that is a member of the Administrator group
■ An account that belongs to a group of which a member is logged in when
the machine is running
■ An account that belongs to a user who is logged in when the machine is
running
If the machine running Actuate iServer processes has user accounts controlled
by a domain server and user accounts controlled by the local machine, install
Actuate iServer from a user account controlled by the local machine and not a
user account controlled by a domain server. For more information about
installing Actuate iServer, see Installing Actuate iServer System.
If you use Microsoft Exchange for e-mail notification and if the user account
the Actuate iServer uses for e-mail is in a different domain, you must configure
Actuate iServer to use the account. For information about configuring Actuate

Chapter 2, Setting up Actuate iSer ver System hardware 29

 iServer when the server uses e-mail, see “Setting up Actuate iServer e-mail
notification using Microsoft Exchange,” later in this chapter.

Running Actuate iServer using a non-administrator account

To run Actuate iServer using a non-administrator account on a Windows
machine, create the user account before you install Actuate iServer. The user
account requires Run as services access.

How to run Actuate iServer using a non-administrator account

1 Install Actuate iServer as an administrator user to create the Actuate
Process Manager service. During installation, type the non-administrator
user name and password for the user name and password of the user that
runs the service.
If the user does not have Log on as service privilege, a prompt appears. At
the prompt, choose OK to grant the privilege to the user.
2 Start Actuate iServer.
3 Set the Actuate iServer inherits the desktop and window station parameter
to true.
For information about setting Actuate iServer parameters, see “Changing
advanced Actuate iServer parameter values” in Chapter 7, “Working with
an Actuate iServer System server.”

Installing a portmapper service

Actuate iServer requires a portmapper service, such as NobleNet portmapper
for TCP or Hummingbird portmapper. If you start Actuate iServer using an
Administrator account, and the portmapper service is not installed, Actuate
iServer installs NobleNet portmapper for TCP.
If you use a non-administrator account to run Actuate iServer on a machine
running Windows, Actuate iServer cannot install NobleNet portmapper for
TCP. If the Actuate iServer machine does not have a portmapper service
installed, you must install and configure the portmapper service after you
install Actuate iServer.

How to install and configure the portmapper service

1 Using Windows Explorer, navigate to the Actuate iServer bin directory.
The default bin directory is C:\Program Files\Actuate8\iServer\bin.
2 Double-click portinst.exe.
NobelNet Portmapper Utility appears.
3 Specify how to install and configure the portmapper:

30 Administering Actuate iServer System

 ■ Select Install NobleNet Portmapper.
■ Select Start automatically during system startup.
Choose OK.
The WinRPC Portinst Utility appears.
4 Choose Yes to start the service.
5 Choose OK to confirm startup.
6 Close NobelNet Portmapper Utility.
You can use the Services window to confirm that NobelNet Portmapper for
TCP started.

Running reports using a non-administrator account on a Windows

system
If you use a non-administrator Windows account to run Actuate iServer:
■ You must confirm that the user can access ODBC data sources. If a report
that accesses an ODBC data source defined as system data source (System
DSN) fails, log in using the Actuate iServer account and configure the data
source as a User DSN. For information about configuring an ODBC data
source as a User DSN, see your Microsoft documentation.
■ You must set the desktop and window station parameter to true to run
SQRIBE and Crystal open server reports. For information about setting
Actuate iServer parameters, see “Changing advanced Actuate iServer
parameter values” in Chapter 7, “Working with an Actuate iServer System
server.”

Setting up an Actuate iServer account on a UNIX machine

Like all UNIX processes, the processes that perform Actuate iServer tasks run
under a specific account. You must set up this account properly to ensure that
it functions correctly and preserves the level of security you expect. Work with
your UNIX system administrator to set up the Actuate iServer account. When
you create an Actuate iServer cluster, all Actuate iServer nodes in the cluster
running on UNIX machines must run under the same user account.

About the Actuate open security feature

If you plan to use an Actuate open security application to control access to an
Encyclopedia volume, Actuate iServer and Report Server Security Extension
(RSSE) must have access to the external security source. A system
administrator typically migrates the Encyclopedia volume for use with the
open security application. For information about migrating a volume for use
with open security, see “Importing and exporting data with open security and

Chapter 2, Setting up Actuate iSer ver System hardware 31

 the sample Actuate RSSE application” in Chapter 4, “Configuring Actuate
iServer security.”
For information about the open security feature and the open security
application that ships with Actuate iServer, see Chapter 16, “Managing
Encyclopedia volume security.” For information about configuring the
Actuate iServer for use with the open security application that ships with
Actuate iServer, see “About open security LDAP configuration,” later in this
chapter.

Accessing resources
The following sections discuss how to access Actuate iServer System
resources.

About Universal Naming Convention syntax

Actuate supports connecting to remote drives using only Universal Naming
Convention (UNC) syntax. For example, on a Microsoft Windows server, use
the following UNC syntax to specify a partition in the \files\master-encyc
directory on a machine named foxtrot:
\\foxtrot\files\master-encyc

Accessing resources on a Microsoft Windows server

If you run Actuate iServer using a non-administrator user account, you might
need to configure ODBC data sources as the non-administrator user under
User DSN. For information about using a non-administrator account, see
“Running reports using a non-administrator account on a Windows system,”
earlier in this chapter.
On Microsoft Windows server operating systems, use Printers in the Control
Panel to make printers accessible on a system.
In Microsoft Windows NT 4.0, there is a problem with Actuate iServer
processes accessing network printers. This problem occurs when you use a
user account with automatic startup to install Actuate iServer. For more
information about the Microsoft Windows NT 4.0 problem, see the Microsoft
Knowledge Base article Q137631 on the Microsoft web site.
The work-around for this printing problem is to create a local printer on the
Windows NT server that uses a 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 Actuate iServer machine, use the printer Rainbow_local
to print to the network printer Rainbow.

32 Administering Actuate iServer System

On a Windows server, if an Actuate report object executable (.rox) file specifies
an external library without a path or with a relative path, Actuate iServer
searches for the library. Actuate iServer looks for the library in the home
directory for Actuate iServer then in the directories listed in the PATH
environment variable.

About X Windows requirements for a UNIX server

Running Actuate iServer on a UNIX machine requires access to an X Windows
server. To print or display reports on a UNIX server, the account running
Actuate iServer must have access to a machine running X Windows system.
Actuate supports X Server version X11R4 and higher. For information about
the X Windows system, see the X.Org web site, http://www.x.org.
The Actuate iServer account’s DISPLAY environment variable must point to
the X Windows server. For example, if the Actuate iServer machine is running
X Windows, you can set DISPLAY to the local machine:
# setenv DISPLAY :0.0
If you use a separate machine as the X Windows server, specify the machine
name in the DISPLAY environment variable. The following example sets
DISPLAY to use an X Windows server on a machine named Bermuda:
# setenv DISPLAY bermuda:0.0
Actuate supports xvfb, a virtual X server, as part of Actuate iServer for UNIX
operating systems. The virtual X server satisfies the Actuate iServer
requirement for access to an X server. The installation and configuration of
xvfb is an option in the Actuate iServer installation in AIX and Solaris
environments. To use xfvb in the HP-UX environment, you must install xfvb
before you install Actuate iServer.

Accessing a printer using Actuate iServer on a UNIX server

For Actuate iServer to recognize a printer:
■ On a Solaris system, the printer’s name must appear as a subdirectory of
the /etc/lp/printers directory. On Solaris 2.6 and later, Actuate iServer also
uses printers you can list using the following command:
lpget list
■ On an HP system, the printer’s name must appear as an entry in the /etc
/lp/member directory.
■ On an IBM system, the printer’s name must appear as an entry in the /etc
/qconfig file.

Chapter 2, Setting up Actuate iSer ver System hardware 33

 Accessing a library using Actuate iServer on a UNIX server
The Actuate library path, $AC_SERVER_HOME/lib, must be part of the
shared library search path environment variable. The following environment
variables specify the shared library search path:
■ On SunOS, the environment variable is LD_LIBRARY_PATH.
■ On AIX, the environment variable is LIBPATH.
■ On HP-UX, the environment variable is SHLIB_PATH.
If an Actuate report object executable (.rox) file specifies an external library
using a path or a relative path, Actuate iServer searches for the library. Actuate
iServer looks for the library in the $AC_SERVER_HOME directory and then
the shared library search path.

Using fonts with Actuate iServer

Actuate iServer uses fonts and font information when generating report
output in DHTML and PDF format. The server also uses fonts and font
information when printing reports. Actuate iServer supports both TrueType
and PostScript fonts.
For information about using fonts with multiple locales and installing and
using TrueType and PostScript fonts, see Chapter 4, “Using fonts in Actuate
Basic reports with multiple locales,” in Working with Multiple Locales.
For information about using fonts for printing using Actuate iServer on a
UNIX machine, see “Printing on UNIX,” later in this chapter.

Generating large files on a UNIX server

Actuate iServer can create large files on the Actuate iServer machine.
Supporting the generation of large files can require that a system
administrator increase the maximum file size allowed on the system and
restart the Actuate iServer machine.
Use the following UNIX command to find system resource limits:
ulimit
For information about resource limits, the ulimit command, and how to
change system resource limits, see the documentation for your UNIX system.

Setting a limit for UNIX file descriptors

To control the maximum number of file descriptors Actuate iServer can have
open, set the Maximum Number of File Descriptors on UNIX parameter. For
information about setting advanced Actuate iServer parameters, see

34 Administering Actuate iServer System

“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”
The default value for the Maximum Number of File Descriptors on UNIX
parameter is 32768. If the Maximum Number of File Descriptors on UNIX
parameter is set, the maximum number of file descriptors that an Actuate
iServer machine can have open is the lower of either the hard limit for the
Actuate iServer machine or the value of the parameter. For example:
■ If the hard limit for the Actuate iServer machine is 4096, and the parameter
value is the default setting, the descriptor limit for the process is 4096.
■ If the hard limit for the Actuate iServer machine is unlimited, and the
parameter value is the default setting, the maximum number of file
descriptors for the process is 32768.
■ If the hard limit for the Actuate iServer machine is unlimited, and the
parameter value is 65536, the maximum number of file descriptors is 65536.
■ If the hard limit for the Actuate iServer machine is 4096 and the parameter
is set to 2048, the effective descriptor limit for the process is 2048.
To find the hard limit for the Actuate iServer machine on nofiles, use the
following UNIX command:
ulimit -aH
For information about file descriptors and the ulimit command, see your
UNIX system documentation.
Actuate ReportCast controls the maximum number of open file descriptors
using the environment variable AC_SERVER_UNIX_FD_MAX. For more
information about working with Actuate ReportCast, see the configuration
information in Using and Customizing Actuate ReportCast.

Controlling Actuate iServer thread stack size

Application errors occur if an application exceeds the default thread stack size.
You can configure the Actuate iServer thread stack size by setting
AC_THREAD_STACK_SIZE. AC_THREAD_STACK_SIZE is both a UNIX
environment variable and a Windows registry entry. The
AC_THREAD_STACK_SIZE value is the thread stack size in kilobytes (KB).
You must restart the Actuate iServer machine after you change the value for
AC_THREAD_STACK_SIZE. On HP-UX and AIX platforms, Actuate iServer
sets the default thread stack size to 1024KB, which is 1 megabyte (MB).

About Actuate iServer ports

Actuate iServer uses ports to communicate with Actuate iServer processes,
Actuate iServer nodes in an Actuate iServer cluster, and with applications such
as web servers and application servers.

Chapter 2, Setting up Actuate iSer ver System hardware 35

 During installation, you specify the ports Actuate iServer uses to communicate
with:
■ Other applications
■ Actuate Process Manager
You can change the ports that Actuate iServer uses by setting parameters using
the System Administration console in Actuate Management Console. For
information about the ports Actuate iServer uses and changing the ports, see
“Understanding Actuate iServer ports” in Chapter 5, “Actuate iServer System
administration overview.”
Actuate Active Portal and Actuate Management Console use parameters that
specify Actuate iServer ports. If you change the Actuate iServer ports, ensure
that the new parameter values work with Actuate Active Portal and Actuate
Management Console applications that connect to Actuate iServer. If
necessary, change the parameter values in Actuate Active Portal and Actuate
Management Console applications that access Actuate iServer. For
information about changing Actuate Active Portal and Actuate Management
Console parameter values, see Chapter 2, “Creating a custom Active Portal for
.NET web site,” in Creating Custom Web Applications using Actuate Active Portal.

About acpmdconfig.xml in Actuate iServer Release 8

Some elements of acpmdconfig.xml in Actuate iServer Release 8 differ from
previous releases. The Actuate iServer installation updates an existing
acpmdconfig.xml file for use with Actuate iServer Release 8. The following
example lines are from a Release 7 acpmdconfig.xml file:
<PMDConfig>
...
<!-- MC information -->
<ManagementConsole>
<Startup>Auto</Startup>
<JavaHome>C:\Program Files\Common Files\Actuate\7.0\JDK131</
JavaHome>
</ManagementConsole>
</PMDConfig>
The installation changes ManagementConsole to ServletContainer in the
Release 8 acpmdconfig.xml file. The following example lines are from a
Release 8 acpmdconfig.xml file:
<PMDConfig>
...
<!-- ServletContainer information -->
< ServletContainer >
<Startup>Auto</Startup>

36 Administering Actuate iServer System

 <JavaHome>C:\Program Files\Common Files\Actuate\8.0\JDK131</
JavaHome>
</ ServletContainer >
</PMDConfig>

Controlling Process Manager connections

Actuate Management Console communicates with Actuate Process Manager
using SOAP connections. By default, the maximum number of connections
Actuate Process Manager handles is 50. To increase the maximum number of
Process Manager connections, add the MaxSoapEndpointThreads parameter
in the acpmdconfig.xml file and restart Process Manager. The parameter is a
child element of the PMDConfig element. The following example sets the
maximum number of connections to 100:
<PMDConfig>
…
<MaxSoapEndpointThreads >100</MaxSoapEndpointThreads >
…
</PMDConfig>

Specifying a database configuration file

An Actuate configuration file provides database connections and data sources
that Actuate reports use. To specify a configuration file using Actuate iServer,
specify a value for the Set the Configuration File For Connections parameter.
For information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”
On Windows server operating systems, the Configuration File for Connections
parameter can specify a path and file name or a URL. For example:
\\server1\configs\serverconfig.xml
or:
http://myserver/configs/testconfig.xml
On UNIX platforms, the parameter’s value can be a path and file name. The
parameter value cannot be a URL.
If you do not specify a value for the Configuration File for Connections
parameter, Actuate iServer uses the database connection properties of the
report object executable (.rox) file.
In the configuration file, Actuate iServer uses only valid ConnectOptions
values. The other values in the file apply to Actuate Desktop products. Actuate
iServer ignores those values.

Chapter 2, Setting up Actuate iSer ver System hardware 37

 For the ConnectOptions values, the Factory process reads the configuration file
when the process starts. Factory processes that are running when you change
the configuration file do not use the new information. Only Factory processes
that start after the configuration file changes use the new information. To
ensure that report executable files use updated configuration file information,
confirm that no reports are active and stop currently running Factory processes
before you change the configuration file. After you change the file, Actuate
iServer starts a Factory process for the next report request.

Specifying a global search path

Set the Global Search Path for Files used in Report Design parameter for
Actuate Basic reports that contain references to external files such as libraries
or images. The Global Search Path for Files used in Report Design parameter
specifies which directories Actuate iServer searches for external files. For
information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server,” and Chapter 14, “Setting
Actuate iServer parameters.”
On Microsoft Windows server operating systems, the value of the Global
Search Path for Files used in Report Design 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 the following
parameter value:
C:\Web\Report\Images;C:\Web\Images
On UNIX platforms, the value of the Global Search Path for Files used in
Report Design parameter is a colon-separated list of directory paths. For
example, add the following line to set the image search path to /web/report/
images and /web/images:
/web/report/images:/web/images

Controlling Excel data output from Actuate Basic files

Actuate report developers who use Actuate e.Report Designer or Actuate
e.Report Designer Professional can create Actuate report object executable
(.rox) files that send report data to a Microsoft Excel file. When you run the
Actuate Basic report from an Encyclopedia volume, you can specify
parameters to control:
■ Excel data output directory
■ Excel font usage

38 Administering Actuate iServer System

Changing the Excel data output directory for an Actuate Basic file
When you run an Actuate Basic report from an Encyclopedia volume,
directing the data output to a Microsoft Excel file, Actuate iServer sends the
output file to the Excel directory in the Actuate iServer home directory. The
Actuate iServer installation creates the default Excel directory. For example:
C:\Program Files\Actuate8\iServer\Excel
To change the location to which Actuate iServer sends the Excel file, use the
Actuate iServer Output Directory for Runtime-generated Excel parameter. Use
a fully-qualified path to the directory as the parameter value.
For more information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”

Controlling how Actuate iServer searches for fonts used with an

Actuate Basic report that generates Excel data
When you run a report that generates Excel data, Actuate iServer uses font
information from the report executable file and from customized_fonts.rox or
master_fonts.rox. For information about how Actuate iServer uses
customized_fonts.rox and master_fonts.rox and searches for font information,
see “Configuring Actuate iServer to search for fonts for an Actuate Basic
report,” later in this chapter.

Starting Actuate iServer on UNIX when you reboot

To start Actuate iServer 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 Actuate iServer
whenever the system restarts.

Controlling stand-alone Actuate iServer startup

You can specify whether Actuate Process Manager starts Actuate iServer after
Process Manager starts:
■ To start Actuate iServer when Process Manager starts, set the Startup
parameter to Auto. To set up Actuate iServer to restart when you restart the
Actuate iServer machine:
■ Configure the Actuate iServer machine to start Actuate Process
Manager at startup.
■ Set the Startup parameter to Auto.
■ To prevent Process Manager from starting Actuate iServer when Process
Manager starts, set the Startup parameter to Manual.

Chapter 2, Setting up Actuate iSer ver System hardware 39

 The Startup parameter is a child element of the Server element in
acpmdconfig.xml. The following example configures Actuate iServer to start
after Process Manager starts:
<PMDConfig>
<!--Actuate system Type -->
<System>Standalone</System>
…
<Server
Name="training">
<Startup>Auto</Startup>
</Server>
…
</PMDConfig>

Controlling how stand-alone Actuate iServer restarts

Actuate Process Manager attempts to restart Actuate iServer when it crashes.
The RestartLimit parameter controls the number of times Actuate Process
Manager attempts to restart Actuate iServer. The default number of restart
attempts is 10. The minimum value is 1. If the parameter value is 0 (zero) or an
invalid value, Actuate iServer uses 10, the default value.
To change the number of restart attempts, add the RestartLimit parameter as a
child element of the PMDConfig element in the acpmdconfig.xml file. The
following example sets the restart limit to 5:
<PMDConfig>
<RestartLimit>5</RestartLimit>
…
</PMDConfig>

Starting and stopping Actuate Management Console

Actuate Process Manager controls the startup and shutdown of Actuate
Management Console on the Actuate iServer machine. During Actuate iServer
installation, you can choose to install Actuate Management Console. The
installation process provides startup and shutdown utilities to start and stop
Actuate Management Console. The startup and shutdown utilities, startmc
and stopmc, use Process Manager to start and stop Actuate Management
Console. On Windows systems, the utilities are batch files. On UNIX systems,
the scripts are shell scripts.
To run the Actuate Management Console startup and shutdown utilities,
Actuate Process Manager must be running and you must have access to the
acmanagemc.jar file in the jar directory for Actuate iServer:
■ The default location of the jar file on a Windows system is:
C:\Program Files\Actuate8\Jar

40 Administering Actuate iServer System

■ The default location for the jar file on a UNIX system is the jar directory in
the directory specified by the AC_SERVER_HOME environment variable:
$AC_SERVER_HOME/jar

Controlling how Actuate Management Console restarts

Actuate Process Manager attempts to restart Actuate Management Console
when it crashes. The RestartLimit parameter controls the number of times
Actuate Process Manager attempts to restart Actuate Management Console.
The default number of restart attempts is 10. The minimum value is 1. If the
parameter value is 0 (zero) or an invalid value, Actuate iServer uses 10, the
default value.
To change the number of restart attempts, add the RestartLimit parameter as a
child element of the ServletContainer element in the acpmdconfig.xml file. The
following example sets the restart limit to 5:
<ServletContainer>
<Startup>Auto</Startup>
<RestartLimit>5</RestartLimit>
…
</ServletContainer>

Using automatic disk space checking

When Actuate iServer uses the following parameter values to manage Actuate
iServer System partitions and disk space:
■ Minimum Partition Disk Space Required for File Creation (MB). When the
free disk space in the Encyclopedia volume’s primary partition falls below
this value, Actuate iServer puts the volume offline.
■ Database Log Directory Minimum Space. When the free disk space for the
Encyclopedia volume’s transaction log partition falls below this level,
Actuate iServer puts the volume offline.
■ Fatal DiskSpace Level. Actuate iServer checks this value when it starts. If
the available disk space is lower than the value of this parameter, Actuate
iServer does not start.
■ Warning Threshold for Low Partition Disk Space (MB). When an
Encyclopedia volume user tries to create a file in a partition that has less
free disk space than you specify in the Warning Threshold for Low
Partition Disk Space (MB) parameter, Actuate iServer displays an error. The
default value for this parameter is 512MB.
■ Minimum Partition Disk Space Required for File Creation (MB). If if the
partition space is less than the amount specified in this parameter, file
creation requests fail. The default value for this parameter is 128MB.

Chapter 2, Setting up Actuate iSer ver System hardware 41

 Actuate iServer will not take an Encyclopedia volume online until there is
enough free disk space in the partition. An Encyclopedia volume typically
grows over time. Update the disk space parameter values periodically to
reflect changes in the size of the Encyclopedia volume and to ensure that the
Actuate iServer machine has an adequate amount of free space.
For information about setting the disk space checking parameters, see
“Modifying Actuate iServer parameter values for an Encyclopedia volume” in
Chapter 9, “Working with an Actuate iServer System volume.”

About the Actuate iServer machine’s system time

Actuate iServer uses the Actuate iServer machine’s system time for
performing time-based operations such creating job schedules, running
scheduled jobs, and calculating expiration and wait times. Actuate iServer
handles system-generated daylight savings time changes, but you must stop
Actuate iServer before you change the Actuate iServer machine’s system time.
Changing the Actuate iServer machine’s system time when Actuate iServer is
running can interfere with Actuate iServer operations that require calculations
based on the system time and can affect the interaction of Actuate iServer with
other applications and machines.

Finding the Actuate iServer home directory

Many of the procedures described in this chapter refer to the location
AC_SERVER_HOME, the top-level directory where Actuate iServer software
is installed.

How to find the home directory for Actuate iServer on a UNIX

system
The home directory for Actuate iServer is AC_SERVER_HOME. For example,
if you use the C Shell on UNIX systems, your .cshrc file should contain a line
similar to the following line:
$ setenv AC_SERVER_HOME /usr/local/actuate

How to find the home directory for Actuate iServer on a Windows

system
1 Choose Start➛Run.
2 In Run, type:
regedit.exe
Choose OK.
Registry Editor presents a hierarchical list of Registry keys.

42 Administering Actuate iServer System

3 Under HKEY_LOCAL_MACHINE\Software\Actuate\Actuate iServer\8,
locate the AC_SERVER_HOME entry.
The value of the AC_SERVER_HOME entry is the home directory for
Actuate iServer.

About Actuate iServer temporary files

Actuate iServer creates all server-related temporary files in the
AC_SERVER_HOME\tmp directory. The start scripts for Actuate iServer on a
UNIX system set TMPDIR to $AC_SERVER_HOME/tmp.
Any Actuate iServer operation that creates a temporary file is responsible for
deleting that file. When Actuate iServer restarts, it deletes all files in
AC_SERVER_HOME\tmp, except the files with the .lock file-name extension.
This behavior removes temporary files that remain after the previous Actuate
iServer shutdown.
The default location for temporary reports is also AC_SERVER_HOME\tmp.
If Actuate iServer stops abnormally, Actuate iServer deletes all temporary
report files. If the administrator stops and starts Actuate iServer, Actuate
iServer retains the temporary report files. For example, if an administrator
changes the location of the transient store directory then stops and starts
Actuate iServer, Actuate iServer changes the transient store location and
moves any temporary files to the new location.

Displaying Actuate iServer release information

You can view the Actuate iServer release number on System—Status in
Actuate Management Console and on the Servers page. For information about
System—Status, see “Understanding Actuate iServer status” in Chapter 5,
“Actuate iServer System administration overview.” For information about the
Servers page, see “About server parameters for Actuate iServer System” in
Chapter 7, “Working with an Actuate iServer System server.” The following
procedures describe how to view Actuate iServer release information without
using the System Administration console of Actuate Management Console.

How to view Actuate iServer release information on a Windows

system
1 Using Windows Explorer, navigate to the bin directory for Actuate iServer.
For example, go to:
C:\Program Files\Actuate8\iServer\Bin
2 Right-click one of the Actuate iServer executable files, encycsrvr8.exe or
pmd8.exe, to display the file’s context menu.
3 Choose Properties.

Chapter 2, Setting up Actuate iSer ver System hardware 43

 Properties appears.
4 On Properties, choose Version to display the file’s release information.

How to view the Actuate iServer release information on a UNIX

system
1 Open a command window.
2 Navigate to the bin directory for Actuate iServer. For example, go to:
\Actuate\AcServer\bin
3 Run an Actuate iServer executable file, such as encycsrvr8, using the –v
option. For example:
# encycsrvr8 -v
The version number appears in the command window.

Configuring Actuate iServer processes

When processing report jobs, Actuate iServer starts and stops Factory
processes to generate reports. After a Factory process starts, Actuate iServer
waits two seconds before trying to use the Factory process. After a Factory
process starts, Actuate iServer waits one second between attempts to
communicate with the process. An Actuate iServer in heavy use might require
a longer wait period for a Factory process to start or to reply after starting. You
can adjust the Factory process timing.

Configuring the default locale for the Factory process on a

Windows system
The default locale is C for Actuate iServer on Microsoft Windows server
operating systems. Using C enhances Factory process performance. To change
the default locale to ENU, set the value of the Use C Locale as Default on NT
parameter to FALSE. The value of this parameter is either TRUE or FALSE. For
information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.” For information about
working with locales, see Working with Multiple Locales.

Configuring the Factory process to search for Actuate

Basic report fonts
The Actuate iServer Factory process uses a report object executable (.rox) file’s
font information to format the data in the resulting report object instance (.roi)
file. By default, Actuate iServer uses font information only from the executable
file. When a report object executable (.rox) file contains a dynamic text control,

44 Administering Actuate iServer System

Actuate iServer supports using font information from customized_fonts.rox or
master_fonts.rox.
A dynamic text control contains variable-length text. The test can be in HTML,
RTF, or plain text format. Actuate iServer can use the HTML or RTF
information to format the data in a report document. The HTML or RTF
formatting information can contain font information that is not stored in the
report object executable (.rox) file. If font information is not in the report object
executable (.rox) file, Actuate iServer searches customized_fonts.rox and
master_fonts.rox to locate the font information. For information about how
Actuate iServer uses customized_fonts.rox and master_fonts.rox and searches
for font information, see “Configuring Actuate iServer to search for fonts for
an Actuate Basic report,” later in this chapter. For more information about
using the dynamic text control, see Chapter 10, “Working with a dynamic text
control,” in Developing Actuate Basic Reports, which ships with e.Report
Designer Professional.

Configuring a Factory process resource group

A resource group controls the Factory processes an Actuate iServer cluster
uses to run an synchronous or asynchronous job to create or print report
output. A resource group specifies a set of Factory processes in a cluster that
only execute jobs assigned to the resource group.
To control how Actuate iServer System uses Factory processes, you create and
manage resource groups using the System Administration console of Actuate
Management Console. For information about managing Actuate iServer
resource groups, see “About resource groups” in Chapter 10, “Adding and
configuring an Actuate iServer System resource group.”

Configuring View process to search for Actuate Basic

report fonts
Actuate Active Portal, Actuate Management Console, and Actuate ReportCast
use the View process to display report object instance (.roi) files in a browser.
The View process can display reports in various formats including DHTML
and PDF. To format and display report data, the View process uses font
information from a report document’s report object executable (.rox) file and
from customized_fonts.rox or master_fonts.rox. For information about how
the Actuate iServer uses customized_fonts.rox and master_fonts.rox and
searches for font information, see “Configuring Actuate iServer to search for
fonts for an Actuate Basic report,” later in this chapter.

Disabling job notices in an Encyclopedia volume

If a report generation job does not generate a notice that appears for a channel,
you can disable the notice appearing on Jobs—Completed in the Volume
Administration console of Actuate Management Console.

Chapter 2, Setting up Actuate iSer ver System hardware 45

 To prevent a notice from appearing on Jobs—Completed, you must prevent
the notice from going to an Encyclopedia volume users’ personal channel or to
any other channel in the volume. For information about working with users’
personal channels and setting notification options, see “Managing users,
privileges, and security roles” in Chapter 16, “Managing Encyclopedia volume
security.” For information about Encyclopedia volume channels, see “About
channels” in Chapter 17, “Administering channels and notification groups.”
Use the following parameters to disable the display of job notices on Jobs—
Completed for jobs that do not send a notice to a channel:
■ DisableFailureJobs disables failed job notices appearing on Jobs—
Completed.
■ DisableSuccessJobs disables successful job notices appearing on Jobs—
Completed.
DisableFailureJobs and DisableSuccessJobs are attributes of the Volume
element in the Actuate iServer acserverconfig.xml file. Set the value of an
attribute to true to prevent the notice from appearing on Jobs—Completed.
The following example disables both failed and completed job notices for the
Encyclopedia volume called training:
<Volumes>
<Volume
Name="training"
PrimaryServer="training"
PrimaryPartition="DefaultPartition"
TransLogPartition="DefaultPartition"
DisableFailureJobs="true"
DisableSuccessJobs="true">
...
</Volumes>

Configuring Actuate iServer to use a report

generation option
Actuate supports the following Actuate iServer System options for generating
reports:
■ If you license and enable the Actuate Analytics Option, Actuate iServer
provides a run-time environment for the execution of Actuate cube profiles
you develop using Actuate Analytics Cube Designer.
■ If you license and enable the Actuate e.Report Option, Actuate iServer
provides a run-time environment for the execution of reports you develop
using Actuate e.Report Designer Professional, e.Report Designer, or
Formula One e.Report Designer.

46 Administering Actuate iServer System

■ If you license and enable the Actuate e.Spreadsheet Option, Actuate iServer
provides a run-time environment for the execution of reports you develop
using Actuate e.Spreadsheet Designer.
For information about other Actuate iServer System options, see Chapter 1,
“Actuate iServer architecture overview.”
The following topics contain additional information about configuring
Actuate iServer to use a report generation option.

Accessing Actuate-specific Java files for report

generation
To generate some reports, Actuate iServer requires access to the Actuate-
specific Java files that are in the Actuate jar directory. The default location for
the jar file on a Windows system is:
C:\Program Files\Actuate8\Jar
The default location for the jar file on a UNIX system is the jar directory in the
directory specified by the AC_SERVER_HOME environment variable:
$AC_SERVER_HOME/jar

Specifying the maximum heap size for the JVM that

Actuate iServer uses
The Maximum Heap Size for Java Virtual Machine parameter controls the
heap size of the Java virtual machine (JVM) that Actuate iServer uses. The
default value of 0 means that Actuate iServer uses the default heap size for the
JVM. The Maximum Heap Size for Java Virtual Machine parameter is an
advanced Actuate iServer parameter. For information about setting advanced
Actuate iServer parameters, see “Changing advanced Actuate iServer
parameter values” in Chapter 7, “Working with an Actuate iServer System
server.”

Using a JRE with Actuate iServer

Actuate iServer uses Java files in the Java Software Development Kit (SDK)
and the Java Runtime Environment (JRE) in the Java SDK. Actuate iServer
installs Java SDK Release 1.4.1, except on the following operating systems:
■ SunOS 2.6 does not support JRE 1.4.1. Actuate iServer installs SDK 1.3.1.
■ IBM AIX 4.3.3 does not support JRE 1.4.1. Actuate iServer installs SDK
1.3.1.
Some operating systems require an operating system upgrade or patch to use
JRE 1.4.1. For information about requirements for your operating system, see

Chapter 2, Setting up Actuate iSer ver System hardware 47

 your operating system documentation. Also, see the Actuate Supported Products
and Obsolescence Policy at the following URL:
http://support.actuate.com/es/products/supportedprod.asp

About the default Java SDK installation directories

The Actuate iServer installation routine installs the Java SDK files in the
following locations:
■ On a Windows system, the default installation location is:
C:\Program Files\Common Files\Actuate\8.0\JDK141
■ On a UNIX system, the default installation location is the JDK141 directory
under the directory specified in the AC_SERVER_HOME environment
variable:
$AC_SERVER_HOME/JDK141

Changing the JRE that Actuate iServer uses

To use a different JRE with Actuate iServer, change the JRE files in the
installation directory or change the values of the following Windows Registry
entries or UNIX environment variables:
■ On a Windows system, change the following Registry entries:
■ AC_JAVA_HOME
■ AC_JVM_HOME
■ AC_JRE_HOME in the Registry key HKEY_LOCAL_MACHINE\
SOFTWARE\Actuate\Common\8.0
■ On a UNIX system, change the following environment variables:
■ AC_JAVA_HOME
■ AC_JVM_HOME
■ AC_JRE_HOME in the PMD startup script
Using an earlier release of JRE can cause some Actuate features to fail or to
work improperly. For example, using an earlier release of JRE can cause
Actuate products to display Actuate report charts incorrectly.

About AC_JRE_HOME and AC_JVM_HOME

The following types of Actuate reports use AC_JRE_HOME and
AC_JVM_HOME:
■ Formula One report (.jod) files use AC_JRE_HOME to locate java.exe.
■ Actuate report object executable (.rox) files that contain charts use
AC_JVM_HOME to locate the java.exe to generate the chart.

48 Administering Actuate iServer System

■ Actuate report object executable (.rox) files that uses the Actuate Java
Object Interface use AC_JVM_HOME to locate the JVM DLL or library.
■ Actuate report object executable (.rox) files that connect to an SAP data
source use AC_JVM_HOME to locate the JVM DLL or library.

Configuring Actuate iServer System to use Actuate

e.Spreadsheet Option
To publish an Actuate e.Spreadsheet Designer file, you must license and
enable Actuate e.Spreadsheet Option for Actuate iServer System.
e.Spreadsheet Option is available for Actuate iServer on both Windows and
UNIX operating systems. Actuate iServer Release 5 Service Pack 2 or later
supports Actuate e.Spreadsheet Option. For more information about Actuate
iServer System options, see “Understanding the Actuate iServer System
options” in Chapter 1, “Actuate iServer architecture overview.”
To use Actuate e.Spreadsheet Option, you must have J2SE (Java 2 Standard
Edition) version 1.4.1 or later.
To use an external database driver or JAR file with a spreadsheet report, the
e.Spreadsheet Designer report developer must configure e.Spreadsheet
Designer to address the file. The system administrator must also configure
e.Spreadsheet Option to address the file on the Actuate iServer machine. For
example, if the spreadsheet report accesses external data using Java database
connectivity (JDBC), the administrator must configure the Actuate iServer
environment to access the JDBC driver.
For information about configuring e.Spreadsheet Designer, see Designing
Spreadsheet Reports. For information about configuring server parameters for
e.Spreadsheet Option, see Programming Spreadsheet Reports.

Using a database driver in a spreadsheet report

If a spreadsheet report requires access to a database driver, copy the driver file
to $AC_SERVER_HOME\Espreadsheet\Extensions. For example, to use the
Oracle JDBC driver Classes12.zip on a Windows system, copy Classes12.zip to
the Extensions directory for Actuate iServer:
C:\Program Files\Actuate8\iServer\Espreadsheet\Extensions
For information about using database information in an e.Spreadsheet
Designer report, see Designing Spreadsheet Reports.

Using a JAR file in a spreadsheet report

If a spreadsheet report requires access to a JAR file, copy the file to
$AC_SERVER_HOME\Espreadsheet\Extensions. Callback classes and add-in
function classes must conform to the e.Spreadsheet API requirements. For a
spreadsheet report that uses e.Spreadsheet API callback classes, add the fully

Chapter 2, Setting up Actuate iSer ver System hardware 49

 qualified class name of the Java class implementing BookModelCallback
interface to the e.Spreadsheet parameter AC_SS_POPULATION_CLASS.
For information about using callback classes and addin function classes with
e.Spreadsheet Designer and information about configuring server parameters
for e.Spreadsheet Designer, see Programming Spreadsheet Reports. For
information about open server parameters for Actuate e.Spreadsheet Option,
see “Administering spreadsheet reports,” in Chapter 21, “Understanding
Actuate iServer options.”

Configuring Actuate iServer System to use e.Report

Option for a Formula One report
To work with a Formula One report using Actuate iServer System, you must
license and enable Actuate e.Report Option. For information about working
with Formula One reports in an Encyclopedia volume, see “Administering
Formula One reports” in Chapter 21, “Understanding Actuate iServer
options.”
You must also install a JDK. The recommended JDK for running Formula One
reports using Actuate iServer System is Java 2 Standard Edition (J2SE) JDK
1.4.2.

Configuring environment variables for running Formula One

reports
You must complete the following configuration tasks to run Formula One
reports using Actuate iServer System:
■ Ensure that CLASSPATH includes %jre_home%\lib\rt.jar and the current
directory, a period. For example, on a Windows system, the CLASSPATH
environment variable must contain the following information:
%jre_home%\lib\rt.jar;
The default jre_home directory for Java Development Kit (JDK) version
1.4.1_02 on a Windows system is C:\Program Files\Java\j2re1.4.1_02
\bin.
■ On a Windows server, PATH must include the directory containing the
jvm.dll installed with JRE version 1.2.2 or later. The path can be similar to
the following example, where x and y are version numbers:
C:\jdk1.x.y\jre\bin\classic
■ On a UNIX server, the Java Virtual Machine (JVM) is libjvm.so for Solaris,
libjvm.sl for HP-UX, and libjvm.a for AIX. You must specify which
directory contains the JVM in the following environment variables:
■ LD_LIBRARY_PATH for Sun SOLARIS 2.x
■ LIBPATH for IBM AIX 4.3.3.0

50 Administering Actuate iServer System

 ■ SHLIB_PATH for HP-UX
■ On a UNIX server, if you did not specify the JDK path during the Actuate
iServer installation, set CLASSPATH, PATH, and library path environment
variables in the startup script start_srvr.sh.
In an Encyclopedia volume, a Formula One report supports using parameters
to specify items such as the location of libraries not specified in CLASSPATH.
For more information about using Formula One reports in an Encyclopedia
volume, see “Administering Formula One reports” in Chapter 21,
“Understanding Actuate iServer options.”

About fonts in Formula One reports

To ensure that report output from a Formula One report uses the correct fonts,
verify that the Actuate iServer environment accesses the same TrueType Font
(TTF) and TrueType Collection (TTC) files as the report design environment. If
no mapping exists for a particular font, or if the corresponding font file does
not exist, Actuate iServer uses Arial instead of the font the Formula One report
file specifies.
Actuate iServer uses a text file, ACJFontLocator.properties in
$AC_SERVER_HOME/servletcontainer/f1ereosi/WEB-INF/lib, to determine
which directories contain the TrueType Font files that describe the font metrics
of fonts that appear in a report. For more information about
ACJFontLocator.properties, see Chapter 3, “Generating a report document,” in
Programming Formula One Reporting Applications.

Configuring Actuate iServer to use a JVM with a Formula One

report
When running or viewing an Formula One report, Actuate iServer supports
access to Java objects through the Java Native Interface (JNI). Reports access
Java objects from Actuate Basic to create Java objects, invoke methods, and
access variables. To use Java, Actuate iServer must access a Java Virtual
Machine (JVM). Actuate iServer searches the Actuate iServer machine’s file
system for a JVM:
■ On a Windows system, Actuate iServer searches for the JVM using the
following registry keys and environment variable:
■ HKEY_LOCAL_MACHINE\SOFTWARE\Actuate\Common\8.0
\AC_JVM_HOME
■ HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime
Environment\1.3\RuntimeLib
■ HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Development
Kit\1.3\JavaHome

Chapter 2, Setting up Actuate iSer ver System hardware 51

 ■ HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime
Environment\1.2\RuntimeLib
■ HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Development
Kit\1.2\JavaHome
■ The first JVM in the PATH environment variable
■ On a UNIX system, Actuate iServer searches for the JVM using the library
path environment variable for the Actuate iServer machine. The following
paths are the library paths for UNIX systems:
■ LD_LIBRARY_PATH (SunOS)
■ LIBPATH (AIX)
■ SHLIB_PATH (HP-UX)

Configuring open server

When generating or printing an open server report, Actuate iServer looks in
the \Drivers directory for Actuate iServer and the directories specified in the
operating system’s shared library environment variable to locate shared
libraries:
■ On Microsoft Windows server operating systems, Actuate iServer uses the
PATH variable. For the default installation, Actuate iServer also looks in
the following directory:
C:\Program Files\Actuate8\iServer\Drivers
■ On UNIX the open server driver uses the paths specified in the following
environment variables and looks in $AC_SERVER_HOME\drivers:
■ LD_LIBRARY_PATH (SunOS)
■ LIBPATH (AIX)
■ SHLIB_PATH (HP-UX)
You can 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 \Drivers
directory for Actuate iServer. If you specify a path for an open server driver,
the path is relative to the \Drivers directory for Actuate iServer. In an Actuate
iServer cluster, the open server driver and third-party software must be
available and executable from any Actuate iServer node.
To run SQRIBE and Crystal open server reports using Actuate iServer running
from a non-administrator Windows account, set the Inherits the Desktop and
Window Station parameter to true for Actuate iServer. For more information
about running Actuate iServer from a non-administrator account, see
“Running reports using a non-administrator account on a Windows system,”
earlier in this chapter.

52 Administering Actuate iServer System

Configuring open server for SQRIBE on a Windows
machine
Using open server SQRIBE reports with Actuate iServer on a Windows
machine requires the SQRIBE client. The Actuate open server driver for
SQRIBE reports, Acsqrdrv.exe, uses the SQRIBE client software and some
specific SQRIBE DLL files.

Making SQRIBE drivers available to Actuate iServer

DLL files for the SQRIBE client software install in \SQRIBE\Sqr\Odb\Binw.
To ensure that Actuate iServer can access the DLLs, either add the directory to
the PATH or copy the following SQRIBE DLLs to the Drivers directory for
Actuate iServer:
■ Stimages.dll
■ Sqrwt.dll
■ Libsti32.dll
■ Bclw32.dll

About Actuate open server files for SQRIBE reports

Actuate iServer uses the following Actuate open server files that are in the
Drivers directory:
■ Acsqrdrv.exe
■ Sqrext.dll

Printing SQRIBE open server reports

Using the SQRIBE interface, an open server driver cannot redirect output to
different printers. The default printer for the Actuate iServer machine prints
the report. To print an SPF file, Actuate iServer assumes that the Sqrwp.exe
program is in the following location:
C:\SQRIBE\Sqr\ODB\Binw\Sqrwp.exe
You can set the SQRIBE_SQRWP_PATH parameter to specify a different path.
In most cases, this parameter can be set as a file-type parameter for
Encyclopedia volume’s .spf file-type definition.

Configuring open server for Crystal Reports on a

Windows machine
To work with open server Crystal reports using Actuate iServer System on a
Windows machine, you must install the Crystal Reports client product.

Chapter 2, Setting up Actuate iSer ver System hardware 53

 For a list of supported products, see the Actuate Supported Products and
Obsolescence Policy at the following URL:
http://support.actuate.com/es/products/supportedprod.asp

About the open server driver for Crystal Reports

Actuate iServer uses the Crystal Reports client software and the following
Actuate open server driver, located in the Drivers directory for Actuate
iServer:
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,
Crystal Reports 8, or Crystal Reports 9 installation. To use the Crystal Report
Engine, you need to install the appropriate Crystal Reports files, including
required run-time files, database files, export files, and library files. For
information about the Crystal Report Engine and its use, see the Crystal
Reports documentation.

Printing Crystal Reports open server reports

When you print a Crystal open server report, the default printer for the
Actuate iServer machine prints the report. Use the AC_PRINTER_NAME
parameter to specify a different printer name. Supply the parameter value as
an open server file type system parameter. The specified printer must be
available to the Actuate iServer machine. The open server driver also uses the
Number of Copies parameter.
For information about creating an open server file type system parameter in
the Encyclopedia volume, see “Specifying open server file types” in Chapter
21, “Understanding Actuate iServer options.”

Configuring the Actuate iServer locale

Actuate iServer System obtains its locale information from its locale map,
localemap.xml. The locale map file resides in $AC_SERVER_HOME/etc/. In
an Actuate iServer cluster, the same file must reside on every Actuate iServer
machine to achieve consistency among Actuate iServer nodes.
Actuate ships a default locale map file that includes all supported locales and a
default locale. Values in the default locale correspond to those in the C locale.
localemap.xml 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. A
custom locale can use different naming conventions, but the locale names and
the use of format characters in predefined locales follow ICU standards. For
example, predefined locales use the character m for month.

54 Administering Actuate iServer System

If you update localemap.xml, restart the Actuate iServer nodes for the changes
to take effect. You must also ensure that localemap.xml uses the correct
encoding and that you store localemap.xml in the correct locations.
A locale definition in localemap.xml does not necessarily specify a value for
every field. For a field with no specified value, Actuate uses the default
locale’s value for that field. If no default locale exists in the file, Actuate uses a
hard-coded value from the C locale.
For more information about localemap.xml, see Chapter 2, “Formatting
Actuate Basic report data for multiple locales,” in Working with Multiple
Locales.

Configuring year conversion for Actuate Basic

reports
When Actuate iServer generates a report, it converts two-digit year values to
four-digit years when the two-digit values appear in a job schedule in the
Encyclopedia volume, in Actuate Basic functions, or in a QBE expression. For
example, if a user types date 01/01/14 in a QBE expression, Actuate converts
the date to 2014-01-01. For more information about how Actuate iServer
System converts two-digit years to four-digit years, see Accessing Data.
You can control how Actuate interprets two-digit years by setting the value of
the Actuate iServer CenturyBreak parameter. To determine whether to set the
parameter, see your Actuate report developer. For information about setting
advanced Actuate iServer parameters, see “Changing advanced Actuate
iServer parameter values” in Chapter 7, “Working with an Actuate iServer
System server.”

Setting up e-mail notification

The following topics describe how to set up e-mail notification on machines
that run Windows server operating systems and UNIX. They also explain how
to work with the Actuate iServer e-mail notification message.
■ About Actuate iServer System e-mail notification
■ Understanding Actuate iServer e-mail notification configuration
■ Setting up Actuate iServer e-mail notification using SMTP
■ Setting up Actuate iServer e-mail notification using Microsoft Exchange
■ Setting up Actuate iServer e-mail notification on a UNIX machine using
sendmail
■ About the Actuate iServer e-mail notice
■ Setting the URL prefix for e-mail notification
■ Customizing the e-mail notice

Chapter 2, Setting up Actuate iSer ver System hardware 55

 To ensure that users receive e-mail notification, you must register their
addresses in an Encyclopedia volume using Actuate Management Console.
Attempts by Actuate iServer to send e-mail to an improperly registered
address fail, and the unsent e-mail returns to the mailbox of the Actuate
iServer e-mail account. To check for such errors, log in to the account that runs
Actuate iServer and look for returned e-mail.
For more information about creating and modifying an Encyclopedia volume
user account, see “Managing users, privileges, and security roles” in Chapter
16, “Managing Encyclopedia volume security.”

About Actuate iServer System e-mail notification

Actuate iServer supports the following e-mail notification options:
■ Sending e-mail notices using SMTP (Simple Mail Transfer Protocol)
■ Sending e-mail notices using Microsoft Exchange MAPI and UNIX
sendmail
■ Sending e-mail notices with attachments
■ Customizing the text in the e-mail notification message

Understanding Actuate iServer e-mail notification

configuration
The default Actuate iServer e-mail notification configuration uses Microsoft
Exchange MAPI and the UNIX sendmail client. When you use e-mail
notification, you must use one of the following configurations:
■ Exchange MAPI on Windows Actuate iServer nodes and sendmail on
UNIX Actuate iServer nodes
■ SMTP on all Actuate iServer nodes
Actuate iServer must have the View service enabled to send e-mail notices.
Configure Actuate iServer and the Actuate iServer machine to use the e-mail
service. In a stand-alone configuration, Actuate iServer sends e-mail notices
from the Actuate iServer machine. In an Actuate iServer cluster, Actuate
iServer distributes e-mail notification requests among the Actuate iServer
nodes that have the View service enabled.

Setting up Actuate iServer e-mail notification using SMTP

To set up e-mail notification using SMTP, specify the STMP mail servers an
Actuate iServer machine uses. To send e-mail notices, Actuate iServer nodes
that have the View service enabled must be able to access the SMTP mail
servers. For information about configuring the SMTP servers Actuate iServer

56 Administering Actuate iServer System

uses, see “Managing Actuate iServer e-mail notification” in Chapter 6,
“Working with system-wide Actuate iServer parameters.”

Setting up Actuate iServer e-mail notification using

Microsoft Exchange
When Actuate iServer on a Windows system uses Microsoft Exchange to send
e-mail notices, it sends all e-mail notices from an e-mail account. To use an e-
mail account, you must register an e-mail account with each Actuate iServer
node that has the View service enabled.
You must install Windows messaging on the Actuate iServer machine, and
Actuate iServer must use a Microsoft Exchange profile. You must set up an
Exchange profile before you register the Actuate iServer e-mail account. Use
Mail in the Control Panel folder to create a profile. For more information about
profiles, see the Microsoft Exchange documentation. For more information
about installing and configuring Windows messaging and creating an
Exchange profile, see the relevant Microsoft documentation.
Start Actuate Process Management Daemon service using the e-mail account
for Actuate iServer. For example, the e-mail account for Actuate iServer is
ActuateMail in the Postoff domain, and the Actuate iServer user account on
the local machine is ActuServer. If you install Actuate iServer using the local
machine’s user account, ActuServer, change the Actuate Process Management
Daemon service’s logon account from ActuServer to Postoff\ActuateMail.
After you register the account and restart Actuate iServer, Actuate iServer
sends e-mail messages using standard tools. To test the e-mail configuration,
send a message to a user from the Actuate iServer account.
The following topics provide additional information:
■ About the Actuate iServer e-mail account for Microsoft Exchange
■ Registering the Actuate iServer e-mail account

About the Actuate iServer e-mail account for Microsoft Exchange

To use Microsoft Exchange with Actuate iServer e-mail notification, you must
configure both Actuate iServer and Exchange Server if they are in different
domains. You must set up an Actuate iServer account with these properties:
■ The account running the Actuate Process Management Daemon service
must also be an account on the Microsoft Exchange Server.
■ The account running the Actuate Process Management Daemon service
and the account on the Microsoft Exchange Server must use the same
password.
For example, the Process Management Daemon service is on a machine in the
Marketing domain and is running under the ActuServer account. The

Chapter 2, Setting up Actuate iSer ver System hardware 57

 Exchange Server is on a machine in the Postoff domain. In this scenario, the
machine running the Exchange Server must have an account named
ActuServer and the password must be the same on both machines, as shown
in the following illustration.
Domain Domain
Postoff Marketing

Microsoft Actuate
Exchange Server Server

Account: ActuServer Account: ActuServer

Password: Actuate8 Password: Actuate8

Registering the Actuate iServer e-mail account

After you set up the Actuate iServer e-mail account, you must register the
account. The following procedure describes how to register the Actuate
iServer e-mail account.

How to register the Actuate iServer e-mail account

1 Using the account that runs Actuate iServer, run the mailinst program in
the bin directory for Actuate iServer.
Actuate iServer Email Notification appears, requesting a profile name and
a password, as shown in the following illustration.

2 Provide the profile information:

■ In Profile, select a Microsoft Exchange profile name.
■ In Password, type the password.
Choose OK.
Mailinst registers the e-mail account with the Actuate iServer machine.

58 Administering Actuate iServer System

3 Restart the Actuate iServer machine.
After Actuate iServer restarts, it uses the e-mail profile to send e-mail
notification.

Setting up Actuate iServer e-mail notification on a UNIX

machine using sendmail
When Actuate iServer uses UNIX sendmail, all e-mail notices originate from
the Actuate iServer user account. To send an Actuate iServer e-mail notice
from a UNIX system, ensure that the account that runs the Actuate iServer can
access the sendmail program from each Actuate iServer node that has the View
service enabled. The sendmail program is in /usr/lib/sendmail. To test the e-
mail configuration, send an e-mail message to a user from the Actuate iServer
e-mail account.

How to test e-mail notification

1 Log in to the account that runs Actuate iServer.
2 Send the e-mail message using the following command syntax:
$ /usr/lib/sendmail mail-address < message.txt
where
■ message.txt contains the test message.
■ mail-address is the user’s account name as registered with Actuate
iServer.
3 If the message arrives, the account setup is correct. If the message does not
arrive, perform one or more of the following tasks:
■ Check the e-mail address for typographical errors.
■ Log in to an account other than the account that handles Actuate iServer
e-mail and try sending e-mail to the user.
■ Compare the user’s account name that is registered with your e-mail
program to the account name registered in the Encyclopedia volume.
These two account names must match exactly.
4 If the e-mail does not arrive after you complete the tasks in step 3, and you
continue to have problems sending e-mail from the Actuate iServer
account, contact Actuate support for assistance.

About the Actuate iServer e-mail notice

The default Actuate iServer e-mail notification message contains a URL link to
a completed report in the Encyclopedia volume. You specify the prefix portion
of the URL using Actuate Management Console. For information about

Chapter 2, Setting up Actuate iSer ver System hardware 59

 specifying the URL prefix, see “Setting the URL prefix for e-mail notification,”
later in this chapter.
For more information about the e-mail notice, see “Customizing the e-mail
notice,” later in this chapter.

Setting the URL prefix for e-mail notification

When a user receives an e-mail notice about a completed job, the e-mail
message contains a URL for the completed report. Actuate iServer creates the
URL using the URL prefix you specify on Volume—General in the System
Administration console of Actuate Management Console.
The URL prefix you specify on Volume—General is the portion of the URL that
points to an installation of Actuate Active Portal or ReportCast. For example, if
users type the following URL to access an Encyclopedia volume using Actuate
Actuate Portal, you type that URL as the Actuate Active Portal URL prefix:
http://sales:8700/acweb
For information about customizing the e-mail notice, see “Customizing the e-
mail notice,” later in this chapter.
For more information about Volume—General, see “Modifying Actuate
iServer parameter values for an Encyclopedia volume” in Chapter 9, “Working
with an Actuate iServer System volume.”

Customizing the e-mail notice

You can customize the e-mail message that Actuate iServer sends to notify
users about successful and failed jobs. The e-mail message template file,
acnotification.xml, supports inserting report-related information in the e-mail
message that Actuate iServer sends to users. To customize the e-mail message,
modify the e-mail message template.
For each Encyclopedia volume, the default location for the e-mail message
template is the etc directory for Actuate iServer. You can specify a location for
the e-mail message template on Volumes—Properties—General in the System
Administration console of Actuate Management Console. If Actuate iServer
cannot find acnotification.xml, or the template file contains invalid formatting,
Actuate iServer cannot send e-mail notices. For more information about
specifying a location for the e-mail message template, see “Adding and
configuring an Encyclopedia volume” in Chapter 9, “Working with an Actuate
iServer System volume.”

About the e-mail notice template

The e-mail notice template, acnotification.xml, is an XML file that uses UTF-8
encoding. The file contains the template of the e-mail message Actuate iServer
sends for successful and failed jobs.

60 Administering Actuate iServer System

The default template is:
<?xml version="1.0" encoding="UTF-8"?>
<notificationTemplate xmlns:actu=http://schemas.actuate.com/actuate8
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0">
<successMessage>
<subject>Actuate e. Reporting Server Notification</subject>
<body>
Actuate e. Reporting Server - Report <insert variable="jobType"/
>complete
For Active Portal:
Report: <insert variable="reportLink"/>
If the URL above does not work, copy the entire link and paste it into the
address bar of your web browser, then press Enter or Return.
Completed at: <insert variable="jobCompletion"></insert>
</body>
</successMessage>
<failureMessage>
<subject>Actuate e. Reporting Server Notification</subject>
<body>
Actuate e. Reporting Server - Report <insert variable="jobType"/>
failed.
For Active Portal:
Report: <insert variable="reportLink"/>
If the URL above does not work, copy the entire link and paste it into the
address bar of your web browser, then press Enter or Return.
Completed at: <insert variable="jobCompletion"></insert>
Warning/Error:
<insert variable="jobDetailedStatus"/>
</body>
</failureMessage>
</notificationTemplate>
For information about the template elements and attributes, see the following
section, “About e-mail template elements and attributes.”

Chapter 2, Setting up Actuate iSer ver System hardware 61

 About e-mail template elements and attributes
The following table describes the e-mail template elements, attributes, and
text-encoding restrictions.

E-mail template elements and

attributes Description
notificationTemplate element Required root element of the e-mail
notification template.
version attribute Required notification template
attribute. Specifies the version number
of the notification template file.
failureMessage element Parent element of the subject and body
for an e-mail notice for a failed job.
successMessage element Parent element of the subject and body
elements for an e-mail notice for a
successful job.
subject element Element that specifies the content of
the subject line. The subject content is
plain text. The tag value or content can
include insert elements to display
values related to the job or report.
Use CDATA sections to embed e-mail
body content that is exempt from XML
parsing rules. The insert elements must
be outside of CDATA sections.
body element Element that specifies the content of
the e-mail body. The e-mail body can
be in any format the e-mail client
supports. The body content can
include insert elements.
Use CDATA sections to embed e-mail
body content that is exempt from XML
parsing rules. For example, if you
specify the e-mail body content in
HTML or any other markup language,
the insert elements must be outside of
CDATA sections.

62 Administering Actuate iServer System

E-mail template elements and
attributes Description
email-content-type attribute Optional body element attribute that
specifies the content type of the body
content. When this attribute is not
specified, Actuate iServer sends the e-
mail message body as RTF on
Windows servers using Exchange and
as UTF-8 encoded plain text on UNIX
systems using sendmail.
Use this attribute when you construct
the e-mail message, because the e-mail
protocol requires that you specify the
content type.
The value for this attribute is either
text/plain and text/html.
insert element Optional element that inserts job and
report information in subject and body
message content. The value of the
variable attribute specifies the
information Actuate iServer inserts.
The element must appear outside any
CDATA section used within the
content of body or subject elements.
variable attribute Required insert element attribute.
Specifies the information to insert in
the e-mail subject or body. For
information about the variable values,
see “About the variable attribute
values for e-mail notices,” later in this
chapter.

When you use SMTP for e-mail notification, Actuate iServer encodes the e-
mail message subject and body as described in the following list:
■ Actuate iServer sends UTF-8-encoded subject content in the e-mail
template file using UTF-8 encoding.
■ E-mail body text using text/plain MIME type is sent as plain text with
UTF-8 encoding.
■ E-mail body text using text/html MIME type is sent as HTMP with UTF-8
encoding.

Chapter 2, Setting up Actuate iSer ver System hardware 63

 About the variable attribute values for e-mail notices
The following table describes the valid insert variable values for use in e-mail
notices.

Variable value Description

jobName Job name.
jobSubmitter Job submitter’s user name.
jobStatus Status of job: Completed or Failed.
jobDetailedStatus Detailed status of the job from the job
status page.
jobType Type of job: Execution or Printing.
jobHeadline The job’s headline.
jobCompletion Date and time of job completion.
reportDocumentName Report document name. Available for a
successful job.
reportDocumentVersionName Report document version name.
Available for a successful job.
reportDocumentVersionNumber Report document version number.
Available for a successful job.
reportLink Hyperlink to the report document in
the Encyclopedia volume for a
successful job. For a failed job, the link
accesses the job status page.

The following example uses the insert element’s reportLink variable to display
the URL to the report in the e-mail notice that Actuate iServer sends:
Report: <insert variable="reportLink" />

Using HTML in the e-mail template

To use HTML in the successMessage or failureMessage elements, set the
message’s body email-content-type attribute to text/html:
<body email-content-type=”text/html”>
Enclose the HTML in CDATA sections to exclude the HTML from XML
parsing rules. The insert elements must be outside CDATA sections. The
following example shows a successMessage element with HTML formatting:
<?xml version="1.0" encoding="UTF-8" ?>
<notificationTemplate>
<successMessage>

64 Administering Actuate iServer System

 <subject>
Report Delivery Notification:
<insert variable="jobHeadline"/>
</subject>
<body email-content-type="text/html">
<![CDATA[
<html>
<body>
<h2>
]]>
<insert variable="jobHeadline"/>
<![CDATA[
</h2>
]]>
Version <insert variable="reportDocumentVersionNumber"/>
of report <insert variable="reportDocumentName"/>
is now available online.
<![CDATA[
<a href="
]]>
<insert variable="reportLink"/>
<![CDATA[
">Go to Report</a>
<p>
<table border="2pt;">
<tr><td>Report Submitter: </td><td>
]]>
<insert variable="jobSubmitter"/>
<![CDATA[
</td></tr>
<tr><td>Report Generation Date: </td>
<td>
]]>
<insert variable="jobCompletion"/>
<![CDATA[
</td>
</tr>
</table>
<br><br>
</body>
</html>
]]>
</body>
</successMessage>

Chapter 2, Setting up Actuate iSer ver System hardware 65

 Printing on UNIX
Actuate iServer printing on UNIX systems uses Adobe Type-1 font technology.
For a list of fonts that ship with Actuate iServer, see “Working with fonts,”
later in this chapter.
Actuate iServer for UNIX uses a font configuration file to find fonts installed
on the Actuate iServer machine. The configuration file is in the following
directory:
$AC_SERVER_HOME/operation/print/fonts/fonts.supported
Actuate supplies a utility to install fonts on UNIX systems. For information
about the utility, see “About the UNIX PostScript font utility” in Chapter 13,
“Working with Actuate iServer utilities.”
In Actuate 8, printing on UNIX systems does not support PCL.

About report encoding

A report’s encoding affects printing on UNIX systems. For more information
about report encoding, see Chapter 3, “Understanding Actuate Basic report
encoding,” in Working with Multiple Locales.

Working with fonts

Actuate iServer 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

66 Administering Actuate iServer System

 Times Italic
Times Bold Italic
Frutiger-Roman
Palatino Italic
Johnny-Bold
Actuate iServer installs the preceding fonts and their AFM files on UNIX
systems. Actuate iServer also installs at least one font set of each non-CJK
language that Actuate products support. Non-CJK languages are those
languages other than Chinese, Japanese, and Korean. Each font set consists of
the normal, italic, bold, and bold-italic variations of the font. For non-CJK
languages, Actuate installs a localized version of a font type similar to the
Arial font, including the corresponding AFM and PFA files.
For Chinese, Japanese, and Korean (CJK) languages, Actuate supports the
fonts listed in the following table, but Actuate does not supply the fonts
themselves.

Language Font 1 Font 2

Simplified Chinese SimSun SimHei
Traditional Chinese MingLiu MS Hei
Japanese Mincho Gothic
Korean Batang Dotum

If you add a CJK font to the fonts.supported file, the font name must be in the
native language. The font’s AFM file is required. Actuate iServer does not
embed CJK fonts. This means that you must print the PostScript file using a
printer on which the font is installed.
Actuate iServer can embed non-CJK fonts. If a font is embedded in the output,
the font’s PFA file is required. For example, for a non-CJK font, the UNIX font
name must be the same as the value for the FontName parameter in the PFA
file.

Mapping fonts for charts in Actuate Basic reports

For a chart that appears in a report object instance (.roi) file, a developer can
specify fonts to use 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
available to the Actuate iServer JVM.

Chapter 2, Setting up Actuate iSer ver System hardware 67

 The procedure for making fonts available differs by platform:
■ On Windows systems, install fonts in the standard fonts folder for the
operating system. For example, on Windows NT, from Control Panel, open
Fonts. Choose Fonts and then choose File➛Install new font.
■ On UNIX systems, copy fonts to the $JAVA_HOME/jre/lib/fonts
directory.

Using default fonts for charts

Actuate iServer uses a default font for those chart elements for which the
report developer does not explicitly specify a font. The default font depends
on the locale specified when Actuate iServer generates the chart. The
following table lists default fonts by language. For UNIX and Windows output
to look identical when a chart uses default fonts, the default fonts must be
available to the JVM.

Language Default fonts

Languages other than Chinese, arial.ttf
Japanese, or Korean (non-CJK arialbd.ttf
languages) arialbi.ttf
ariali.ttf
times.ttf
timesbd.ttf
timesbi.ttf
timesi.ttf
Simplified Chinese simsun.ttc
Traditional Chinese mingliu.ttc
Japanese msgothic.ttc
msmincho.ttc
Korean gulim.ttc
batang.ttc

Configuring text for languages in graphs

Reports created using Actuate products from Release 6 or later do not typically
contain a graph control derived from AcGraph class. In later releases, reports
typically use charts, which derive from the AcChart class.
When an Actuate report object instance (.roi) file contains a graph that uses
text with non-Latin1 languages, you must set Actuate iServer 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.

68 Administering Actuate iServer System

The following examples show how to use the Actuate shell script pmd8.sh to
set the LANG variable to Japanese:
■ On Solaris systems, set LANG to ja or japanese.
■ On HP-UX systems, set LANG to ja_JP.eucJP.
■ On AIX systems, set LANG to ja_JP.IBM-eucJP.
In this example, if the report is a Release 5 or earlier report, you must also set
the Actuate iServer default encoding to EUC-JP, the Actuate encoding value
for Japanese.

Configuring Actuate iServer to search for fonts for

an Actuate Basic report
An Actuate report object executable (.rox) file stores information about the
fonts used in an Actuate Basic report object instance (.roi) file. Actuate iServer
can also use font information stored in customized_fonts.rox and
master_fonts.rox. An Actuate iServer System administrator can configure
Actuate iServer to search for font information in the following situations:
■ An Actuate iServer View process displays an Actuate report object instance
(.roi) file in DHTML format or generates a 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 Actuate Basic report fonts,” earlier
in this chapter.
■ Actuate iServer runs an ROX that contains a dynamic text control. For
information about generating reports that contain dynamic text controls,
see “Configuring the Factory process to search for Actuate Basic report
fonts,” earlier in this chapter.
■ An ROX generates Excel data, and the data uses fonts that are not in the
ROX. For information about generating Excel data using an Actuate ROX,
see “Controlling Excel data output from Actuate Basic files,” earlier in this
chapter.

About the font information files for Actuate iServer

The default behavior is for Actuate iServer to use the font information in
customized_fonts.rox and master_fonts.rox. If the font information is not in
customized_fonts.rox or master_fonts.rox, Actuate iServer will search the
report executable file. The master_fonts.rox file that ships with Actuate
includes standard Microsoft Windows fonts.
Report developers create a customized_fonts.rox to be used alone or with
master_fonts.rox. When used alone, the customized_fonts.rox file includes
only the fonts that are not included in report executable files. When used with
master_fonts.rox, the customized_fonts.rox file includes fonts that are not

Chapter 2, Setting up Actuate iSer ver System hardware 69

 included in report executable files and are not in the master_fonts.rox files.
Actuate recommends creating a customized_fonts.rox file and not modifying
master_fonts.rox. To create a customized_fonts.rox file, use Actuate e.Report
Designer Professional or Actuate e.Report Designer.
To use the customized fonts file, place customized_fonts.rox in the
$AC_SERVER_HOME/etc directory. In an Actuate iServer cluster, place
customized_fonts.rox on every Actuate iServer node that has the View service
or Factory service enabled.

Controlling how Actuate iServer searches for font

information
The following table describes the values for the UseExternalizedFonts
parameter. Set this parameter to one of the appropriate values to control how
Actuate iServer searches for font metric information, such as character width
and height.

Value Description
no Do not use externalized fonts. The
View process does not use externalized
fonts. The View process uses the font
information in report object executable
(.rox) file.
primary Look for the font in
customized_fonts.rox and
master_fonts.rox first. If Actuate
iServer cannot locate the font in
customized_fonts.rox or
master_fonts.rox, it looks for the font in
the report object executable (.rox) file.
Primary is the default value.
secondary Look for the font in the ROX first. If
Actuate iServer cannot locate the font
in the ROX, it look for the font in
customized_fonts.rox and
master_fonts.rox.

For more information about setting the UseExternalizedFonts parameter, see

Chapter 4, “Using fonts in Actuate Basic reports with multiple locales,” in
Working with Multiple Locales.

70 Administering Actuate iServer System

About the archive driver
Using Actuate software, a developers can create an archive driver to archive
files in the Encyclopedia volume using external archiving software and
hardware. The archive driver software is an interface between Actuate iServer
and the archiving software and hardware. For information about the archive
driver interface and creating an archive driver, see Chapter 12, “Aging and
archiving Encyclopedia volume items,” in Programming with Actuate iServer
APIs.
To demonstrate how an archive driver works, Actuate iServer includes an
example archive driver in the /examples directory for Actuate iServer. This
example takes files from the Encyclopedia volume and places them in a
directory in the Actuate iServer machine’s native file system. Within the native
file system directory, the archive driver creates a folder hierarchy similar to the
one in the 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.
This section contains the following topics:
■ Installing the example archive driver
■ Understanding the example archive driver

Installing the example archive driver

For information about configuring the Encyclopedia volume to use an archive
driver and for information about setting autoarchive rules for archiving files,
see Chapter 19, “Administering jobs.”
To configure and install the archive driver for a Encyclopedia volume, you
must complete the following tasks:
■ Configure the Encyclopedia volume to use the archive driver. For
information about specifying an archive driver, see “Modifying Actuate
iServer parameter values for an Encyclopedia volume” in Chapter 9,
“Working with an Actuate iServer System volume.”
■ Set AC_ROOT_FOLDER, an environment variable on UNIX and Microsoft
Windows server operating systems. The value of this variable is the
directory on the Actuate iServer machine where the archive driver places
files it removes from the Encyclopedia volume. Set this environment
variable on the Actuate iServer machine that manages the Encyclopedia
volume.
On Microsoft Windows server operating systems, AC_ROOT_FOLDER is a
system environment variable, not a user environment variable.

Chapter 2, Setting up Actuate iSer ver System hardware 71

 ■ For Actuate iServer to use the variables, you must stop and restart Actuate
iServer.

Understanding the example archive driver

When Actuate iServer performs autoarchiving on the Encyclopedia volume,
the example archive driver copies volume files that are marked for archival
before deletion. The archive driver places the files in the folder in the Actuate
iServer machine’s native file system that you specify in AC_ROOT_FOLDER.
The archive driver creates the same directory structure for the files in the
native file system as there is in the Encyclopedia volume. For example, if the
AC_ROOT_FOLDER folder is C:/a1, and the file path name in the
Encyclopedia 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 it archives the files. You can create an archive driver that
saves this information using Actuate iServer Integration Technology.
The example archive driver uses Archive.log as its log file. If a file named
Archive.log exists in the /log directory for Actuate iServer, the archive driver
appends data to the existing file when it archives files. If no log file exists, no
logging occurs. To enable logging, create a file named Archive.log. To disable
logging, either rename or remove the file.
When logging occurs, the log file is opened and closed for each message. You
can immediately see any messages. This behavior also ensures that the most
recent message is in the log file if a crash occurs.

Understanding Actuate iServer CPU binding

Use CPU binding to restrict a process running on a machine to a subset of that
machine’s CPUs. Depending on the operating system and specific system
command, you can restrict other processes from running on the processor to
which you bind a process. On machines with some operating systems, another
process can run on the processor to which you bind a process.
You can bind Actuate iServer processes to a specific set of processors on a
machine running the Windows or Solaris operating system. The default
configuration does not bind Actuate iServer to a set of processors. In the
default configuration, all processors on an Actuate iServer machine count
toward the maximum number of licensed CPUs.
To bind Actuate iServer to a set of processors, bind the Actuate Process
Management Daemon (PMD) to the processors. The Actuate PMD starts all

72 Administering Actuate iServer System

Actuate iServer processes. The processes inherit the binding from the Actuate
PMD.
In an Actuate iServer cluster, Actuate iServer counts only the processors on
nodes that join the Actuate cluster and that run an encycsrvr8 process. Actuate
iServer counts the number of processors on an Actuate iServer machine when
the first encycsrvr8 process starts.

Binding an Actuate iServer to processors on a

Windows machine
On a multiple-CPU machine running the Windows operating system, the
server’s operating system assigns an ID number to each processor. Windows
Task Manager lists the IDs of the available processors. The numbering starts at
0. To bind Actuate iServer to a set of processors, create the following Registry
key:
HKEY_LOCAL_MACHINE\SOFTWARE\ACTUATE\Actuate iServer\8\
AC_PMD_WINDOWS_CPUS
To specify the processors to which to bind Actuate iServer, type a comma-
separated list of integers. For example, to bind Actuate iServer to CPU 0, CPU
3, and CPU 4, set AC_PMD_WINDOWS_CPUS to the following list:
0,3,4
You can verify the CPU binding by checking the Processor Affinity of the
Actuate iServer process using Task Manager.

Binding an Actuate process to a processor

If you bind the Actuate iServer PMD to a subset of CPUs in an Actuate iServer
machine, you can also bind the Encyclopedia, Factory, and View processes to a
specific CPUs. Under some conditions, binding an Actuate process to a
specific CPU can enhance performance. Binding an Actuate process to a CPU
has no affect on the CPU calculations Actuate iServer performs to determine
the maximum number of licensed CPUs.
If you bind a process to a CPU, you must bind the CPU to both the process and
the Actuate iServer PMD. Actuate iServer writes an error to its logs and stops
the process if you bind a process to a CPU that you do not bind to the PMD.
To bind an Actuate iServer process to CPU processors, use the
ProcessorAffinity element in the acserverconfig.xml file for Actuate iServer.
List the IDs for the CPUs to which to bind a process as Item subelements in the
following ProcessorAffinity elements:
■ To bind Encyclopedia processes, specify the CPU IDs in the
ProcessorAffinity element within the Server element.

Chapter 2, Setting up Actuate iSer ver System hardware 73

 ■ To bind View processes, specify the CPU IDs in the ProcessorAffinity
element within the ViewingService element.
■ To bind Factory processes, specify the CPU IDs in the ProcessorAffinity
element within the ReportingService element.
For example, on a 4 CPU machine, the following ProcessorAffinity example
binds View processes to CPU IDs 0 and 2.
<ViewingService
EnableViewingService="true"
<ProcessorAffinity>
<Item>0</Item>
<Item>2</Item>
</ProcessorAffinity>
/>
You must also ensure that you bind the specified CPUs to the PMD for the
Actuate iServer machine.

About processors and hyperthreading

Some Intel processors support hyperthreading. Hyperthreading is a
technology that counts each physical processor as a specific number of logical
processors. The operating system and any programs running on the machine
see the number of logical processors, not the number of physical processors.
When a machine uses hyperthreading, Windows Task Manager lists the logical
processors, not the physical ones. You specify the number of logical process in
the registry entry.
When a machine uses hyperthreading, Actuate iServer calculates the number
of bound processors by dividing the number of bound logical processors by
the number of logical processors for each physical processor. If the result
contains a decimal component, Actuate iServer uses the next highest integer.
For example, Actuate iServer rounds 4.3 to 5.
As another example, a machine has 4 physical processors. With
hyperthreading enabled, each physical processor corresponds to two logical
processors. The machine has the following logical processors available:
■ Physical processor 0 corresponds to logical processors 0 and 1.
■ Physical processor 1 corresponds to logical processors 2 and 3.
■ Physical processor 2 corresponds to logical processors 4 and 5.
■ Physical processor 3 corresponds to logical processors 6 and 7.
If you bind Actuate iServer to the five logical processors 0, 2, 3, 6, and 7,
Actuate iServer calculates the number of bound processors as:
5/2 = 2.5

74 Administering Actuate iServer System

Actuate iServer rounds this number up to determine that you have three
processors bound to Actuate iServer.

Binding Actuate iServer to processors on a Sun

Solaris machine
Actuate iServer System supports single processor binding and processor set
binding on a Solaris machine:
■ With single processor binding, you bind a process to a single processor
using the processor_bind( ) system call or the pbind command.
■ With processor set binding, you bind a process to a group of processors on
a Solaris machine. If you bind a process to multiple processor sets, the sets
must not overlap.
To create a processor set, use the pset_create( ) system call or psrset
command. Then, you can bind a process to the set using the pset_bind( )
system call or the psrset command. The psrset command restricts other
processes from running on the processors to which you bind an Actuate
iServer process.
For more information about processor binding and the processor binding
commands, see your Solaris documentation.

Binding Actuate iServer to processors on an HP-

UX 11i machine
Actuate iServer support processor set binding on an HP-UX machine. With
processor set binding, you bind a process to a group of processors on a
machine. If you bind a process to multiple processor sets, the sets must not
overlap.
The software for creating a processor set runs only on HP-UX 11i or later.
Before you use processor sets, you must install the HP-UX 11i June or later
Quality Pack and download the software to create processor sets from the HP
web site. The software to create processor sets is not installed with HP-UX 11i.
To create a processor set, use the pset_create( ) system call or psrset command.
Then, you can bind a process to the set using the pset_bind( ) system call or the
psrset command.
For more information about processor binding and the processor binding
commands, see your HP-UX documentation.

Chapter 2, Setting up Actuate iSer ver System hardware 75

 Checking Actuate iServer bound processors
Actuate iServer performs the following bound processor checks:
■ The number of processors a cluster uses
■ The set of bound processors

Determining the number of processors an Actuate iServer

System uses
When the PMD starts the first encycsrvr8 process on an Actuate iServer
machine, the PMD determines the number of processors to which Actuate
iServer is bound and stores the list of bound processors. If you change the
Actuate iServer processor binding, Actuate iServer does not recognize the
changes until you shut down all encycsrvr8 processes on the Actuate iServer
machine and restart one of the encycsrvr8 processes.
For example, an Actuate iServer cluster that has a maximum licensed CPU
limit of nine processors consists of two nodes, machine A and machine B. The
machines have the following configuration:
■ Machine A has four processors with no processor binding. All the
processors can run Actuate processes. Actuate iServer manages an
Encyclopedia volume.
■ Machine B has eight processors with Actuate iServer bound to five
processors. There is no encycsrvr8 process running on the machine, only
the PMD.
The Actuate iServer cluster counts four processors, the processors on machine
A. If you start an encycsrvr8 process on machine B, Actuate iServer on
machine A counts the five bound processors on the machine and increases the
cluster processor count to nine, four on machine A and five on machine B.
If bind the PMD on machine B to six processors, the change has no effect until
you shut down all the running encycsrvr8 processes on machine B and restart
an encycsrvr8 process on machine B.
After you stop the encycsrvr8 processes and restart an encycsrvr8 process on
machine B, Actuate iServer System detects that the number of processors in
the cluster is ten, which is greater than maximum number of nine licensed
processors. When the number of CPUs exceeds the number of CPUs your
license permits, Actuate iServer does not start and returns an error message to
Actuate Management Console.

76 Administering Actuate iServer System

Understanding how Actuate iServer validates CPU binding
while running
When Actuate iServer is running, each encycsrvr8 process periodically
compares the list of processors to which it is bound with the list to which it
was bound when it started. If the lists differ:
■ Actuate iServer writes a message with the processor information to the log
file. The message contains the maximum number of processors the Actuate
iServer license file permits and the following information:
■ Current and original number of bound processors
■ Current and original list of bound processors
■ If configured, Actuate iServer sends an e-mail message to the
administrator. The message states that the Actuate iServer System will shut
down in one hour if the list of bound processors is not corrected. The e-mail
message contains the information that Actuate iServer sends to the log file.
You must rebind the encycsrvr8 process to the same processors to which it was
originally bound.
During the next hour, any attempt to use the encycsrvr8 services fails and a
message is written to the appropriate log file. If the list of processors is not
restored after an hour, each Actuate iServer in the cluster shuts down and
writes an error to its log file.

Understanding how Actuate iServer validates CPU binding

when taking an Encyclopedia volume online
Actuate iServer uses a separate encycsrvr8 process to manage each
Encyclopedia volume on an Actuate iServer machine. When you take an
Encyclopedia volume online, the PMD starts an encycsrvr8 process. When the
PMD starts an encycsrvr8 process, the PMD compares the list of processors to
which the encycsrvr8 process is bound to the original list of processors to
which the PMD is bound. If the lists differ:
■ The encycsrvr8 process writes an error to its log file and shuts down.
■ Actuate iServer does not take the volume online. A message in Actuate
Management Console states that the binding of the new process differs
from the original binding of the parent process.

Understanding how Actuate iServer validates CPU binding

when running Factory and View processes
Each Factory and View process periodically compares its list of bound
processors with the list of processors to which it was bound at startup. If the
lists differ, the process writes an error to its log file and shuts down.

Chapter 2, Setting up Actuate iSer ver System hardware 77

 Configuring e-mail for CPU license problems
Actuate iServer System supports sending an e-mail message to an
administrator if a change in processor binding violates the maximum number
of licensed CPUs for Actuate iServer System. To send e-mail about a CPU
license problem, set up Actuate iServer System by completing the following
tasks in this order:
■ Configure every Actuate iServer node to send e-mail.
■ Specify the administrator e-mail address for Actuate iServer System.
To specify an administrator e-mail address, set the AdminEmail attribute in
the System element of the acserverconfig.xml file for Actuate iServer. The
following example shows the attribute for sending e-mail to a user named
admin at a company for which the domain is mycompany:
<System
AdminEmail="admin@mycompany.com">
■ Restart Actuate iServer System. Restarting Actuate iServer System applies
the changes after you set or change the e-mail address.

78 Administering Actuate iServer System

 Chapter

Understanding
Chapter 3
3
Actuate iServer System
performance
This chapter contains the following topics:
■ About Actuate iServer performance
■ Optimizing viewing for Actuate DHTML reports
■ Optimizing Encyclopedia volume performance
■ Optimizing the performance of an Actuate iServer machine
■ Optimizing View process performance

Chapter 3, Understanding Actuate iSer ver System performance 79

About Actuate iServer performance
The following sections discuss optimizing Actuate iServer performance:
■ “Optimizing viewing for Actuate DHTML reports” discusses DHTML,
web browser, and report performance issues.
■ “Optimizing Encyclopedia volume performance” discusses Encyclopedia
volume folder and file organization performance issues.
■ “Optimizing the performance of an Actuate iServer machine” discusses
Actuate iServer machine performance issues.
■ “Optimizing View process performance” discusses View process
performance issues.
The Resource Center on the Actuate Corporation web site contains technical
white papers about Actuate iServer performance and benchmarks:
http://www.actuate.com

Optimizing viewing for Actuate DHTML reports

The time required to view Actuate DHTML reports consists of the time it takes
to render the report in DHTML plus the time it takes to download and display
the DHTML in a user’s web browser. The performance of different web
browsers varies significantly.

Caching DHTML report pages

Enable caching on a user’s web browser to improve viewing for frequently
accessed DHTML report pages. To take advantage of client-side caching,
Actuate iServer administrator must enable browser-side caching of DHTML
reports in the Encyclopedia volume.

Caching temporary reports

Actuate iServer stores temporary reports in an external cache on the server
and deletes the files after a specified time. If a user fills the transient store
cache with temporary reports, Actuate iServer shortens the time a report
remains in the cache to make room for new transient reports. Actuate iServer
returns to normal operation when the available space in the cache increases.
To avoid temporarily shortening the temporary cache time-out settings due to
lack of free cache space, increase the temporary report cache size and the
maximum number of cache entries for transient reports. For information about

80 Administering Actuate iServer System

temporary report settings, see “Specifying Factory service parameter values”
in Chapter 7, “Working with an Actuate iServer System server.”

Searching a DHTML report

Users can search reports for controls that have the Searchable property set to
SearchWithIndex or SearchNoIndex. The View process sets an upper limit on
the amount of time a search operation can take. The Search Timeout parameter
for Actuate iServer is the number of seconds before a View process search
operation times out. If searches time out for users, increase this value to allow
more time for searching. The default value for the Search Timeout parameter is
180 seconds.
For information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”

Creating a PDF file for download

The View process creates a PDF file for download to a user’s workstation.
When the View process creates a PDF file, it converts images in a report to the
JPG format, which Adobe PDF supports. Converting an image to JPG format
can take as long as 15 seconds.
Two Actuate iServer parameters, Compress PDF Content parameter and PDF
Quality, control the content of the downloaded PDF file:
■ The Compress PDF Content parameter controls PDF compression. The
default value is true, which compresses PDF content.
■ The PDF Quality parameter controls the quality of Actuate charts in a PDF
file. The default value is 100. Increasing the value increases the image
resolution and the memory requirements for images in the PDF file. If you
set PDF Quality to 300, set the Chart Server cache to 1024 megabytes (MB).
The Actuate iServer machine must have sufficient RAM to handle the
increased memory requirements. If necessary, you can increase the Chart
Server cache to create the report.
For information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”

Compressing a DHTML report

The View process can stream report pages to Actuate Active Portal or a web
server in GZIP-compressed DHTML format. To use GZIP-compressed
DHTML format, your environment must meet the following requirements:

Chapter 3, Understanding Actuate iSer ver System performance 81

 ■ The web browser supports GZIP encoding.
■ Actuate Active Portal requests a report in DHTML, DHTMLLong, or
DHTMLRaw format.
■ A system administrator sets the CompressDHTML Content parameter to
enable compression and the DHTML Compression Level parameter to
specify the compression level. For information about setting advanced
Actuate iServer parameters, see “Changing advanced Actuate iServer
parameter values” in Chapter 7, “Working with an Actuate iServer System
server.”

Understanding how bundling affects performance

To simplify report distribution, you can bundle an ROX with an ROI. Bundling
works well if the distributed report runs on client workstations. Users who
view large bundled reports on an Actuate Encyclopedia volume can
experience long network wait times before the report appears, because the
View service extracts the ROI file for every request. If the wait time is long
enough, a request can time out. For this reason, Actuate Corporation does not
recommend bundling large reports.

Optimizing Encyclopedia volume performance

This section contains the following topics related to Encyclopedia volume
performance tuning:
■ Restructuring the Encyclopedia volume
■ Managing report notices
■ Moving the Encyclopedia volume
■ Managing space for the Encyclopedia volume
■ Understanding the effects of disk I/O speed
■ Running the Veritas file system on an HP-UX system

Restructuring the Encyclopedia volume

The Encyclopedia volume stores report items and administration information,
including the following items:
■ Report object executable (.rox) files
■ Report object instance (.roi) files

82 Administering Actuate iServer System

■ Report parameter values (.rov) files
■ Formula One report object design (.jod) files
■ e.Spreadsheet template (.vts) files
■ Actuate Analytics cube (.cb4) files
■ Actuate Analytics cube report (.cvw) files
■ Actuate Analytics cube profile (.dp4) files
■ Users and roles
■ Channels
■ Jobs
■ Notifications
Actuate iServer tracks the relationships between report items. For example,
each time Actuate iServer runs a report, Actuate iServer generates a new
report document. Actuate iServer also updates any relationships between the
report and other report files, such as the report executable file and any
corresponding folders.
For ease of use, Actuate recommends limiting number of items you store in an
Encyclopedia volume’s folder. Limiting the number of items in a folder limits
the number of pages a user or administrator must navigate within a folder to
locate a particular item. If you must store a large number of items in a folder,
users and administrators can perform searches and set filtering options to
limit the number of items that appear in a list.
To improve the structure of an Encyclopedia volume, complete the following
tasks:
■ Create additional folders that contain small numbers of report items or
subfolders.
■ Copy report executable files to multiple folders to reduce the number of
relationships between a report executable file and the corresponding report
documents.
The following example illustrates how to restructure an Encyclopedia volume
for easier maintenance and user navigation. In this example, the major report,
Report.rox, is a parameterized report that runs several times each month for
certain users.
The following illustration shows a simple folder structure that includes two
folders:
■ The ReportExecutables folder contains the report executable file,
Report.rox.

Chapter 3, Understanding Actuate iSer ver System performance 83

 ■ The Reports folder contains the report documents that Actuate iServer
creates from Report.rox.

The following illustration shows the contents of the ReportExecutables folder.

84 Administering Actuate iServer System

Each report contains information about specific clients. The application report
name consists of a user name and date. 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, you can further restructure the Encyclopedia
volume:
■ Use subfolders for each year, month, and day that reports run.
■ Ensure that application folders for each year and month contain the report
executable file, Report.rox.
The restructured Encyclopedia volume contains fewer relationships between
single report items and folders and between report documents and the report
executable. The following illustration shows the restructured Encyclopedia
volume structure.

Chapter 3, Understanding Actuate iSer ver System performance 85

 Managing report notices
The following settings determine who receives job completion notices when
Actuate iServer runs a report:
■ When a user creates a job, the user can specify notification settings for the
job. There is also a default notification setting for jobs that a user creates.
For information about setting user properties, see “Managing users,
privileges, and security roles” in Chapter 16, “Managing Encyclopedia
volume security.”
■ When a user schedules a job, the user can specify notification settings. For
information about scheduling jobs, see “Understanding job
administration” in Chapter 19, “Administering jobs.”
■ To instruct Actuate iServer to create persistent completion notices for a
particular user, select Create Completion Notice in the user’s property
definition in the Volume Administration console. For information about
setting user properties, see “Managing users, privileges, and security roles”
in Chapter 16, “Managing Encyclopedia volume security.”
Actuate iServer notifies users when jobs to run or print reports complete:
■ The user who submitted the job
■ An administrator
■ Users who belong to a notification group that receives notices for the job
■ Actuate iServer API connections belonging to the user
Accumulating long lists of notices affects viewing performance. To reduce the
number of persistent completed notices:
■ Choose to generate job completion notices only when necessary.
■ Purge persistent job completion notices on a regular basis.

86 Administering Actuate iServer System

Moving the Encyclopedia volume
To move the Encyclopedia volume to a faster Actuate iServer machine to
improve performance, first use Actuate iServer online backup facilities to back
up the contents of the volume. Use the Actuate acverify utility with the -check
restore option when you restore a volume that you backed up in online backup
mode.
For information about using online backup, see “Backing up the Encyclopedia
volume” in Chapter 20, “Archiving files and backing up an Encyclopedia
volume.” For information about acverify, see “Using acverify” in Chapter 13,
“Working with Actuate iServer utilities.”
When Actuate iServer is running, you must put an Encyclopedia volume
offline before you alter, update, or move the Encyclopedia volume directories.
For more information about moving an Encyclopedia volume, see “Moving an
Encyclopedia volume” in Chapter 9, “Working with an Actuate iServer System
volume.”

Managing space for the Encyclopedia volume

System administrators can use the following Actuate iServer System services
to ensure that they provide sufficient space for an Encyclopedia volume:
■ Actuate iServer checks for available, unused disk space using the values
you set for Actuate iServer parameters. For more information, see “Using
automatic disk space checking” in Chapter 2, “Setting up Actuate iServer
System hardware.”
■ If Actuate iServer has performance problems, run the acverify utility to
check the volume’s integrity. For information about acverify, see “Using
acverify” in Chapter 13, “Working with Actuate iServer utilities.”

Understanding the effects of disk I/O speed

Actuate iServer System stores Encyclopedia volume documents, metadata,
and transaction information on disk. Rapid access to these Encyclopedia
volume items improves report generation throughput. Improving the
performance characteristics of the disk subsystem that contains the volume
can improve Actuate iServer System performance.

Understanding how file system I/O affects Encyclopedia

volume performance
The following list describes the types of Actuate iServer information and how
Actuate iServer uses the information:
■ Actuate iServer stores Encyclopedia volume documents in one or more
Actuate iServer System partitions. Encyclopedia volume documents

Chapter 3, Understanding Actuate iSer ver System performance 87

 include any files you add to the Encyclopedia volume, such as report object
executable (.rox) files and report object instance (.roi) files.
Actuate iServer System partitions are directories on a disk accessible to
Actuate iServer System. The disk can be a local disk drive or a shared
storage device, such as a NAS or SAN device. The partitions that contain
the Encyclopedia volume documents must be readable and writable by all
the Actuate iServer process and Factory and View processes for all Actuate
iServer nodes in a cluster. For more information about Actuate iServer
partitions, see “Configuring an Actuate iServer System partition,” in
Chapter 8, “Working with an Actuate iServer System partition.”
■ Encyclopedia volume metadata includes volume administration
information about users, groups, security roles, files, folders, jobs, and
completion notices. The Encyclopedia volume stores the volume metadata
in its primary partition. Actuate iServer manages this information using a
page buffer pool.
Actuate recommends setting the buffer pool as large as possible to keep the
buffer pool data in the Actuate iServer machine’s memory and not in the
machine’s disk swap space. When the buffer pool is in memory, Actuate
iServer:
■ Does not read data from disk as often when it performs Encyclopedia
volume administration operations
■ Writes data to disk asynchronously instead of waiting for disk output to
complete
You can adjust the buffer pool size on Volumes—Properties—Server
Assignments in the System Administration console of Actuate
Management Console. For information about Volumes—Properties—
Server Assignments, see “Assigning a backup server to an Encyclopedia
volume,” in Chapter 9, “Working with an Actuate iServer System volume.”
■ The Encyclopedia Volume transaction log records updates to a volumes’s
data. Actuate iServer 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 an Actuate
iServer System partition. Actuate iServer uses the transaction log during
recovery to restore the volume to a consistent state after a crash.
If system I/O slows performance, you can put the transaction log on a
separate file system from the rest of the Encyclopedia volume so that the
transaction log file system uses a separate I/O channel for updates. Putting
the transaction log file on a separate device means that log updates do not
compete for disk resources with other volume disk I/O. Place the
transaction log on a high-speed disk subsystem. The speed of transaction
log file system affects the speed of update operations.

88 Administering Actuate iServer System

 You can change the transaction log partition on Volumes—Properties—
General in the System Administration console of Actuate Management
console. For information about Volumes—Properties—General, see
“Modifying Actuate iServer parameter values for an Encyclopedia
volume” in Chapter 9, “Working with an Actuate iServer System volume.”

Configuring an Encyclopedia volume to work in a SAN

When setting up an Actuate iServer cluster, nodes with the Encyclopedia,
View, or Factory services enabled require direct file access to Encyclopedia
volume data. A SAN device does not typically provide direct file access. To use
a SAN device, use one of the following configurations to support direct file
access:
■ SAN with a NAS head.
■ SAN with a direct file access software deployed on nodes that have the
Encyclopedia, View, or Factory services enabled. Many software products
provide direct file access, including the ones in the following list:
■ Veritas SANPoint
■ IBM Tivoli SANergy
■ EMC High Road
■ Sun StoreEdge Performance Suite with QFS
■ ADIC StorNext File System
■ SGI CXFS
■ Configuring the owner user for the SAN as a file server.

Improving disk I/O speed to improve Encyclopedia

volume performance
To improve disk I/O speed for the Encyclopedia volume, you can:
■ Place the Encyclopedia volume on a disk volume with the best
performance, such as Redundant Array of Inexpensive Disks (RAID) level
0 or level 0+1.
Avoid storing the Encyclopedia volume on RAID level 5 devices. RAID
level 5 devices improve availability by mirroring data. The additional

Chapter 3, Understanding Actuate iSer ver System performance 89

 writes that support mirroring degrade disk I/O performance. The
following table describes the features of the RAID levels.

Redundant data Relatively

RAID level Fast I/O storage inexpensive
RAID 0 X X
RAID 0 + 1 X X
RAID 10
RAID 5 X X

■ Use disk striping on the Encyclopedia volume’s disk volume.

Allocate the Encyclopedia volume across multiple disk volumes using disk
striping. Stripe the Encyclopedia volume across four disk spindles. Using
disk striping supports concurrent I/O operations for the Encyclopedia
volume.

Running the Veritas file system on an HP-UX

system
Disk write sizes of greater than 1 megabyte (MB) create Actuate iServer
performance problems. You must set the size of the write buffer for the Veritas
file system running on an HP system to limit the size of disk writes. The
AC_RCBF_WRITE_BUFFER_SIZE environment variable limits the size of disk
writes. Specify a 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 shown in the following
example:
setenv AC_RCBF_WRITE_BUFFER_SIZE 512000

Optimizing the performance of an Actuate iServer

machine
Before you read these sections, familiarize yourself with the Actuate iServer
architecture. For information about Actuate iServer architecture, see “About
the Actuate iServer architecture” in Chapter 1, “Actuate iServer architecture
overview.”
This section discusses the following topics related to the performance of an
Actuate iServer machine:
■ Understanding CPU resource requirements
■ Adjusting operation process timing

90 Administering Actuate iServer System

■ Estimating CPU resources
■ Understanding memory resource requirements
■ About Actuate iServer resource groups and performance
■ Understanding how operations and administrative commands affect
performance

Understanding CPU resource requirements

Actuate iServer System typically includes a cluster of Actuate iServer
machines. Each Actuate iServer machine can exploit the performance and
scalability of a multiprocessor system. Ensure that a stand-alone Actuate
iServer machine can operate at an average of 95% processor utilization
without performance degradation.
The Actuate iServer process and operation processes implement
multiprocessor support in different ways:
■ The Actuate iServer process uses multithreading to implement
multiprocessor support. A single process serves multiple requests
concurrently by creating a thread of execution within the process.
■ Operation processes use a multiple process approach. For example,
multiple Factory and View processes can run concurrently on a
multiprocessor.

About report generation performance

Report generation performance improves in proportion to CPU speed in the
same CPU architecture when no other resource bottlenecks exist. Memory and
disk input or output can be resource bottlenecks.
Report generation for aggregate reports typically takes longer than report
generation for detail reports. A detail report displays one line for each
database row. An aggregate report displays summarized information from
many database rows. An aggregate report requires more report generation
time because Actuate iServer completes multiple passes to obtaining the data
to compute the summary totals.

Sharing a CPU with a database server

To provide sufficient resources for both servers, place Actuate iServer on a
different CPU from a database server. Actuate iServer report generation and
database server tasks are CPU-intensive. If you cannot place Actuate iServer
and a database server on separate CPUs, plan for additional CPU, memory,
and disk resources to support Actuate iServer. Do not lock the Actuate iServer
Factory process or database process into a specific CPU. To optimize resource

Chapter 3, Understanding Actuate iSer ver System performance 91

 utilization, allow the operating system to determine where to run Actuate
iServer or database processes.

Adding Factory processes

In both stand-alone and cluster configurations, the optimum number of
Factory processes for Actuate iServer depends on the speed of the CPU that
runs the Actuate iServer workload and the mix of reports in the workload.
To begin, configure two Factory processes on a processor. Adding Factory
processes can enhance performance if the database that Actuate iServer uses to
create reports is a performance-limiting resource. Actuate iServer can use the
multiple Factory processes to run multiple, simultaneous reports that use the
database. When Actuate iServer runs multiple, simultaneous reports, some of
the Factory processes access the database while other Factory processes
perform report generation tasks that do not access the database.

Adding CPUs
Additional CPUs and Factory processes can improve the overall throughput
for Actuate iServer, not the performance of individual applications. In a single
CPU environment, one Factory process can consume most of a CPU when a
report runs. Adding CPUs to an Actuate iServer configuration can increase
throughput because multiple Factory processes can run concurrently on
separate CPUs.
As Actuate iServer System administrator, you can add an Actuate iServer
machine to an Actuate iServer cluster to increase report generation and report
viewing capacity. When you add an Actuate iServer machine as a cluster node,
enable and configure the Factory and View services. The Actuate iServer
cluster master updates the Actuate iServer System configuration and uses the
additional report generation and viewing capacity.
When you add an Actuate iServer node to an Actuate iServer cluster, the
Actuate iServer node must have:
■ The same Actuate iServer System options licensed and enabled as the other
Actuate iServer nodes in the cluster.
■ Access to the appropriate system resources, such as printers, database
software, and other third-party software.
The CPU limit of your Actuate iServer System license must also be high
enough to support the addition of the new Actuate iServer node.
For information about managing Actuate iServer clusters, see “Managing an
Actuate iServer cluster” in Chapter 5, “Actuate iServer System administration
overview.”

92 Administering Actuate iServer System

Adjusting operation process timing
When you run a large Actuate iServer workload, the standard amount of time
that Actuate iServer waits between starting and using a Factory or View
operation process can be too short to allow the process to start. Also, the wait
time between attempts by Actuate iServer to communicate with the operation
process can be insufficient. To change these wait times, set the Delay After
Creating Operation Process parameter and the Delay Between Contacting
Operation Process parameter.
For information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”

Adjusting TCP/IP socket usage on a Microsoft

Windows system
When you run a large Actuate iServer workload on a Microsoft Windows
system, Actuate iServer can display the following error message:
Socket connect failed. Please retry your request after some time
A possible cause of the error is the default Microsoft Windows default settings
for TCP/IP socket usage. The following Windows registry entries control the
maximum number of TCP/IP ports and port timeout:
■ MaxUserPort
■ TcpTimedWaitDelay
Using the registry entries to increase the number of ports and lower the
timeout value might resolve the problem with sockets. The registry entries are
under the registry key HKEY_LOCAL_MACHINE\SYSTEM\
CurrentControlSet\Services\Tcpip\Parameters.
For more information about the registry entries, see the Microsoft Windows
system documentation.

Estimating CPU resources

Actuate iServer performance depends on an operating system’s ability to
handle the workload and on the CPU speed. You can estimate the impact of
CPU speed on performance only when you compare CPU speeds in the same
operating system environment. For example, Actuate iServer throughput on
UNIX and Windows NT running on processors that have the same speed can
vary significantly.
Scalability depends on operating system features. The number of CPUs
supported also varies by operating system. To accurately estimate CPU

Chapter 3, Understanding Actuate iSer ver System performance 93

 resources, you must benchmark the workload. For more information about
estimating CPU resources and benchmarking, see the Actuate web site for
relevant white papers.

Understanding memory resource requirements

The following sections describe memory resource requirements that affect
Actuate iServer System performance:
■ Understanding paging resource requirements
■ Understanding buffer pool resource requirements
■ Understanding Factory process recycling

Understanding paging resource requirements

All operating systems that Actuate iServer supports use virtual memory to
enable applications to use more memory than the processor’s RAM can
provide. The operating system moves blocks of memory called pages from
RAM to disk to make RAM available for active tasks.
The processor’s paging rate indicates how the operating system manages
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 decreases. High paging rates cause performance degradation.
Paging rates vary depending on the Actuate iServer workload. When Actuate
iServer runs a large amount of report generation tasks, it typically shows very
low paging activity. When Actuate iServer runs many viewing tasks, it
typically shows higher paging rates because of the interaction between the
user and Actuate iServer.

Understanding buffer pool resource requirements

Configuring adequate physical and virtual memory on an Actuate iServer
machine is critical for good Actuate iServer performance. In general, the buffer
pool size and maximum number of threads used by the Actuate iServer
process and the Factory and View processes determines Actuate iServer
memory usage.
In addition to the buffer pool, the Actuate iServer process has overhead
requirements, including the program executable size and stack size for the
message threads and other items. As a simple example, an Encyclopedia
volume configured with a 100MB buffer pool grows to 130MB 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 1GB of physical memory, you can configure the
Encyclopedia volume buffer pool size to about 500MB, depending on what

94 Administering Actuate iServer System

other software runs on the Actuate iServer machine. Use a system
performance tool to compare the total memory used to the amount of physical
memory on the Actuate iServer machine. On a Microsoft Windows server
operating system, use a tool such as the task manager to compare the total
memory used to the amount of physical memory on the Actuate iServer
machine. You can also use Performance monitor to monitor disk and memory
usage.
Track memory and disk usage during normal and peak load periods to
determine whether you have enough memory for both activity periods. If
Actuate iServer frequently swaps between virtual and physical memory, you
can add memory to reduce swapping and improve performance. Allocate the
same amount of virtual memory as physical memory on your Actuate iServer
machine.
Actuate iServer stores Encyclopedia volume metadata in a data store. The data
store is organized in pages. The Actuate iServer volume’s page buffer pool
works similarly to a virtual memory manager. Actuate iServer 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 Actuate iServer to frequently
read data from disk, which slows performance. When the buffer pool swaps to
disk, Actuate iServer substitutes the machine’s virtual memory I/O for
Actuate iServer I/O. The ideal buffer pool size to use ensures that the Actuate
iServer process remains in physical memory.
Specify the Encyclopedia volume buffer pool size on Volumes—Properties—
Server Assignments in the System Administration console of Actuate
Management Console. For information about Volumes—Properties—Server
Assignments, see “Assigning a backup server to an Encyclopedia volume” in
Chapter 9, “Working with an Actuate iServer System volume.”

Understanding Factory process recycling

Actuate iServer attempts to optimize the use of memory by restarting Factory
processes periodically based on the number of requests to run and print
reports. You can disable the automatic restarting of a Factory process by
setting the Actuate iServer Recycle Processes parameter to False. Also, you can
adjust the minimum number of requests between automatic restarts by
changing the integer value of the Actuate iServer Number of Requests Before
Recycling Processes parameter. For information about setting the parameters,
see “Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”

Chapter 3, Understanding Actuate iSer ver System performance 95

 About Actuate iServer resource groups and
performance
An Actuate iServer System cluster uses load-balancing mechanisms to
distribute report jobs among the Actuate iServer nodes. The load-balancing
mechanisms attempt to maximize Actuate iServer System performance.
An Actuate iServer resource group controls the Factory processes an Actuate
iServer System uses to run a synchronous or asynchronous job to create or
print report output. Creating custom resource groups restricts the ability of
Actuate iServer to maximize performance and can adversely affect the report
generation performance of an Actuate iServer cluster.
For information about managing an Actuate iServer resource group, see
“About resource groups” in Chapter 10, “Adding and configuring an Actuate
iServer System resource group.”

Understanding how operations and administrative

commands affect performance
The following areas of Actuate iServer operations and administrative
commands can affect Actuate iServer performance:
■ Running service aids
■ Managing administrative information
■ Specifying privileges for report files and folders

Running service aids

To run Actuate iServer in a production environment, turn off the logging
service aid. Use logging only when you debug an Actuate iServer problem
under the direction of Actuate Customer Support. Logging uses CPU and disk
resources that Actuate iServer can use more productively for other purposes.

Managing administrative information

When you create users, security roles, notification groups, and channels in an
Encyclopedia volume, you create relationships among the administrative
items. These relationships have recommended and hard limits. Following the
recommended ensures the best possible appearance, behavior, and
performance for the Volume Administration console of Actuate Management
Console. A web browser imposes the hard limits. For information about these
limits, see “Setting Encyclopedia volume limits” in Chapter 15,
“Understanding Encyclopedia volume administration.”

96 Administering Actuate iServer System

 Specifying privileges for report files and folders
Navigating, using, and maintaining long lists of users and roles is difficult. For
example, searching for a user in a list of hundreds of users is cumbersome.
When you specify privileges for a file or folder, minimize the number of users
and roles that you specify for the item. To set the same set of privileges on a file
or folder for a large number of users and roles, nest the roles and users in
another role by completing the following tasks in this order:
■ Create a new role.
■ Set the original users and roles to inherit from the new role.
■ Assign privileges for the new role on the volume item.

Optimizing View process performance

This section discusses the following topics:
■ Understanding the architecture of the View process
■ Setting up the View process component
■ Understanding View process performance features

Understanding the architecture of the View

process
The View process is a component of Actuate iServer. The primary task of the
View process is delivering Actuate DHTML reports to a user’s web browser.
The View process can also convert Actuate report document data to XML for
use with other web applications and to PDF for printing.
The View process provides the basic engine, intrareport security, and
converter framework to support DHTML reports. Users can view reports in
DHTML format in a web browser. The user logs in to an Encyclopedia volume
using a web server and Actuate Active Portal or ReportCast. Actuate iServer
starts a View process when the user selects an Actuate report. The View
process supports viewing a page, viewing the table of contents, and searching
a report.
The following illustration shows the Actuate iServer System architecture and
how the View process interacts with other parts of Actuate iServer System,
including:
■ Actuate iServer
■ Actuate Active Portal and Actuate Management Console
■ Actuate ReportCast

Chapter 3, Understanding Actuate iSer ver System performance 97

 ■ A web server

Web
browsers
Actuate iServer
View
process
SOAP
interface
Application View
Server service
Factory
Message process
Factory
Distribution service
Actuate service
Active Portal
Encyclopedia Integration Integration
and
service service process
Management
Console
Caching
service Caching
Actuate
iServer process
Application
Container RS API
interface

Actuate Information
desktop object cache and
software Record Matcher
databases

Jobs, notifications Folders

Actuate Encyclopedia
ReportCast volume
Report files Users, groups, roles

About how the View process works

When a user logs in to the Encyclopedia volume and submits a request to view
a report, the following things occur:
■ The Request process communicates with the View process to create a new
thread in the View process.
■ Actuate iServer routes the request to the View process that is least busy.
■ The View process stores information on a report, session, and user basis in
the view session cache.

98 Administering Actuate iServer System

■ The View process stores the ROX in an ROX cache.
■ The View process stores the ROI in a view session cache.

Understanding the converter framework

The converter framework is an Actuate iServer architecture that supports
rendering XML in other formats. To support DHTML reports, the converter
framework renders XML in DHTML format for Netscape Navigator or
Microsoft Internet Explorer. The converter framework adjusts for the
differences between web browsers when it renders DHTML. Also, the
converter framework renders XML in Adobe PDF format when users request
report content to be downloaded to their workstation.

Setting up the View process component

By default, Actuate iServer runs two View processes on an Actuate iServer
machine. To test View process performance for a single CPU machine, set the
number of View processes to one. On a multiple CPU machine, use one View
process for each pair of CPUs. Monitor CPU usage on the server that runs the
View process. Configure additional View processes if necessary to support
CPU demands during peak times. For information about configuring Actuate
iServer to support multiple View processes, see “Setting View service
parameter values” in Chapter 7, “Working with an Actuate iServer System
server.”
The Maximum Number of Worker Threads Per Process parameter is the
number of concurrent service threads in the View process can handle before
Actuate iServer slows the process of picking up new messages. This limit
affects the internal behavior of the View process. Actuate recommends leaving
the value set to 4, the default value. For information about setting advanced
Actuate iServer parameters, see “Changing advanced Actuate iServer
parameter values” in Chapter 7, “Working with an Actuate iServer System
server.”

Understanding View process performance

features
To optimize View process performance, allocate resources and adjust View
process tuning parameters to maximize View process activity and avoid any
delay in the processing of requests for View process service.
To improve viewing performance, the View process maintains caches for
reports and report executable files. You can set Actuate iServer parameters to
configure cache sizes, time-out values, and other View process parameters. In
most cases, you do not have to change the values for these parameters from
the default values.

Chapter 3, Understanding Actuate iSer ver System performance 99

 The design of the View process architecture ensures that it can scale to support
as many as tens of thousands of users. To ensure good performance:
■ The View process implements multithreading to support scalability on
Actuate iServer machines that have multiple CPUs.
■ Actuate iServer balances the View process workload.
■ The View process caches ROX files to minimize communication overhead
between the Encyclopedia process and the View process.

About how Actuate iServer balances the View

process workload
When you install Actuate iServer, the default process configuration starts one
View process component. If you define additional View processes, Actuate
iServer can start and communicate with multiple View processes. Actuate
iServer can route connections to different View processes to maintain a
balanced workload. Unless you run Actuate iServer on an operating system
that does not support multithreading, accept the default values for the View
process configuration.

About how the View process minimizes

communication with Actuate iServer
The View process stores session information in a cache. Increasing cache size
can improve View process performance when cache size is a limiting resource.
The View process uses cache to store ROX files and view session information.
When a user logs in, the View process creates a view session object that holds
the user name and ROI name, including the version number. The View process
uses the view session object to track requests. After the View process creates
the view session object, the View process communicates with the Encyclopedia
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 who view the same report concurrently. The
View process loads the ROX file only when the first user submits a request to
view the report. The View process maintains consistency between related ROX
and ROI files by invalidating unused cache entries after a user-specified
period.

100 Administering Actuate iSer ver System

Controlling cache resources
The following Actuate iServer parameters control the behavior of the Sender
ID cache:
■ The Maximum Cached Sessions Per Process parameter defines the
maximum number of view sessions for users and report object instance
(.roi) files in the view session cache. The default value is 4096.
■ The Session Cache Timeout parameter is the number of seconds to wait
before invalidating the contents of a view session cache. Actuate iServer
System uses this parameter value to synchronize cache contents with
Encyclopedia volume data. In an environment where the Encyclopedia
volume data is read-only, set the value for this variable to a large
number.The default value is 3600 seconds, which is one hour.
The following Actuate iServer advanced parameters set other View process
caching limits:
■ The Maximum File Cache Size Per Process parameter is the maximum size
of the directory that contains all cached files. The default value is 50, which
means 50MB.
■ The Timeout for Process File Cache parameter determines when the file
cache times out. The default value is 86400 seconds.
■ The Maximum Total Size of Cached ROX Files parameter is the maximum
total size of ROX files in the View process ROX cache. The default value is
64MB.
■ The Maximum Timeout for Cached ROX Files parameter determines when
the View process ROX cache times out. The default value is 15 minutes.
For information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”

Ch apte r 3, Un de rs tand ing Ac tua te iS er ve r S y ste m p er fo r m an ce 101

102 Administering Actuate iSer ver System
 Chapter

Configuring Actuate
Chapter 4
4
iServer security
This chapter contains the following topics:
■ About the Report Server Security Extension
■ Working with the Actuate iServer security applications
■ About open security LDAP configuration
■ Importing and exporting data with open security and the sample Actuate
RSSE application

Chapter 4, Configuring Actuate iSer ver security 103

About the Report Server Security Extension
The following sections describe the Report Server Security Extension (RSSE)
applications that Actuate iServer System uses with Encyclopedia volumes. For
a description of the features of the RSSE, see “About Encyclopedia volume
security” and “About Actuate Open Security” in Chapter 16, “Managing
Encyclopedia volume security.”
Actuate supports two types of security integration:
■ Open security. For more information about open security, see “About open
security functionality,” later in this chapter.
■ Page-level security. For more information about page-level security, see
“About page-level security functionality for Actuate Basic reports,” later in
this chapter.
For information about the RSSE security applications that Actuate iServer
includes, see “Working with the Actuate iServer security applications,” later in
this chapter.
Actuate iServer supports both a SOAP-based RSSE API and a C-based RSSE
API. Actuate iServer can run either the SOAP-based RSSE application or the C-
based RSSE application. Actuate iServer cannot run both the SOAP- based and
C-based application applications simultaneously. For information about the
RSSE API, see Chapter 14, “Using the Report Server Security Extension,” in
Programming with Actuate iServer APIs, distributed with Actuate iServer
Integration Technology.

About open security functionality

Actuate iServer open security supports creating an interface to an external
security source such as Lightweight Directory Access Protocol (LDAP) or
Microsoft Active Directory. Using the interface, the Encyclopedia volume uses
information from the external security source to control access to an
Encyclopedia volume.
Using RSSE, a developer can also create a custom login application to use with
the Actuate Desktop products, which are Actuate Viewer, Actuate End User
Desktop, Actuate e.Report Designer, and Actuate e.Report Designer
Professional. The login application can collect extended credentials that the
desktop product can pass to Actuate iServer for authentication. This
functionality applies only to those applications that include a viewer that can
connect directly to an Encyclopedia volume.
To use the login application, a developer must create an installation program
that installs and configures the login application on the user machine that runs
the desktop application. For information about creating a login application,

104 Administering Actuate iSer ver System

 see Chapter 14, “Using the Report Server Security Extension,” in Programming
with Actuate iServer APIs.

About page-level security functionality for Actuate

Basic reports
Using page-level security in Actuate Basic reports requires that you license the
Page Level Security Option for Actuate iServer System. Using RSSE and page-
level security, a developer can create an RSSE application that associates
security IDs in a report’s access control list (ACL) to one or more Encyclopedia
volume users or roles. For example, a report developer can create an Actuate
Basic report that contains a security ID, Demo, in some of the report’s ACLs. If
you use an RSSE application, Demo does not have to be an Encyclopedia
volume user or role. The RSSE application can take the security ID, Demo, and
map it to a set of Encyclopedia volume users or roles. When a user associated
with Demo views the report, that user can see only the report pages for which
the page’s ACL contains Demo.
In addition to the ACL that the RSSE application provides, Actuate iServer
always adds a user name and any roles of which the user is a member. Even
when the RSSE application returns an empty string, the ACL that Actuate
iServer uses always contains the Encyclopedia volume’s name and roles. For
more information about the RSSE interface and creating an RSSE application,
see Chapter 14, “Using the Report Server Security Extension,” in Programming
with Actuate iServer APIs.

Working with the Actuate iServer security

applications
The Actuate iServer Integration Technology product includes the source code
and JAR files for several SOAP-based RSSE applications, including an RSSE
application that installs with Actuate iServer. For information about the RSSE
application and the SOAP-based RSSE APIs, see Programming with Actuate
iServer APIs, which ships with Actuate iServer Integration Technology, and
“Working with the RSSE open security application that uses LDAP,” later in
this chapter.

Working with the RSSE open security application

that uses LDAP
The following topics describe how to use the RSSE open security application:
■ About the Actuate RSSE open security application

Chapter 4, Configuring Actuate iSer ver security 105

 ■ Changing the type of Encyclopedia volume security
■ Understanding how Actuate iServer System caches external security
information
For information about LDAP configuration, see “About open security LDAP
configuration,” later in this chapter.

About the Actuate RSSE open security application

The RSSE open security application uses a Netscape Directory Server to
specify security settings for users who log in to an Encyclopedia volume. A
Netscape Directory Server is an LDAP security database. Actuate iServer uses
this application when you select the Custom installation option during
Actuate iServer installation.
To use an LDAP security source, you must configure the security source and
populate it with the appropriate security information. You must also configure
the Encyclopedia volume parameters. Specify the DLL or shared library to use
on Volume—Properties—Open Security in the System Administration console
of Actuate Management Console. For more information about Volume—
Properties—Open Security, see “Working with Actuate Open Security,” in
Chapter 9, “Working with an Actuate iServer System volume.”
When you choose the Custom option during Actuate iServer installation, you
can install and configure a SOAP-based RSSE open security application that is
written in Java and uses LDAP with the Encyclopedia volume. The SOAP-
based RSSE application runs as a web service from the Actuate iServer
application container.
The following diagram illustrates the communication of the Actuate iServer,
the RSSE application as a web service, and the external security source:

User Web server

Actuate web
application

Actuate iServer Service provider

Security
RSSE endpoint RSSE service source
interface

Encyclopedia
volume

106 Administering Actuate iSer ver System

The service runs from the Actuate iServer application container. The Actuate
iServer application container ships with Actuate iServer. The Actuate iServer
installation program installs the Actuate iServer application container with the
following Actuate iServer components:
■ Actuate Management Console
■ The Actuate RSSE web services application
The default location for the Actuate iServer application container,
Management Console, and the RSSE web services application is in the Actuate
iServer home directory. The following locations are the default locations:
■ The Actuate iServer application container is in servletcontainer directory.
■ Actuate Management Console is in the servletcontainer/mgmtconsole
directory.
■ The RSSE web services application is in the servletcontainer/webapps
/acrsse directory.

Changing the type of Encyclopedia volume security

If an existing Encyclopedia volume contains user, role, or group
administration information, you must use the acextern or the acintern utility
before you change the type of security that Actuate iServer uses with the
volume:
■ The acextern utility updates administration information that uses the
default Encyclopedia volume security to work with an RSSE application
that operates at the External Registration security level. For information
about acextern options, see “Using acextern” in Chapter 13, “Working with
Actuate iServer utilities.”
■ The acintern utility updates administration information that uses an RSSE
application that operates at the External Registration security level to work
with the default Encyclopedia volume security or with an RSSE application
that works at the External Authentication security level. For information
about acintern options, see “Using acintern” in Chapter 13, “Working with
Actuate iServer utilities.”
For example, an Encyclopedia volume uses the default Encyclopedia volume
security. To use an RSSE application that accesses an external security source,
you must use acextern to prepare that Encyclopedia volume for use with the
RSSE application.

Understanding how Actuate iServer System caches

external security information
When using an external security application, Actuate iServer caches external
security source information. This information includes:

Chapter 4, Configuring Actuate iSer ver security 107

 ■ External user properties
■ Roles of a user under external user registration
An Actuate iServer System administrator can control the maximum time for
which the cache holds the information by setting open security parameters.
Use the RSSE Cache Timeout parameter to control how long the cache stores
security information. The default value is 60 minutes. For more information
about Volume—Properties—Open Security and the related parameters, see
“Working with Actuate Open Security” in Chapter 9, “Working with an
Actuate iServer System volume.”

Installing the Actuate RSSE web service

application
You can install the Actuate RSSE web service application as part of Actuate
iServer Custom installation process. The installation process performs the
following functions:
■ Configures Actuate iServer to use the application. For an Encyclopedia
volume, the installation process enables open security as a web service and
sets the open security web service parameters.
■ Configures the RSSE web service application. For an Encyclopedia volume,
the RSSE web service configuration information is in the
ldapconfig_<volume>.xml file, where <volume> is the name of the
Encyclopedia volume that uses the RSSE application as a web service. For
example, the configuration file for the sales1 volume is:
ldapconfig_sales1.xml
The RSSE web service application configuration file is in the etc directory
for Actuate iServer. The default directory on a Windows system is:
\Program Files\Actuate8\iServer\etc
Each volume that uses the RSSE web service application must have a
configuration file.
■ Installs and configures the Actuate iServer application container to use the
RSSE web service application. The RSSE web services application is in the
following Actuate iServer application container directory:
/applservletcontainer/webapps/acrsse
The default directory on a UNIX system is:
$AC_SERVER_HOME/servletcontainer/webapps/acrsse
To configure the RSSE web service application, change the values in the
ldapconfig_<volume>.xml file, and restart the Actuate iServer application
container that runs the RSSE web service application.

108 Administering Actuate iSer ver System

 Actuate iServer Release 8 includes only the RSSE web service application. It
does not include the C++ RSSE application. When you upgrade an Actuate
iServer node that uses the C++ LDAP application to Actuate iServer Release 8,
the installation program retains the Actuate iServer C++ LDAP files and
configuration.

About open security LDAP configuration

When you configure an Encyclopedia volume to use the open security
application that ships with Actuate iServer, Actuate iServer uses the open
security application and a Netscape Directory Server, an LDAP server, to get
Encyclopedia volume user information to use for Encyclopedia volume user
administration.
When Actuate iServer System uses the open security application,
Encyclopedia volume users that are defined in the LDAP directory must have
a password. The user information in the LDAP directory must use:
■ A single LDAP organization
■ The appropriate LDAP object classes
The ldapconfig_<volume>.xml file defines the mapping between
Encyclopedia volume user information and LDAP information. Encyclopedia
volume user administration information typically maps to LDAP information
in the following way:
■ The Encyclopedia volume users, groups, and roles map to LDAP object
classes. For example, a system administrator can specify that Actuate users
map to the LDAP inetorgperson object class and that Actuate roles and
groups map to the LDAP groupofuniquenames object class.
■ Individual Actuate users, roles, and groups are LDAP objects. For example,
after the system administrator specifies that Actuate users map to the
LDAP inetorgperson object class of an organizational unit, the system
administrator creates LDAP users based on the inetorgperson object class.
In LDAP, the system administrator can create users named MBarajas and
JThompson based on the inetorgperson object class. MBarajas and
JThompson are Encyclopedia volume users.
■ 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, after the system administrator specifies that the Actuate users are
based on the inetorgperson object class, the system administrator can
specify that Actuate e-mail maps to the mail attribute of the LDAP
inetorgperson object class. An administrator can create object class
attributes to store Actuate user properties.

Chapter 4, Configuring Actuate iSer ver security 109

 In LDAP, a system administrator can also create a set of Encyclopedia 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 more information about how LDAP
categorizes and stores information, see your LDAP documentation.
The following sections describe how the Actuate open security application
determines the mapping between the LDAP directory information and the
Encyclopedia volume administration information. This information is specific
to the open security application that ships with Actuate iServer.

Mapping Encyclopedia volume administration

information
A misconfigured or missing parameter in ldapconfig_<volume>.xml can
prevent Actuate iServer from functioning. For more information about
ldapconfig_<volume>.xml, see “Understanding ldapconfig_<volume>.xml
parameters,” later in this chapter.
The following topics discuss how to map particular types of Encyclopedia
volume administration information:
■ Mapping Encyclopedia volume user properties
■ Mapping Actuate roles
■ Mapping Actuate groups
■ Mapping Actuate channels

Mapping Encyclopedia volume user properties

Actuate Encyclopedia volume users and their properties map to attributes of
an LDAP object. User properties include login name, password, e-mail
address, and default privilege template. For example, if Actuate user
information maps to an LDAP inetorgperson object class, the user properties
map to the LDAP inetorgperson object class attributes.
All LDAP user object attributes are string attributes. To specify multiple
values, the LDAP user object attributes for privilege template list and Actuate
iServer Encyclopedia volume channel membership list must be multivalued.
For example, to specify that a user belongs to multiple volume channels in
LDAP, the user object Encyclopedia volume channel attribute must be
multivalued with an Actuate channel name for each value.
The Encyclopedia volume login name is the user ID attribute of the LDAP user
object, called the uid attribute. The volume password is the password attribute
of the LDAP user object. When you use the Actuate open security application,
a user must use a password to log in to the Encyclopedia volume.

110 Administering Actuate iSer ver System

To indicate that an Actuate user is 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.
Actuate uses the default value for an Actuate user property in
ldapconfig_<volume>.xml when:
■ The LDAP server does not contain a definition for the LDAP user object
attribute.
■ The LDAP attribute for a user object does not contain any values.

Mapping Actuate roles

Encyclopedia volume roles map to an LDAP object class, such as
groupofuniquenames. The name Actuate displays is the LDAP object’s
common name attribute, called the LDAP cn attribute.
When using the Actuate open security application with an LDAP server, you
cannot nest roles. Roles are an LDAP object with no Actuate-specific attributes.
To indicate that an Actuate user is a member of one or more Actuate roles, add
the LDAP Actuate user object as a member of the LDAP Actuate roles.
Actuate iServer uses the members specified in the LDAP Actuate role objects
when it performs authorization functions for Actuate roles. Actuate iServer
also uses the LDAP role objects when it lists roles used to specify privileges.
To specify privileges on a file or folder in the Encyclopedia volume for an
LDAP role object, first create the Actuate role object in the LDAP directory.
Then, in the Encyclopedia volume, specify privileges for the Actuate role in
the Encyclopedia volume file or folder.
Actuate Active Portal supports using different levels of user functionality
based on a user’s membership in particular Encyclopedia volume roles. To use
the Actuate Active Portal roles and functionality levels, create corresponding
LDAP roles and add users to the roles. For information about Actuate Active
Portal roles, see “About Actuate Active Portal roles” in Chapter 16, “Managing
Encyclopedia volume security.”

Mapping Actuate groups

Encyclopedia volume groups map to an LDAP object class, such as
groupofuniquenames. The name Actuate displays in the Encyclopedia volume
is the LDAP object cn attribute.
If the e-mail notification group maps to the LDAP groupofuniquenames object
class, the LDAP group objects do not require Actuate-specific attributes. To
specify that an Actuate user is a member of an Encyclopedia volume group,
first create an LDAP group object. Then, add the LDAP user object as a
member of the LDAP group object.

Chapter 4, Configuring Actuate iSer ver security 111

 Mapping Actuate channels
The Encyclopedia volume stores channel names. An LDAP user object
attribute specifies the list of channels to which an Actuate user subscribes. The
open security application does not verify that the Encyclopedia volume’s
channel names match the LDAP user object channel attribute values. An
administrator must ensure that the channel names match the values in the
LDAP user object channel attribute.

Understanding ldapconfig_<volume>.xml
parameters
As described in “Mapping Encyclopedia volume administration information,”
earlier in this chapter, the open security application that ships with Actuate
iServer uses a mapping file, ldapconfig_<volume>.xml, to map Encyclopedia
volume administration information to LDAP objects and object attributes.
The following table describes the parameters that appear in
ldapconfig_<volume>.xml. The examples in the following table are based on
Netscape Directory Server 5.1. For information about setting
ldapconfig_<volume>.xml parameters, see “Setting
ldapconfig_<volume>.xml parameters,” later in this chapter.

Parameter Description Example

AdminRole Actuate role attribute value that <AdminRole>
indicates that an LDAP user actuateAdmin
object can perform Encyclopedia </AdminRole>
volume administration.
AllRole LDAP role object name that maps <AllRole>
to the All role in the actuateAll
Encyclopedia volume. An </AllRole>
administrator uses the All role to
grant privileges to all
Encyclopedia volume users.
GroupBaseDN Base LDAP distinguished name <GroupBaseDN>
used to locate the LDAP Actuate ou=Groups, dc=actuate, dc=com
notification group object in </GroupBaseDN>
queries of notification group
names.
GroupObject LDAP object class that the <GroupObject>
Actuate open security groupofuniquenames
application uses to find Actuate </GroupObject>
notification group names.

112 Administering Actuate iSer ver System

Parameter Description Example
GroupToNotify Name of the LDAP notification <GroupToNotify>
group that receives notification specialGroup
about all Actuate iServer requests </GroupToNotify>
in the manner of the
administrator user when the
Encyclopedia volume uses
default, internal security. The
GroupBaseDN parameter defines
the base DN of this group name.
When combined with the
GroupBaseDN value, this
parameter specifies the LDAP
Actuate notification group object.
Actuate iServer uses that object
for Actuate LDAP notification.
For example:
"cn=AdminGroup, ou=Actuate
Groups, o=actuate.com"

OperatorRole LDAP role object name that maps <OperatorRole>

to the Encyclopedia volume actuateOperator
Operator role. A user must have </OperatorRole>
this role name to perform
Encyclopedia volume Operator
functions, such as online
Encyclopedia volume backups.
Port Internet port on which the LDAP <Port>
server listens. 389
</Port>
The default value is 389.
QueryAccount LDAP account that the RSSE <QueryAccount>
application uses for query uid=actuate, ou=Administrators,
operations to the LDAP server. ou=TopologyManagement,
The open security application o=NetscapeRoot
</QueryAccount>
uses this account to validate
users, roles, ACLs, and other
Encyclopedia volume user
information. For example:
"uid=admin,
ou=Administrators,
ou=TopologyManagement,
o=NetscapeRoot"

Chapter 4, Configuring Actuate iSer ver security 113

Parameter Description Example
QueryPassword Password for the LDAP account <QueryPassword>
specified by the QueryAccount Actu8
parameter. </QueryPassword>

RoleBaseDN Base LDAP distinguished name <RoleBaseDN>

that the RSSE application uses to ou=AcRoles, dc=actuate, dc=com
locate the LDAP role object in </RoleBaseDN>
queries of roles.
RoleObject LDAP object class that the <RoleObject>
Actuate open security groupofuniquenames
application uses to find Actuate </RoleObject>
role names.
Server Name of the LDAP server that <Server>
the RSSE open security helium.actuate.com
application and Actuate iServer </Server>
use. Use the fully qualified name,
including the domain name. You
can use the server’s IP address.
The default value is the name of
the Actuate iServer machine.
UserBaseDN LDAP distinguished name that <UserBaseDN>
the RSSE application uses to ou=People, dc=actuate, dc=com
locate the LDAP user object. </UserBaseDN>
When you add a user's name 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.
ChannelSubscription LDAP attribute that specifies the <ChannelSubscriptionListAttr>
ListAttr channels to which an Actuate actuateChannelList
user subscribes. </ChannelSubscriptionListAttr>
In the LDAP directory server, the
attribute is multivalued with a
single channel name for each
value.

114 Administering Actuate iSer ver System

Parameter Description Example
ChannelSubscription Value to use for <ChannelSubscriptionListDefault>
ListDefault ChannelSubscriptionListAttr portfolio update, sales forecasts
when LDAP does not contain a </ChannelSubscriptionList
value for that attribute. Default>

The value is a comma-separated

lists of channel names. For
example:
"portfolio update, sales
forecasts"

PrivilegeTemplate LDAP attribute that specifies <PrivilegeTemplateAttr>

Attr which privilege template to use actuateDefaultPriv
for files and folders that an </PrivilegeTemplateAttr>
Actuate Encyclopedia volume
user creates.
A user permission is a user login
name followed by "=" and a zero
(0) or more permission
characters. A role permission is a
role name followed by tilde (~)
followed by a zero or more
permission characters. The
following table lists the privilege
characters and their meanings.
r read
w write
e execute
d delete
v visible
s secure read
g grant

Chapter 4, Configuring Actuate iSer ver security 115

Parameter Description Example
The format for user privileges is a
user login name followed by an
equals sign (=) and a zero or
more permission characters. The
role permission format is a role
name followed by a tilde (~) and
a zero or more privilege values.
To specify a privilege template
that lists multiple users or roles
in the LDAP directory server, the
attribute must be multivalued
with a single user or role for each
value.
PrivilegeTemplate Value to use for <PrivilegeTemplateDefault>
Default PrivilegeTemplateAttr when viewing only~rv, jbob=rwed
LDAP does not contain a value </PrivilegeTemplateDefault>
for that attribute.
The value is a comma-separated
list of user or role privileges. This
example gives read and visible
privileges to a role called viewing
only and gives read, write,
execute, and delete privileges to a
user named jbob.
AttachReportInEmail LDAP attribute that specifies an <AttachReportInEmailAttr>
Attr Actuate user’s preferred form of actuateEmailForm
e-mail notification. The e-mail </AttachReportInEmailAttr>
can contain either a copy of the
report or a link to the report.
The value is one of the following
options.
included User receives the
report as an
attachment to the
notice, if possible.
linked User receives a link
to the report.

116 Administering Actuate iSer ver System

Parameter Description Example
AttachReportInEmail Value to use for <AttachReportInEmailDefault>
Default AttachReportInEmailAttr when linked
LDAP does not contain a value </AttachReportInEmailDefault>
for that attribute.
The value is either included or
linked. For more information, see
“AttachReportInEmailAttr,”
earlier in this table.
The default value in
ldapconfig_<volume>.xml is
linked.
EmailAddressAttr Name of the LDAP user attribute <EmailAddressAttr>
that specifies an Actuate user’s e- mail
mail address for when Actuate </EmailAddressAttr>
iServer sends e-mail to an
Encyclopedia volume user. For
some object classes, such as
inetorgperson, an e-mail attribute
exists in the standard LDAP
schema.
SendEmailAttr LDAP user attribute that <SendEmailAttr>
specifies when to send an e-mail actuateEmailWhen
notification message to notify an </SendEmailAttr>
Actuate user of the completion of
a report.
The value is one of the following
options.
never Do not notify.
always Notify of failures
and successes.
failures Notify of failures
only.
successes Notify of successes
only.

Chapter 4, Configuring Actuate iSer ver security 117

Parameter Description Example
SendEmailDefault Value to use for SendEmailAttr <SendEmailDefault>
when the LDAP directory server never
does not contain a value for that </SendEmailDefault>
attribute.
Use one of the following values:
never, always, failures, or
successes. For descriptions of
these values, see
“SendEmailAttr,” earlier in this
table.
The default value in
ldapconfig_<volume>.xml is
never.
FailureNotice LDAP attribute that specifies <FailureNoticeExpirationAttr>
ExpirationAttr how long Actuate iServer keeps a actuateFailNoticeExpiration
user’s notices about failed jobs in </FailureNoticeExpirationAttr>
the completed notice folder of the
Encyclopedia volume.
The value is a number of
minutes. A value of 0 (zero)
means that Actuate iServer does
not keep notices about failed
jobs. A value of -1 means that
Actuate iServer keeps the notices
indefinitely.
FailureNotice Value to use for <FailureNoticeExpirationDefault>
ExpirationDefault FailureNoticeExpirationAttr 0
when LDAP does not contain a </FailureNoticeExpirationDefault>
value for that attribute.
The value is a number of
minutes. For more information,
see
“FailureNoticeExpirationAttr,”
earlier in this table.
The default value in
ldapconfig_<volume>.xml is 0.

118 Administering Actuate iSer ver System

Parameter Description Example
SendNoticeAttr LDAP user attribute that <SendNoticeAttr>
specifies when to notify an actuateFolderWhen
Actuate user about the </SendNoticeAttr>
completion of a report
completion by placing a notice in
the completed notice folder of the
Encyclopedia volume.
Use one of the following values.
never Do not notify.
always Notify of failures
and successes.
failures Notify of failures
only.
successes Notify of successes
only.
SendNoticeDefault Value to use for SendNoticeAttr <SendNoticeDefault>
when LDAP does not contain a always
value for that attribute. </SendNoticeDefault>
Use one of the following values:
never, always, successes, or
failures. For more information,
see “SendNoticeAttr,” earlier in
this table.
The default value in
ldapconfig_<volume>.xml is
always.
HomeFolderAttr LDAP attribute that specifies a <HomeFolderAttr>
user’s home folder in the actuateHomeFolder
Encyclopedia volume. </HomeFolderAttr>
There is no default value.
MaxJobPriorityAttr LDAP attribute that specifies an <MaxJobPriorityAttr>
Actuate user’s maximum request actuateMaxPriority
priority. The value is the </MaxJobPriorityAttr>
maximum request priority that
the user can set for a report print
or generation request in the
Encyclopedia volume.
In LDAP, the value must be an
integer between 0 and 1000.

Chapter 4, Configuring Actuate iSer ver security 119

Parameter Description Example
MaxJobPriority Value to use for <MaxJobPriorityDefault>
Default MaxJobPriorityAttr when LDAP 500
does not contain a value for that </MaxJobPriorityDefault>
attribute.
The value must be an integer
between 0 and 1000.
The default value in
ldapconfig_<volume>.xml is 500.
UserObject Name of the LDAP object class <UserObject>
that the Actuate open security inetorgperson
application uses to find Actuate </UserObject>
user names.
An example of an LDAP object
class is inetorgperson.
SuccessNotice LDAP attribute that specifies <SuccessNoticeExpirationAttr>
ExpirationAttr how long Actuate iServer keeps a actuateSuccessNoticeExpiration
user’s success completion notices </SuccessNoticeExpirationAttr>
in the completed notice folder of
the Encyclopedia volume.
The value is a number of
minutes. A value of 0 (zero)
means that Actuate iServer does
not keep notices about successful
jobs. A value of -1 means that
Actuate iServer keeps success
notices indefinitely.
SuccessNotice Value to use for <SuccessNoticeExpirationDefault>
ExpirationDefault SuccessNoticeExpirationAttr 0
when LDAP does not contain a </SuccessNoticeExpiration
value for that attribute. Default>

The value is a number of

minutes. For more information,
see
“SuccessNoticeExpirationAttr,”
earlier in this table.
The default value in
ldapconfig_<volume>.xml is 0.

120 Administering Actuate iSer ver System

Parameter Description Example
ViewPreferenceAttr LDAP attribute that specifies the <ViewPreferenceAttr>
Actuate user’s default viewing actuateViewingPref
preference. </ViewPreferenceAttr>
Use one of the following values:
default or dhtml.
ViewPreference Value to use for <ViewPreferenceDefault>
Default ViewPreferenceAttr when LDAP default
does not contain a value for that </ViewPreferenceDefault>
attribute.
Specify the default viewing mode
using one of the following
values: default or dhtml.
The default value in
ldapconfig_<volume>.xml is
default.

Setting ldapconfig_<volume>.xml parameters

In the Actuate ldapconfig_<volume>.xml file, a parameter is an XML element.
Specify the value for a parameter as shown in the following example:
<parameter-name>value 1, value 2</parameter-name>
where
■ The parameter name is one of the valid parameter names specified in
“Understanding ldapconfig_<volume>.xml parameters,” earlier in this
chapter.
■ A comma separates multiple parameter values.
ldapconfig_<volume>.xml can contain comment comments. Enclose
comments in <!- - and - -> tags, as shown in the following example:
<!--This is the port number on which the LDAP server is listening.-->
For parameter values, Sun ONE Directory Server 5.1 uses LDAP domain
components instead of LDAP organization. For example, for the
USER_BASE_DN parameter, the Netscape Directory Server 4.2 uses the
organization actuate.com:
<UserBaseDN>ou=People, o=actuate.com</UserBaseDN>
For Directory Server 5.1, use the domain components:
<UserBaseDN>ou=People, dc=actuate, dc=com</UserBaseDN>

Chapter 4, Configuring Actuate iSer ver security 121

 For samples of ldapconfig_<volume>.xml parameter specifications, see
“Understanding ldapconfig_<volume>.xml parameters,” earlier in this
chapter.

Resolving LDAP time-out and performance issues

If Actuate iServer uses a Netscape LDAP server, the Netscape LDAP server
can require that an LDAP administrator make some configuration changes for
time-out and performance reasons. For a large LDAP server, an LDAP
administrator can set a time limit on a query, a maximum number of entries to
search, and cache sizes. For information about tuning an LDAP server, see
your Netscape LDAP documentation. For example, using the Netscape
Console 4.1, an LDAP administrator can change both time-out and
performance settings by completing the following tasks in this order:
■ Open the Netscape console.
■ Choose the Console tab.
■ Expand the tree to show the Directory Server (server name) branch.
■ Double click the Directory Server branch to display the Directory Server
window.
■ Choose the Configuration tab to display the Configuration page.
The following LDAP configuration settings can enhance LDAP server
performance when you use an LDAP server with Actuate iServer:
■ On the Configuration page, select the Root Node in the tree view of the
directory server window. Choose Performance. You can change the Size
limit to return a smaller number of entries. For example, reduce the
number to 500 from the default value of 2000 entries. You can also reduce
the maximum amount of time that an LDAP server spends searching.
■ On the Configuration page, select the Database node in the tree view of the
directory server window. Choose Performance. You can control the look-
through limit using the options on Performance. The look-through limit
specifies the maximum number of entries the LDAP server checks when it
performs a search. The default limit is 5000. You can also set the maximum
cache size and maximum number of entries in the cache on this page.
■ From the Configuration page, select the Database node in the tree view of
the directory server window. Choose Indexes. Creating a substring index
for the uid attribute can increase search performance. In the additional
indexes list box, scroll to the uid attribute name and enable substring index.
After this index is created, you can achieve a good response time for a
search over a large database when you use a search string that sufficiently
narrows the search.

122 Administering Actuate iSer ver System

 Using the LDAP Directory Manager
This section describes issues that can arise if you use the LDAP Directory
Manager to communicate with an LDAP server. The default LDAP Directory
Manager installation configures LDAP Directory Manager as the unrestricted
Directory Server user (cn=directory manager). Using the Directory Manager as
the unrestricted Directory Server user has the following implications:
■ Directory Manager ignores all access control instructions (ACIs) in the
database.
■ Operations that Directory Manager performs ignore all Performance
Tuning parameters. For example:
■ Searches that Directory Manager performs ignore the lookthroughlimit
setting, which can result in a search of the entire database for unindexed
and allidsthreshold-hit search conditions.
■ Every possible search result returns, because the sizelimit setting is
ignored.
■ The LDAP Directory Server uses system resources excessively.
Netscape recommends the following strategies to avoid problems related to
the Directory Manager user:
■ Bind the Directory Manager user as the Admin user entry.
■ Create a user in the database strictly used for binding against the Directory
Server.

Importing and exporting data with open security

and the sample Actuate RSSE application
An Encyclopedia volume administrator cannot import data from an
externalized volume to an internalized volume using the Actuate iServer open
server utilities, acexport and acimport. Also, except when using the
-admindata option with acimport, an administrator cannot import data from
an internalized volume to an externalized volume using acexport and
acimport. An externalized Encyclopedia volume uses the Actuate RSSE
application and administration information from an external LDAP directory.
An internalized Encyclopedia volume uses the administration information
that the volume stores internally. For more information about acextern and
acintern, see “Using acextern” and “Using acintern” in Chapter 13, “Working
with Actuate iServer utilities.”

Chapter 4, Configuring Actuate iSer ver security 123

 About the Actuate iServer open utilities and the
sample RSSE application
To use the Actuate iServer open security utilities to update administration
information in an Encyclopedia volume so that user, role, and group
information is available in different Encyclopedia volume security
configurations:
■ The acextern utility updates Encyclopedia volume administration
information that works with the default Actuate iServer System security to
work with an RSSE application that operates at the External Registration
security level. For information about acextern options, see “Using
acextern” in Chapter 13, “Working with Actuate iServer utilities.”
■ The acintern utility updates Encyclopedia volume administration
information that works with the with an RSSE application that operates at
the External Registration security level to work with the default Actuate
iServer System security. For information about acintern options, see “Using
acintern” in Chapter 13, “Working with Actuate iServer utilities.”

Using the Actuate iServer open security utilities

with the sample RSSE application
When you configure Actuate iServer to use the default Encyclopedia volume
security, the Encyclopedia volume stores all security information. Actuate
iServer uses an identifier ID and does not use the name of the user, role, or
group when it assigns privileges and sets other administrative options.
To use the Actuate open security RSSE application and an external security
source, you must replace the internal IDs with the user, role, or group name.
The acextern utility replaces references to Actuate user, role, and group IDs
with their corresponding names. The acextern utility performs this conversion
on the following Encyclopedia volume administration information:
■ Privilege rules, or access control lists (ACLs), for folders and files in the
volume
■ Privilege rules in scheduled requests
■ Privilege rules for a volume’s channels
■ Report request notification settings
■ Scheduled requests
■ Completed requests
After the conversion, the Actuate RSSE application can match the users, roles,
and groups in the Encyclopedia volume to users, roles, and groups in the
external security source.

124 Administering Actuate iSer ver System

The acintern utility modifies the same references as acextern. For each user
name reference in the Encyclopedia volume, acintern looks up the
corresponding Encyclopedia volume ID and changes the reference to an ID. If
there is no corresponding ID, acintern removes the reference.
For information about the Actuate open security RSSE application that ships
with Actuate iServer, see Chapter 16, “Managing Encyclopedia volume
security.”
If you use the -RSSE option with acextern, acextern uses the RSSE application
to validate each Actuate name in the Encyclopedia volume. If the name does
not exist in the external security source, the application removes the reference
to the user or role from the volume.

Converting internal IDs to external names using the

Actuate open security application
To convert existing Encyclopedia volume administration information to a form
that the Actuate open security application can use, complete the following
tasks in this order:
■ Shut down Actuate iServer. For information about shutting down Actuate
iServer, see “Starting or stopping an Actuate iServer node” in Chapter 4,
“Configuring Actuate iServer security.”
■ Use acextern to convert the Encyclopedia volume references from internal
users, roles, and groups to the corresponding external names. For
information about acextern, see “Using acextern” in Chapter 13, “Working
with Actuate iServer utilities.”
■ Change the RSSE configuration to enable external registration of users. For
information about working with the RSSE configuration, see “Using the
Report Server Security Extension” in Chapter 16, “Managing Encyclopedia
volume security.”
■ Start Actuate iServer. For information about starting Actuate iServer, see
“Starting or stopping an Actuate iServer node” in Chapter 4, “Configuring
Actuate iServer security.”

Converting an Encyclopedia volume from using external

information to using internal information
To convert an Encyclopedia volume from using external information to using
internal information, complete the following tasks in this order:
■ Shut down Actuate iServer. For information about shutting down Actuate
iServer, see “Starting or stopping an Actuate iServer node” in Chapter 4,
“Configuring Actuate iServer security.”

Chapter 4, Configuring Actuate iSer ver security 125

 ■ Use acintern to convert the Encyclopedia volume references from external
users, roles, and groups to the corresponding internal names. For
information about acextern, see “Using acintern” in Chapter 4,
“Configuring Actuate iServer security.”
■ Change the RSSE configuration to disable external registration of users. For
information about working with the RSSE configuration, see “Using the
Report Server Security Extension” in Chapter 16, “Managing Encyclopedia
volume security.”
■ Start Actuate iServer. For information about starting Actuate iServer, see
“Starting or stopping an Actuate iServer node” in Chapter 4, “Configuring
Actuate iServer security.”

About the parameters for ldap.conf and the

parameters for the RSSE library application
The following table lists the RSSE web service parameters and the
corresponding RSSE Library parameter.

RSSE web service RSSE library

ldapconfig.xml parameter ldap.conf parameter
AdminRole ADMIN_ROLE_NAME
AllRole ALL_ROLE_NAME
GroupBaseDN GROUP_BASE_DN
GroupObject GROUP_OBJECT
GroupToNotify GROUP_TO_NOTIFY
OperatorRole OPERATOR_ROLE_NAME
Port PORT
QueryAccount QUERY_ACCOUNT
QueryPassword QUERY_PASSWORD
RoleBaseDN ROLE_BASE_DN
RoleObject ROLE_OBJECT
Server SERVER
UserBaseDN USER_BASE_DN
ChannelSubscriptionListAttr USER_CHANNEL_LIST_ATTR
ChannelSubscriptionList USER_CHANNEL_LIST_DEFAULT
Default
PrivilegeTemplateAttr USER_DEFAULT_PRIV_ATTR
PrivilegeTemplateDefault USER_DEFAULT_PRIV_DEFAULT

126 Administering Actuate iSer ver System

RSSE web service
ldapconfig.xml parameter
AttachReportInEmailAttr
AttachReportInEmailDefault
EmailAddressAttr
SendEmailAttr
SendEmailDefault
FailureNoticeExpirationAttr
FailureNoticeExpiration
Default
SendNoticeAttr
SendNoticeDefault
HomeFolderAttr
Not applicable in Release 8
Not applicable in Release 8
MaxJobPriorityAttr
MaxJobPriorityDefault
UserObject
SuccessNoticeExpirationAttr
SuccessNoticeExpiration
Default
ViewPreferenceAttr
ViewPreferenceDefault
Chapter 4, Configuring Actuate iSer ver security
RSSE library
ldap.conf parameter
USER_EMAIL_FORM_ATTR
USER_EMAIL_FORM_DEFAULT
USER_EMAIL_ID_ATTR
USER_EMAIL_WHEN_ATTR
USER_EMAIL_WHEN_DEFAULT
USER_FAIL_NOTICE
_EXPIRATION_ATTR
USER_FAIL_NOTICE_EXPIRATION
_DEFAULT
USER_FOLDER_WHEN_ATTR
USER_FOLDER_WHEN_DEFAULT
USER_HOME_FOLDER_ATTR
USER_MAX_COMPLETED_ATTR
USER_MAX_COMPLETED_DEFAULT
USER_MAX_PRIO_ATTR
USER_MAX_PRIO_DEFAULT
USER_OBJECT
USER_SUCCESS
_NOTICE_EXPIRATION_ATTR
USER_SUCCESS
_NOTICE_EXPIRATION_DEFAULT
USER_VIEWING_PREF_ATTR
USER_VIEWING_PREF_DEFAULT
127
128 Administering Actuate iSer ver System
 Part

Administering
Part 3
3
Actuate iServer services

Par t 3, Admin iste rin g Actu ate iSer ver se r vices 129
130 Administering Actuate iSer ver System
 Chapter

Actuate iServer System

Chapter5
5
administration overview
This chapter contains the following topics:
■ About Actuate iServer System administration
■ About general Actuate iServer administration tasks
■ Logging in to Actuate iServer System
■ About the System Administration console
■ Modifying the System Administration console display settings
■ Understanding Actuate iServer status
■ Changing advanced Actuate iServer System settings
■ Setting up and administering an Actuate iServer System cluster
■ Understanding file system failover
■ Managing an Actuate iServer cluster
■ Changing start-up parameters for Actuate iServer
■ Understanding Actuate iServer System online archive functionality
■ Consolidating Actuate iServer usage and error log data
■ Working with information objects and caching

Chapter 5, Actuate iSer ver System administration overview 131

About Actuate iServer System administration
This chapter describes Actuate iServer System administration tasks that an
Actuate iServer System administrator performs in an Actuate iServer System
cluster and on Actuate iServer in a stand-alone configuration. This chapter
also discusses working with the System Administration console.
Before you can manage Actuate iServer, you must:
■ Log in to Actuate iServer System as Administrator using Actuate
Management Console. For information about logging in to Actuate iServer
System, see “Logging in to Actuate iServer System,” later in this chapter.
■ Start Actuate iServer System, if necessary. For information about starting
Actuate iServer System, see “Starting or stopping an Actuate iServer
node,” later in this chapter.

About Actuate iServer System administration

tasks
As an Actuate iServer System administrator, the tasks you perform for both an
Actuate iServer cluster and Actuate iServer in a stand-alone configuration
include:
■ Configuring Actuate iServer parameters. For information, see Chapter 7,
“Working with an Actuate iServer System server,” and Chapter 14, “Setting
Actuate iServer parameters.”
■ Adding and configuring an Encyclopedia volume. For information, see
“Adding and configuring an Encyclopedia volume” in Chapter 5, “Actuate
iServer System administration overview.”
■ Adding and configuring a disk partition. For information, see “Adding a
partition” and Configuring an Actuate iServer System partition in Chapter
8, “Working with an Actuate iServer System partition.”
■ Removing a disk partition. For information, see “Removing an Actuate
iServer System partition” in Chapter 8, “Working with an Actuate iServer
System partition.”
■ Removing an Encyclopedia volume. For information, see “Removing an
Encyclopedia volume from Actuate iServer System” in Chapter 9,
“Working with an Actuate iServer System volume.”
■ Moving an Encyclopedia volume. For information, see “Moving an
Encyclopedia volume” in Chapter 9, “Working with an Actuate iServer
System volume.”
■ Adding and configuring third-party software and hardware.

132 Administering Actuate iSer ver System

 ■ Configuring Actuate iServer to use e-mail. For information, see “Setting up
e-mail notification” in Chapter 2, “Setting up Actuate iServer System
hardware.”

About Actuate iServer System cluster

administration tasks
In addition to the tasks listed in “About Actuate iServer System administration
tasks,” earlier in this chapter, an Actuate iServer System cluster administrator
must complete the following tasks:
■ Creating an Actuate iServer cluster. For information, see “Setting up and
administering an Actuate iServer System cluster,” later in this chapter.
■ Starting an existing Actuate iServer cluster. For information, see “Starting
or stopping an Actuate iServer node,” later in this chapter.
■ Adding and configuring Actuate iServer nodes. For information, see
“Adding a new Actuate iServer node to a cluster,” later in this chapter.
■ Configuring Actuate iServer cluster for volume failover. For information,
see “About the Actuate iServer cluster configuration file,” later in this
chapter.
■ Removing a node. For information, see “Removing a node from an Actuate
iServer cluster,” later in this chapter.

About general Actuate iServer administration tasks

Configuration tasks that an administrator performs for Actuate iServer in both
cluster and stand-alone configurations include:
■ Modifying service parameter values to override the current or default
settings. For information, see the appropriate chapter in Chapter 7,
“Working with an Actuate iServer System server”:
■ “Setting Message Distribution service parameter values”
■ “Setting View service parameter values”
■ “Specifying Factory service parameter values”
■ Modifying other server properties to override the current or default
settings. For information, see “Modifying general Actuate iServer
parameter values” in Chapter 6, “Working with system-wide Actuate
iServer parameters,” and “About server parameters for Actuate iServer
System” in Chapter 7, “Working with an Actuate iServer System server.”
■ Specifying paths to file systems, as necessary.

Chapter 5, Actuate iSer ver System administration overview 133

 Understanding Actuate iServer ports
Actuate iServer uses ports to communicate with Actuate iServer processes,
with other nodes in an Actuate cluster, and with other applications such as
web servers and application servers.
The following table lists the ports that the default installation configures for
Actuate iServer.

Name and activity Default port

Ports listed on Servers—Properties—General
Daemon listen port for Actuate Process Manager 8100
Actuate Application Container process listen port for 8900
Management Console, web services, and other
Actuate iServer functionality.
Internal server port for communication with other 9010
Actuate iServer nodes in a cluster
Server port base for internal communication on the 9300 (TCP)
Actuate iServer machine
Ports listed on Servers—Properties—Message Distribution Service
Message distribution, which the Message Distribution 8000
service uses
Ports listed on Servers—Properties—Advanced
Chartserver port for generating charts in Actuate Basic 9302
reports
Actuate e.Spreadsheet port for generating 1569
e.Spreadsheet Designer spreadsheet report output
Port number for Factory server heartbeat 9301
Actuate Process Manager port for communication 9200
with Actuate Process Manager
Ports listed on System—Properties—General in a cluster configuration
System UDP port, which an Actuate iServer cluster 9300 (UDP)
uses for heartbeat communication
System multicast port, which all Actuate iServer 9300 (UDP)
nodes in a cluster use when they use Multicast
communication

The System IP address and System port specify the address and port that users
and applications use to communicate with Actuate iServer System. You must
specify the system IP address and port, regardless of whether Actuate iServer
is in a stand-alone configuration or a cluster.

134 Administering Actuate iSer ver System

The Server IP address and Server port specify the address and port that
Actuate iServer uses to communicate internally within Actuate iServer
System. For example, Actuate iServer uses this port to receive heartbeat
messages.
The Daemon IP address and Daemon port specify the address and port that
Actuate Process Manager uses.
If the Actuate installation routine detects port conflicts during installation, the
routine uses different ports. For information about Actuate iServer installation,
see Installing Actuate iServer System.
You can change the ports that Actuate iServer uses by setting parameters using
the System Administration console in Actuate Management Console. For
example, you can change the ports that Actuate iServer uses to communicate
with other Actuate iServer nodes in a cluster or the port Actuate iServer
System uses for cluster heartbeat communication.
To change the Actuate Process Manager port, change the DaemonSOAPPort
parameter in acpmdconfig.xml. DaemonSOAPPort is a child element of
PMDConfig. After you make the change, restart Actuate Process Manager.
The following example sets the Actuate Process Manager port to 9201:
<PMDConfig>
…
<DaemonSOAPPort>9201</DaemonSOAPPort>
…
</PMDConfig>
For information about configuring other Actuate iServer ports, such as the
cluster communication port and the Message distribution port, see “Managing
an Actuate iServer cluster,” later in this chapter.
For information about advanced Actuate iServer parameters, such as the
Actuate e.Spreadsheet port and the Chartserver port, see Chapter 14, “Setting
Actuate iServer parameters.”

About stand-alone Actuate iServer setup

To set up Actuate iServer in a stand-alone configuration, you complete the
following general steps in this order:
■ Install the stand-alone server. As part of installation, you:
■ Configure the server.
■ Specify server and volume settings other than defaults.
■ If necessary, start Actuate Process Manager.
The default configuration starts Process Manager.

Chapter 5, Actuate iSer ver System administration overview 135

 ■ If necessary, use Actuate Management Console to start Actuate iServer.
The default configuration starts Process Manager at system startup. Process
Manager starts the Actuate iServer services.
■ Log in to the server for further configuration, if necessary.
The following items are characteristics of stand-alone Actuate iServer
configuration:
■ By default, when Actuate iServer starts in a stand-alone configuration, it
takes the Encyclopedia volume online.
■ When adding file system entries, you must specify fully qualified paths.
■ Actuate iServer System stores the stand-alone Actuate iServer
configuration information in its machine’s configuration file.

About Encyclopedia volume directory structure

An Encyclopedia volume is completely self-contained. All the files that
compose the volume and describe the volume’s state reside in a directory
structure that is independent from the Actuate iServer executable files.
When you create an Encyclopedia volume, the first partition the volume uses
is the primary partition. The primary partition contains all Encyclopedia
volume directories. If you configure the Encyclopedia volume to use
secondary partitions, Actuate iServer uses the secondary partitions to hold
report executable files and report documents. For more information about
partitions, see Chapter 8, “Working with an Actuate iServer System partition.”
For information about working with Encyclopedia volumes using the System
Administration console, see Chapter 9, “Working with an Actuate iServer
System volume.”
The following sections describe the volume’s directory structure.

About Encyclopedia volume metadata directories

An Encyclopedia volume’s metadata directories hold the metadata for the
volume. An Encyclopedia volume’s metadata describes the volume’s security
configuration, file organization, job information, and other administrative
data.
The location of the metadata directories is in the primary partition specified on
Volumes—Properties—General in the System Administration console. For
information about Volumes—Properties—General, see “Adding and
configuring an Encyclopedia volume” in Chapter 9, “Working with an Actuate
iServer System volume.”

136 Administering Actuate iSer ver System

The default Encyclopedia volume directory is $AC_SERVER_HOME/encyc.
The following list describes the metadata directories:
■ The db directory contains volume configuration and administration
information.
■ The fileType directory stores images and property files for Actuate file
types.
■ The status directory stores active job status information.

About the Encyclopedia volume file directory

Actuate iServer stores the content of volume files directly as files in the
operating system's file system. All volume files have the .dat file-name
extension in the file system, regardless of their Actuate file type. The partition
that you specify on Volumes—Properties—Partitions determines the location
of the root directory for volume files. By default, the root directory for
Encyclopedia volume files is $AC_SERVER_HOME/encyc/file. For
information about Volumes—Properties—Partitions, see “Assigning a
partition to an Encyclopedia volume” in Chapter 9, “Working with an Actuate
iServer System volume.”
An operating system limits the number of files that an Actuate iServer
machine can effectively store and manage in a directory. An Encyclopedia
volume supports using multiple partitions. Using multiple partitions, an
administrator can distribute an Encyclopedia volume’s files among multiple
physical devices. Actuate iServer transparently manages the allocation of files
among partitions. For information about partitions, see Chapter 8, “Working
with an Actuate iServer System partition.”

About the Encyclopedia volume log directory

The volume log directory stores the Encyclopedia volume database log file.
The partition that you specify in Transaction log path on Volumes—
Properties—General determines the location of the log files. By default, the
directory is $AC_SERVER_HOME/encyc/transLog. For information about
Volumes—Properties—General, see “Adding and configuring an
Encyclopedia volume” in Chapter 9, “Working with an Actuate iServer System
volume.”

About the Actuate iServer System configuration

file
Actuate iServer System handles configuration for both a cluster and a stand-
alone system. The default location for the configuration file is in
$AC_SERVER_HOME/etc. In an Actuate iServer System cluster, the cluster

Chapter 5, Actuate iSer ver System administration overview 137

 configuration file resides in the etc directory on the cluster master. The Actuate
iServer license file, acserverlicense.xml, also resides in this directory.
For example, on a Windows NT system that uses the default installation, the
location of the configuration file is:
C:\Program Files\Actuate7\Server\etc
When Actuate Process Manager starts Actuate iServer, it supplies the
configuration file location. Actuate iServer in a stand-alone configuration
reads the configuration file to configure itself. In a cluster, Process Manager
supplies additional arguments to specify which server is the cluster master, so
that the server can join the cluster.
To specify a different location for the Actuate iServer configuration file, select a
different partition in Configuration home on System—Properties—General.
For more information about System—Properties—General, see “Modifying
general Actuate iServer parameter values” in Chapter 6, “Working with
system-wide Actuate iServer parameters.” Changing the location of the
configuration file can change Actuate iServer System startup. For information
about Actuate iServer System startup, see “Working with offline Actuate
iServer,” earlier in this chapter.
When you change the Configuration home parameter value, Actuate iServer
writes acserverconfig.xml file and acserverlicense.xml to the partition. Actuate
iServer System renames the old acserverconfig.xml file and the old
acserverlicense.xml file to acserverconfig.xml.yyyy_mm_dd and
acserverlicense.xml.yyyy_mm_dd respectively, where yyyy, mm, and dd are
the year, month, and day of the date on which Actuate iServer System renames
the files.

About the stand-alone Actuate iServer configuration file

Actuate iServer in a stand-alone configuration owns its configuration file. The
configuration file holds the configuration information for Actuate iServer and
any Encyclopedia volumes that Actuate iServer manages. The configuration
information includes the configuration information for the Message
Distribution, Factory, View, and Encyclopedia services that Actuate iServer
controls. The information also includes partition, open security, and printer
information for the volumes that Actuate iServer manages.

About the Actuate iServer cluster configuration file

In an Actuate iServer System cluster, the Actuate iServer System configuration
file contains configuration information for all Actuate iServer nodes and
Encyclopedia volumes in the cluster.
The cluster master owns the configuration file for an Actuate iServer System
cluster. The cluster master sends to the nodes all relevant configuration

138 Administering Actuate iSer ver System

information, such as any Encyclopedia volumes the node owns, which Actuate
iServer services the node runs, and other parameter values.

Setting locales and time zones

There are three places in which you can specify a time zone to use in Actuate
iServer System:
■ Login page controls the locale and time zone when the user logs in to the
Actuate iServer System. This value overrides the settings on Options—
General. For more information about logging in to Actuate iServer System,
see “Logging in to Actuate iServer System,” later in this chapter.
■ The settings on Options—General control the browser’s default locale and
time zone. The machine that runs the browser stores this setting locally. For
more information about Options—General, see “Changing locale and time
zone settings for Actuate iServer System,” later in this chapter.
■ System—Properties—Regional Settings controls the Actuate iServer
System’s regional settings. For more information about System—
Properties—Regional Settings, see “Configuring default regional settings”
in Chapter 6, “Working with system-wide Actuate iServer parameters.”

Monitoring Actuate iServer System

Actuate iServer supports capturing monitoring and error information in log
files to help an administrator understand Actuate iServer resource usage.
Using this functionality also helps improve the efficiency of resource
management and utilization and helps resolve Actuate iServer problems, if
they occur.
Using log files affects Actuate iServer performance. Writing more detailed
information to log files decreases Actuate iServer performance and increases
disk space usage by creating larger log files.
The following topics discuss how to enable and configure Actuate iServer
System logging and how to interpret the log files:
■ “Configuring and using system usage logging” in Chapter 6, “Working
with system-wide Actuate iServer parameters”
■ “Configuring and using error logging” in Chapter 6, “Working with
system-wide Actuate iServer parameters”
■ “Configuring and using diagnostic logging” in Chapter 7, “Working with
an Actuate iServer System server”

Chapter 5, Actuate iSer ver System administration overview 139

Logging in to Actuate iServer System
To log in to the System Administration console as an Actuate iServer System
administrator, use Actuate Management Console. To administer an Actuate
iServer System cluster, you log in to the System Administration console for the
cluster master.
To administer Actuate iServer System as an Actuate iServer System
administrator, you must log in to the System Administration console using the
Actuate iServer System administrator’s password. The Actuate iServer System
administrator’s password typically differs from the Encyclopedia volume
administrator’s password.
The Actuate Management Console login page looks like the one in the
following illustration.

The following table describes the Actuate Management Console login fields.

Field Description
Language Select the language to use in Actuate Management
Console.
Login to Select System Administration to log in to the
System Administration console. Select an
Encyclopedia volume name to log in to the
Volume Administration console for that volume.
For information about logging in to an Actuate
iServer System Encyclopedia volume, see
“Connecting to an Encyclopedia volume” in
Chapter 15, “Understanding Encyclopedia
volume administration.”
Password Type the password for the Actuate iServer System
administrator’s user account. The default value is
no password.

140 Administering Actuate iSer ver System

Field Description
Time zone Select a time zone to use in Actuate Management
Console.
User name Displays the Actuate iServer System
administrator’s user name. The value is
Administrator.

For information about changing the default login setup, see Chapter 6,
“Working with system-wide Actuate iServer parameters.”

Logging in to the System Administration console

To administer Actuate iServer System, log in to the System Administration
console as the Actuate iServer System administrator.

How to log in to the System Administration console

1 To display the Actuate Management Console login page, access an Actuate
iServer System URL using a web browser. For example, the following URL
displays the login page for Actuate iServer running on a machine called
urup:
http://oxen:8900/acadmin/login.jsp?serverURL=http://urup:8000&
daemonURL=http://urup:8100
For serverURL and daemonURL, type valid URLs that point to the
system’s Actuate iServer and Process Manager.
The Actuate Management Console login page appears.
2 Supply the necessary values to log in to the System Administration console
as an Actuate iServer System administrator.
3 Choose Log In.
After you log in to the System Administration console, System—Status
appears. For more information about System—Status, see “Understanding
Actuate iServer status,” later in this chapter.

Specifying the cluster master during cluster

startup
You can specify the Actuate iServer cluster master when you start up an
Actuate iServer cluster by specifying the serverURL and daemonURL
parameters when you log in to Actuate Management Console for the cluster.

Chapter 5, Actuate iSer ver System administration overview 141

 For information about changing the cluster master using the graphical user
interface, see “Changing the cluster master” in Chapter 7, “Working with an
Actuate iServer System server.”
Ensure that the Actuate iServer node that will be the Actuate iServer cluster
master meets the following conditions:
■ The node is part of the cluster.
■ The node can access the configuration home partition.
For example, a cluster uses a cluster master called urup. You use the following
URL to access the Actuate Management Console login page for urup:
http://oxen:8900/acadmin/login.jsp?serverURL=http://urup:8000&
daemonURL=http://urup:8100
If you stop the Actuate iServer cluster and log out of Actuate Management
Console for the cluster master called urup, you can access the Actuate
Management Console login page for a cluster master called ellis using the
following URL:
http://oxen:8900/acadmin/login.jsp?serverURL=http://ellis:8000&
daemonURL=http://ellis:8100
When you restart the Actuate iServer cluster, it uses the Actuate iServer node
called ellis as the cluster master.

About the System Administration console

The following standard buttons appear on most pages in the System
Administration console:
■ Choose OK to accept changes.
■ Choose Apply to accept changes and refresh the current page with the
updated values.
■ Choose Cancel to discard changes.
For information about working with a particular part of the System
Administration console, see the appropriate topic:
■ Chapter 6, “Working with system-wide Actuate iServer parameters”
■ Chapter 7, “Working with an Actuate iServer System server”
■ Chapter 8, “Working with an Actuate iServer System partition”
■ Chapter 9, “Working with an Actuate iServer System volume”
■ Chapter 10, “Adding and configuring an Actuate iServer System resource
group”

142 Administering Actuate iSer ver System

 ■ Chapter 11, “Adding and configuring an Actuate iServer System printer”

Modifying the System Administration console

display settings
Aa an Actuate iServer System administrator, you can choose Options in the
banner of the System Administration console, as shown in the following
illustration, to specify which language and time zone to use for Actuate
iServer System. You can also specify other options, such as which columns
appear when you view a list of Actuate iServer cluster nodes.
Options

Chapter 5, Actuate iSer ver System administration overview 143

 Changing locale and time zone settings for
Actuate iServer System
On Options—General in the System Administration console, you can specify
the locale and time zone to use for Actuate iServer System.

The following table describes the parameters that appear on Options—

General.

Parameter Description
Locale Locale the user selects during log in. This locale
appears on the Actuate Management Console
login page. If a user does not specify a value for
this parameter during login, Actuate iServer reads
the locale from the user’s web browser cookie.
Time zone Time zone the user selects during log in. This time
zone appears on the Actuate Management
Console login page. If a user does not specify a
value for this parameter during login, Actuate
iServer reads the time zone from the user’s web
browser cookie.

For more information about the parameters on the Actuate Management

Console login page, see “Logging in to Actuate iServer System,” earlier in this
chapter.
For more information about setting locales and time zones, see “Setting locales
and time zones,” earlier in this chapter.

144 Administering Actuate iSer ver System

How to change the default locale and time zone settings for
Actuate iServer System
1 In the System Administration console, choose Options.
Options—General appears.
2 Select a locale and time zone from the drop-down lists. Choose OK.

Changing the list of Actuate iServer System nodes

On Options— Servers in the System Administration console, you can specify
which columns appear when you view the list of server nodes in an Actuate
iServer cluster. The list of servers appears on Servers in the System
Administration console.

On Options—Servers, an Actuate iServer System administrator can access the

following functionality:
■ Use the left and right arrows to move column names between Available
columns and Selected columns. The columns that appear in Selected
columns are the columns that Actuate iServer displays.
■ Use the up and down arrows to change the order in which the selected
columns appear.

Chapter 5, Actuate iSer ver System administration overview 145

 The following table describes the columns available for display.

Column name Description

Actuate version Actuate iServer release number.
Current requests Current number of active jobs.
Description Description field from the Actuate iServer
definition.
Name Name of the Actuate iServer machine. This is a
required column.
Operating system and Server machine’s operating system and version.
version
Status Current status of the Actuate iServer machine.
Status can be master, online, offline, or stopping.
For a description of each of the possible states, see
“Understanding Actuate iServer status,” later in
this chapter. Status also lists the services that are
configured for Actuate iServer on the specified
machine:
■ M for Message Distribution service
■ F for Factory service
■ V for View service
■ E for Encyclopedia service
■ C for Caching service.
■ I for Integration service
A flag appears when you must restart Actuate
iServer to apply updates to the Actuate iServer
configuration.
This column is a required column.

How to change the display settings for the list of Actuate iServer
nodes in a cluster
1 In the System Administration console, choose Options.
Options—General appears.
2 Choose Servers.
Options—Servers appears.

146 Administering Actuate iSer ver System

3 Change the column display options:
■ To add columns to the list of nodes, select the columns in Available
Columns. Choose the right arrow to move the selected columns to
Selected Columns.
■ To remove columns from the list of nodes, select the columns in Selected
Columns, and choose the left arrow.
■ To change the order in which the columns appear in the list of nodes,
select a column in Selected Columns, and choose the up or down arrow
to reposition the column in the list. The order in which the columns
appear in Selected Columns is the order in which the columns appear
on Servers.
Choose OK.

Changing the list of Encyclopedia volumes

On Options— Volumes in the System Administration console, you can specify
which columns appear when you view the list of volumes that Actuate iServer
System manages. The list of Encyclopedia volumes appears on Volumes in the
System Administration console.

On Options—Volumes, an Actuate iServer System administrator can access

the following functionality:
■ Use the left and right arrows to move column names between Available
columns and Selected columns. The columns that appear in Selected
columns are the columns that Actuate iServer displays.

Chapter 5, Actuate iSer ver System administration overview 147

 ■ Use the up and down arrows to change the order in which the selected
columns appear.
The following table describes the columns available for display.

Column name Description

Backup owner Names of the Encyclopedia volume’s backup
Actuate iServer nodes. This column displays
nothing in a stand-along Actuate iServer
configuration.
Description Description field from the Encyclopedia volume
definition.
Name Name of the Encyclopedia volume. This is a
required column.
Primary owner Name of the Actuate iServer machine that
manages the Encyclopedia volume.
Status Current status of the Encyclopedia volume. The
status of the Encyclopedia volume is online or
offline. This is a required column.

For more information about working with Actuate iServer System volumes,
see Chapter 9, “Working with an Actuate iServer System volume.”

How to change the display settings for the list of Encyclopedia

volumes
1 In the System Administration console, choose Options.
Options—General appears.
2 Choose Volumes.
Options—Volumes appears.
3 Change the column display options:
■ To add columns to the list of Encyclopedia volumes, select the columns
in Available Columns. Choose the right arrow to move the selected
columns to Selected Columns.
■ To remove columns from the list of Encyclopedia volumes, select the
columns in Selected Columns, and choose the left arrow.
■ To change the order in which the columns appear in the list of
Encyclopedia volumes, select a column in Selected Columns, and
choose the up or down arrow to reposition the column in the list. The
order in which the columns appear in Selected Columns is the order in
which the columns appear on Volumes.
Choose OK.

148 Administering Actuate iSer ver System

Changing the list of Actuate iServer System
partitions
On Options—Partitions, you can specify which columns appear when you
view the list of partitions that Actuate iServer System uses. The list of
partitions appears on Partitions in the System Administration console.

On Options—Partitions, an Actuate iServer System administrator can access

the following functionality:
■ Use the left and right arrows to move column names between Available
columns and Selected columns. The columns that appear in Selected
columns are the columns that Actuate iServer displays.
■ Use the up and down arrows to change the order in which the selected
columns appear.
The following table describes the columns available for display.

Column name Description

Name Name of the partition. This is a required column.

Chapter 5, Actuate iSer ver System administration overview 149

 Column name Description
Status Status of the partition. The status is active,
phaseout, unavailable, or unused. For
descriptions of these states, see “Configuring an
Actuate iServer System partition” in Chapter 8,
“Working with an Actuate iServer System
partition.”
Volume Name of the Encyclopedia volume that uses the
partition.

For more information about working with partitions, see “Working with an
Actuate iServer System partition.”

How to change the display settings for the list of Actuate iServer
System partitions
1 In the System Administration console, choose Options.
Options—General appears.
2 Choose Partitions.
Options—Partitions appears.
3 Change the column display options:
■ To add columns to the list of partitions, select the columns in Available
Columns. Choose the right arrow to move the selected columns to
Selected Columns.
■ To remove columns from the list of partitions, select the columns in
Selected Columns, and choose the left arrow.
■ To change the order in which the columns appear in the list of
partitions, select a column in Selected Columns, and choose the up or
down arrow to reposition the column in the list. The order in which the
columns appear in Selected Columns is the order in which the columns
appear on Partitions.
Choose OK.

150 Administering Actuate iSer ver System

Changing the list of Actuate iServer System
printers
On Options—Printers, you can specify which columns appear when you view
the list of printers in a cluster.

The following table describes the column available for display.

Column name Description

Name Name of the printer. This is a required column.

Viewing Actuate Management Console and

Actuate iServer System release information
On Options—About, you can view general information about Actuate
Management Console and Actuate iServer System, as shown in the following
illustration.

Chapter 5, Actuate iSer ver System administration overview 151

Understanding Actuate iServer status
After you log in to the System Administration console, System—Status
appears, displaying information about Actuate iServer. System—Status
displays Actuate iServer status and supports cluster-level management and
cluster creation.

System—Status displays the following information about Actuate iServer:

■ Actuate iServer machine name and its current status
■ Release and build number of Actuate iServer
■ Version of the current web server
■ Name and version of the application server that runs Actuate Management
Console

152 Administering Actuate iSer ver System

For example, in the following illustration, System—Status indicates that an
Actuate iServer machine called Manager system is online. Manager system is
running Actuate Release 8.

The following table describes the possible Actuate iServer states that appear
on System—Status.

State Definition
Failed Actuate iServer failed at some point in the startup
routine or crashed during normal operation.
Offline Actuate iServer successfully completed its
shutdown routine.
Online Actuate iServer successfully completed the
startup routine. If Actuate iServer is a cluster
node, it joins the cluster.
Starting Actuate iServer is going through the startup
process. This is a transition state.
Stopping Actuate iServer is going through its shutdown
routine. This is a transition state.

For information about working with online Actuate iServer, see “Working
with online Actuate iServer” later in this chapter.
For information about working with offline Actuate iServer, see “Working
with offline Actuate iServer,” later in this chapter.

Working with online Actuate iServer

If a stand-alone Actuate iServer machine or an Actuate iServer cluster node is
online, System—Status looks like the one in the following illustration.

Chapter 5, Actuate iSer ver System administration overview 153

 When Actuate iServer is online, an administrator can access the following
functionality on System—Status:
■ Choose Stop to stop Actuate iServer. Choosing Stop for a cluster master
stops the entire cluster. For more information about stopping an Actuate
iServer node, see “Starting or stopping an Actuate iServer node,” later in
this chapter.
■ Choose Properties to view System—Properties and modify Actuate iServer
System property values. For information about Actuate iServer System
properties, see the corresponding topic in Chapter 6, “Working with
system-wide Actuate iServer parameters”:
■ “Modifying general Actuate iServer parameter values”
■ “Setting up cluster master failover”
■ “Configuring and using system usage logging”
■ “Configuring and using error logging”
■ “Managing Actuate iServer e-mail notification”
■ “Configuring default regional settings”
■ “Working with Actuate iServer System license information”
■ Choose Create Cluster to create a new cluster. For more information about
creating a cluster, see “Setting up and administering an Actuate iServer
System cluster,” later in this chapter.
When Actuate iServer is a cluster node, this button is unavailable. If the
node running the Message Distribution service is already part of a cluster, a
message appears. The message states that you cannot create a new cluster
with this server as the cluster master.

154 Administering Actuate iSer ver System

Working with offline Actuate iServer
If a stand-alone Actuate iServer machine or an Actuate iServer cluster node is
offline, System—Status looks like the one in the following illustration.

When Actuate iServer is offline, an administrator can access the following

functionality on System—Status:
■ Choose Modify Start Parameters to modify the start-up parameters for
Actuate iServer.
■ Choose Start to start Actuate iServer. The following situations control how
Actuate iServer starts:
■ If Actuate iServer is in a stand-alone configuration, starting the Actuate
iServer machine starts Actuate iServer.
■ If the Actuate iServer machine is the cluster master, you can specify that
starting the Actuate iServer machine starts Actuate iServer. After you
start Actuate iServer for the cluster master, you can start the other
Actuate iServer nodes in the Actuate iServer System cluster.
■ If the Actuate iServer machine is a cluster node that is not a cluster
master, and the node has access to the cluster configuration file, Actuate
iServer does not start. The node must access the configuration file to
verify that it is a node before it can start.
■ If you installed Actuate iServer in the stand-alone configuration before
you added it as a node in a cluster, and it does not have access to the
cluster configuration file, Actuate iServer starts as a stand-alone server
and uses the stand-alone configuration file on the Actuate iServer
machine.
For more information about starting an Actuate iServer node, see “Starting
or stopping an Actuate iServer node,” later in this chapter.

Chapter 5, Actuate iSer ver System administration overview 155

Changing advanced Actuate iServer System
settings
The following sections provide a general overview of the tasks involved in
working with Actuate iServer System parameters:
■ About groups of advanced server properties
■ Adding or removing a property value for a list of values
■ Adding or removing a set of values for an entry
■ Restarting after changing Actuate iServer settings

About groups of advanced server properties

The following illustration shows an Advanced properties page in the System
Administration console. An Advanced properties page displays advanced
properties in groups. The following illustration shows Servers—Properties—
Advanced.

156 Administering Actuate iSer ver System

To display the contents of a group, choose the group name. When you choose
the group name, the next level of groupings appears below the group name.
For example, to display the subgroups in the General Server properties group,
choose General server properties.
The following illustration shows the property value specification page for
groups of Actuate iServer properties.

On the property value specification page for a group of properties, an Actuate

iServer System administrator can access the following functionality:
■ Select an option to enable it.
■ Deselect an option to disable it.
■ Type a value for an option that uses a single value.
For example, in the preceding illustration, the Actuate iServer administrator
can enable or disable Actuate iServer properties in three property groups. The
administrator can also type the maximum percentage value that Actuate
e.Analysis uses to determine when to combine pie segments in a e.Anaysis pie
chart.

Chapter 5, Actuate iSer ver System administration overview 157

 Adding or removing a property value for a list of
values
For a property that requires a list of values, the values appear in a list similar
to the one in following illustration.

How to add a value to the list of values for an advanced property

To add a value to the list of values for an advanced property, type the value in
the text box and choose Add. The value appears in the list.

How to remove a value from the list of values for an advanced

property
To remove a value from the list of values for an advanced property, select the
value in the list box and choose Remove.

Adding or removing a set of values for an entry

For an entry that requires a set of values, each entry looks similar to the ones in
the following illustration, which shows the open server interface file type
property values on Servers—Properties—Advanced. In the following
illustration, each open server file type entry consists of a set of values that
define the open server file type.

158 Administering Actuate iSer ver System

On a page that displays a set of values for an advanced Actuate iServer System
property, an Actuate iServer System administrator can access the following
functionality:
■ Choose Delete to delete a set of values. For example, to delete the values for
the SQT file type, select Delete.
■ Choose Add to add a new entry to the list of entries.
■ Choose an existing entry to edit the entry. When you choose entry, the
entry’s values appear in a separate dialog box. For example, the following
illustration displays the open server interface file type values.

Chapter 5, Actuate iSer ver System administration overview 159

 In the fields on the dialog box, type the values. In some cases, if you do not
type a value, Actuate iServer uses a default value.

Restarting after changing Actuate iServer settings

Changing an Actuate iServer System property value can require one of the
following types of restart:

Type of restart Description

Encyclopedia volume Take volume offline and put online.
Server Restart Actuate iServer node.
Actuate iServer System Stop and start Actuate iServer system.

For a Actuate iServer System in a stand-alone configuration, a server restart is

the same as an Actuate iServer System restart.

Setting up and administering an Actuate iServer

System cluster
When you create an Actuate iServer cluster, you first create a single-node
cluster. After you create the cluster, you can configure the cluster and add
Actuate iServer nodes and Encyclopedia volumes.
When you create an Actuate iServer cluster, the Actuate iServer you use to
create the cluster becomes the cluster master. Creating an Actuate iServer
cluster enables the Message Distribution service on the cluster master and
creates a default configuration file.

160 Administering Actuate iSer ver System

The Actuate iServer cluster master’s Message Distribution service processes
requests sent to the Actuate iServer cluster consisting of the cluster master
node and additional Actuate iServer nodes you add to the cluster. A Message
Distribution service requires both an IP address and port.
To support backup Actuate iServer cluster masters, each Actuate iServer node
that is a backup cluster master must have access to the configuration file and
must have the 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 “About the Actuate iServer cluster
configuration file,” later in this chapter.

About creating an Actuate iServer System cluster

To create a cluster, complete the following steps in this order:
■ Install Actuate iServer on each machine in the Actuate iServer cluster. For
information, see Installing Actuate iServer System.
■ If you do not install Actuate Management Console as part of the Actuate
iServer installation, or if you choose to install Actuate Management
Console on another machine that can access the cluster machines, complete
that installation. For information, see Installing Actuate iServer System.
■ Use Actuate Management Console to log in to the System Administration
console for Actuate iServer as the Actuate iServer System administrator.
For information, see “Logging in to Actuate iServer System,” earlier in this
chapter.
■ Start Actuate iServer in the stand-alone configuration. For information, see
“Working with offline Actuate iServer,” earlier in this chapter.
■ Create the initial Actuate iServer cluster on a single machine using Actuate
iServer in a stand-alone configuration. For information, see “Creating a
cluster from stand-alone Actuate iServer,” later in this chapter.
■ Using the initial cluster master, which was formerly Actuate iServer in a
stand-alone configuration, add resources to the cluster, such as Actuate
iServer nodes, Actuate iServer partitions, Encyclopedia volumes, and
printers. For information about adding these resources, see the appropriate
topic:
■ “Adding and configuring an Actuate iServer node,” later in this chapter
■ “Adding a partition” in Chapter 8, “Working with an Actuate iServer
System partition”
■ “Adding and configuring an Encyclopedia volume” in Chapter 9,
“Working with an Actuate iServer System volume”
■ “Adding a resource group” in Chapter 10, “Adding and configuring an
Actuate iServer System resource group”

Chapter 5, Actuate iSer ver System administration overview 161

 Actuate iServer System stores the Actuate iServer cluster configuration
information in the configuration file for Actuate iServer. For information about
the configuration file, see “About the Actuate iServer System configuration
file,” earlier in this chapter.

Creating a cluster from stand-alone Actuate

iServer
For an overview of the steps involved in creating an Actuate iServer System
cluster, see “About creating an Actuate iServer System cluster,” earlier in this
chapter.
An Actuate iServer System administrator can specify settings on System—
Create Cluster to create an Actuate iServer System cluster.

The following table describes the parameters that appear on System—Create

Cluster.

Parameter Description
Internal server IP IP address that Actuate iServer uses to
communicate with other Actuate iServer nodes in
the Actuate iServer cluster.
Internal server port Port number that Actuate iServer uses to
communicate with other Actuate iServer nodes in
the Actuate iServer cluster.

162 Administering Actuate iSer ver System

Parameter Description
Heartbeat failure period Time, in seconds, between monitoring responses.
If Actuate iServer System does not receive a
response within this period, Actuate iServer
System assumes that the Actuate iServer machine
is down. The default value is 90 seconds.
Heartbeat send period Time, in seconds, after which the Message
Distribution service sends a request for Actuate
iServer machine health information from all
cluster nodes. The default value is 30 seconds.
System UDP port If you use UDP, the UDP port for unicast. If you
specify a value for this parameter, Actuate iServer
ignores the multicast address, the multicast port,
and the multicast TTL.
System multicast If you use Multicast, the multicast IP address to
address which all servers must belong for Actuate iServer
System to be multicast-enabled.
System multicast port If you use Multicast, the port to which all Actuate
iServer nodes listen for multicast communication.
Multicast TTL If you use Multicast, the maximum number of
point-to-point links (hops) allowed in a packet’s
transmission path. The default value is 1 hop.

How to create a cluster from Actuate iServer in a stand-alone

configuration
1 Log in to the System Administration console for Actuate iServer in a stand-
alone configuration.
System—Status appears.
2 Take Actuate iServer online, if necessary. For information about how to
take stand-alone Actuate iServer online, see “Working with offline Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”
3 On System—Status, choose Create Cluster.

Chapter 5, Actuate iSer ver System administration overview 163

 System—Create Cluster appears.
4 Specify settings for the Actuate iServer System cluster. Choose OK.

Adding and configuring an Actuate iServer node

When you add an Actuate iServer node to a cluster, you must configure the
Actuate iServer node after it joins the cluster. An Actuate iServer cluster does
not use any individual Actuate iServer node configuration information. For
example, if you add Actuate iServer in a stand-alone configuration to an
Actuate iServer cluster, the Actuate iServer cluster ignores any configuration
information from the new Actuate iServer node.

Preparing Actuate iServer to join a cluster

]Before Actuate iServer can join an Actuate iServer cluster, you must log in to
the System Administration console as an administrator and confirm that
Actuate iServer meets the following requirements:
■ The prospective Actuate iServer node uses the same Actuate iServer
System options as the Actuate iServer cluster uses. All nodes in an Actuate
iServer cluster use the same configuration information, including the
options enabled for Actuate iServer System. For more information about
the Actuate iServer System configuration file, see “About the Actuate
iServer cluster configuration file,” later in this chapter.
For information about viewing license and Actuate iServer System option
information, see “Working with Actuate iServer System license
information” in Chapter 6, “Working with system-wide Actuate iServer
parameters.” For information about option requirements for an Actuate
iServer cluster, see “About Actuate iServer cluster option requirements,”
earlier in this chapter.
■ The Actuate iServer machine for the prospective node can access and use
the Actuate iServer cluster resources, such as printers, database systems,
and disk storage systems. If necessary, install and configure the appropriate
hardware and software, such as printer drivers, fonts, and DBMS software.
■ The prospective Actuate iServer node is offline. For information about
stopping stand-alone Actuate iServer, see “Working with online Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”

Adding a new Actuate iServer node to a cluster

Choose Add Server on Servers in the System Administration console to add an
Actuate iServer node to an Actuate iServer cluster. The following illustration
shows Servers for an Actuate iServer cluster that consists of three Actuate
iServer nodes.

164 Administering Actuate iSer ver System

Adding an Actuate iServer node requires some configuration. After you add a
node, you can change Actuate iServer node parameter values on the Servers—
Properties subpages. For example, you can configure the Actuate iServer IP
address and port information and enable or disable the Message Distribution,
View, or Factory service for the Actuate iServer node. For descriptions of the
parameters that appear on the Servers—Properties subpages, see “About
server parameters for Actuate iServer System” in Chapter 7, “Working with an
Actuate iServer System server.”

How to add an Actuate iServer node

This procedure describes the minimal setup requirements for an Actuate
iServer node. If you do not specify values for the optional parameters, Actuate
iServer uses default values. You can set Actuate iServer parameter values
when you add a node. You can also change the parameter values for an
existing node. For more information about Actuate iServer parameters, see
“About server parameters for Actuate iServer System” in Chapter 7, “Working
with an Actuate iServer System server.”
1 From the side menu of the System Administration console for the Actuate
iServer cluster, choose Servers.
Servers appears.

Chapter 5, Actuate iSer ver System administration overview 165

 2 Choose Add Server.
Servers—New Server—General appears.

3 Provide the information to add a new Actuate iServer node to the Actuate
iServer cluster. The following information is required:
■ On Servers—New Server—General:

166 Administering Actuate iSer ver System

 - Host name or Actuate Process Manager IP address
- Process Manager daemon listen port
- Server IP address
- Application container process listen port
■ On Servers—New Server—Message Distribution Service, type a
Message Distribution IP address, if you enable the Message Distribution
service on this node.
■ On Servers—New Server—Partitions, specify the path the new Actuate
iServer node uses to access existing Actuate iServer System partitions.
Each partition in the Actuate iServer cluster must be accessible to the
new Actuate iServer node. For each partition, type the path that the
node uses to access the partition.
Choose OK.
The new Actuate iServer node appears in the list on Servers.

About Actuate iServer node configuration

In an Actuate iServer cluster, Actuate iServer System directs tasks to an
appropriate Actuate iServer node. As an administrator, you configure Actuate
iServer nodes to properly handle requests. For example, to generate or print
reports from an Actuate iServer node in a cluster, ensure that:
■ Printers are configured and accessible to all Actuate iServer nodes that run
the Factory service. For information about enabling the Factory service, see
“Specifying Factory service parameter values” in Chapter 7, “Working with
an Actuate iServer System server.”
■ All Actuate iServer nodes that run the Factory service have all necessary
open server drivers and related software installed. For information about
working with open server, see “Configuring open server” in Chapter 2,
“Setting up Actuate iServer System hardware.”
■ All Actuate iServer nodes that run the Factory service have database
access. For information about database connections, see “Specifying a
database configuration file” in Chapter 2, “Setting up Actuate iServer
System hardware.”
■ All Actuate resource group property configurations are correct. For
information about setting up Actuate iServer to use resource groups, see
Chapter 10, “Adding and configuring an Actuate iServer System resource
group.”
In some cases, advanced configuration is necessary for certain items,
including:
■ Database connection information for Actuate Basic reports.

Chapter 5, Actuate iSer ver System administration overview 167

 ■ External images that appear in Actuate Basic reports.
■ Open server drivers.
■ The open security application that Actuate iServer System uses with an
Encyclopedia volume. For information about Actuate open security, see
“About open security functionality” in , “About open security
functionality.”

Starting or stopping an Actuate iServer node

As Actuate iServer System administrator, you start, shut down, or restart
Actuate iServer nodes in an Actuate iServer cluster using Servers in the
System Administration console.
The following table describes the possible Actuate iServer states that appear in
the Status column on Servers.

State Definition
Master In an Actuate iServer cluster, the server is the
cluster master. You can start or stop the cluster
from System—Status.
Offline Actuate iServer successfully completed its
shutdown routine.
Online Actuate iServer successfully completed the
startup routine. If Actuate iServer is a cluster
node, it joins the cluster.
Stopping Actuate iServer is going through its shutdown
routine. This is a transition state.

When an Actuate iServer node is part of an Actuate iServer cluster, you can
start and stop the node independently of the cluster. On Servers, when you
select a node on which to act, you can choose to start, stop, or restart the
selected node:
■ When you stop an Actuate iServer node:
■ The node leaves the Actuate iServer cluster.
■ The node’s services and resource groups are no longer available to the
cluster.
■ The status of the node changes to offline.
■ When you start an Actuate iServer node:
■ The node joins the cluster.
■ The node’s services and resource groups become available to the cluster.

168 Administering Actuate iSer ver System

 ■ The node takes its Encyclopedia volumes online, if it is still responsible
for Encyclopedia volumes. Actuate iServer System users can access the
contents of the Encyclopedia volume when the volume is online.
■ The status of the node changes to online.
■ When you restart an Actuate iServer node, Actuate iServer System stops
then starts the specified Actuate iServer nodes.
Shutting down an Actuate iServer cluster differs from stopping a node in a
cluster. To shut down an Actuate iServer cluster or Actuate iServer in a stand-
alone configuration, choose Stop on System—Status. For more information
about System—Status, see “Understanding Actuate iServer status” in Chapter
5, “Actuate iServer System administration overview.” For information about
working with online Actuate iServer, see “Working with online Actuate
iServer,” earlier in this chapter. For information about working with offline
Actuate iServer, see “Working with offline Actuate iServer,” earlier in this
chapter.
How to start or stop multiple Actuate iServer nodes in a cluster
Before you stop an Actuate iServer node, first fail over any Encyclopedia
volume assigned to the node. If the Encyclopedia volume does not have a
backup server, you must take the volume offline. For information about
putting an Encyclopedia volume offline, see “Taking an Encyclopedia volume
online or putting an Encyclopedia volume offline” in Chapter 9, “Working
with an Actuate iServer System volume.”
Before you stop an Actuate iServer cluster master, assign another Actuate
iServer node as the cluster master. For information about changing the cluster
master, see “Changing the cluster master” in Chapter 7, “Working with an
Actuate iServer System server.”
1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 In the server list, select the check boxes for the Actuate iServer names to
start or stop. When you finish selecting Actuate iServer names, hover the
pointer over Act on Selected Servers and choose Start up or Shut down, as
shown in the following illustration.

Chapter 5, Actuate iSer ver System administration overview 169

 Actuate iServer System changes the status of the selected servers.

How to start or stop a single Actuate iServer node

Before you stop an Actuate iServer node, first fail over any Encyclopedia
volume assigned to the node. If the Encyclopedia volume does not have a
backup server, you must take the volume offline. For information about
putting an Encyclopedia volume offline, see “Taking an Encyclopedia volume
online or putting an Encyclopedia volume offline” in Chapter 9, “Working
with an Actuate iServer System volume.”
Before you stop the Actuate iServer cluster master, assign another Actuate
iServer node as the cluster master. For information about changing the cluster
master, see “Changing the cluster master” in Chapter 7, “Working with an
Actuate iServer System server.”
1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 In the list of servers, hover the pointer over the arrow icon for the Actuate
iServer name that you want to stop or start. Choose Start up or Shut down,
as shown in the following illustration.

170 Administering Actuate iSer ver System

 Actuate iServer System changes the status of the server.

Removing a node from an Actuate iServer cluster

When you remove an Actuate iServer node from an Actuate iServer cluster:
■ Actuate iServer System removes information about the Actuate iServer
node from the cluster configuration information.
■ When an Actuate iServer System administrator logs in to the System
Administration console for the cluster, the administrator cannot access the
node.
To remove an Actuate iServer node from a cluster, complete the following
tasks in this order:
■ Log in to the System Administration console for the cluster.
■ Reconfigure Actuate iServer System to handle functionality assigned to the
node. For example:
■ Ensure that remaining Actuate iServer nodes in the cluster can assume
responsibility for the functionality that the node supports, such as:
- Running Message Distribution, View, and Factory services. For
more information, see “Setting Message Distribution service
parameter values,” “Setting View service parameter values,” or
“Specifying Factory service parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”
- Managing Encyclopedia volumes. For more information, see
“Specifying the buffer pool size for an Encyclopedia volume” in
Chapter 7, “Working with an Actuate iServer System server.”
- Fulfilling resource group requirements. For more information, see
“Viewing or modifying resource group server assignments” in
Chapter 10, “Adding and configuring an Actuate iServer System
resource group.”
■ Reassign Encyclopedia volumes from the Actuate iServer node to other
backup nodes. For more information, see “Assigning backup
responsibility for an Encyclopedia volume to an Actuate iServer node”
in Chapter 7, “Working with an Actuate iServer System server.”
■ Shut down the node. When you take the Actuate iServer node offline, the
Actuate iServer cluster can no longer access the node’s services. For
information about taking a node offline, see “Starting or stopping an
Actuate iServer node,” earlier in this chapter.
■ Remove the node from the cluster. Removing a node from the cluster does
not change the machine-level configuration information for the Actuate
iServer node. For example, the Actuate iServer cluster can still access the
following resources, even after you remove the node from the cluster:

Chapter 5, Actuate iSer ver System administration overview 171

 ■ Printers configured on the Actuate iServer machine. For more
information, see Chapter 11, “Adding and configuring an Actuate
iServer System printer.”
■ Partitions on machine drives to which the cluster has access. For more
information, see “Specifying the path to an Actuate iServer System
partition” in Chapter 5, “Actuate iServer System administration
overview.”

Understanding file system failover

In an Actuate iServer cluster configuration, the Actuate iServer System
supports the following types of failover when a file system fails:
■ Cluster master failover. To specify a backup server for an Actuate iServer
cluster master, see “Setting up cluster master failover” in Chapter 6,
“Working with system-wide Actuate iServer parameters.”
■ Encyclopedia volume failover. To specify a backup server for an
Encyclopedia volume, see “Assigning a backup server to an Encyclopedia
volume” in Chapter 9, “Working with an Actuate iServer System volume.”
■ Actuate iServer node failover. To enable Actuate iServer node failover, you
must create an Actuate iServer cluster. For information about creating an
Actuate iServer cluster, see “Setting up and administering an Actuate
iServer System cluster,” earlier in this chapter.
To support failover for a resource group assigned to an Actuate iServer
node, you must configure the Actuate iServer System’s resource groups to
handle jobs if the Actuate iServer node fails. For information about failover
and resource groups, see “About Actuate iServer failover when using a
resource group” in Chapter 10, “Adding and configuring an Actuate
iServer System resource group.”

About Actuate iServer System file system failover

Actuate iServer handles file system failure on stateless and stateful file
systems. This overview uses Network File System (NFS) as an example of a
stateless network file system and Common Internet File System (CIFS) as an
example of a stateful network file system.
Actuate iServer handles some file system failures by retrying file I/O. Retrying
file I/O works when a file system failover is transparent to Actuate iServer.
For example, on an NFS-based network storage system, a file system failover
can be transparent to Actuate iServer. Retrying file I/O is insufficient in a
configuration where file system failover is not transparent to Actuate iServer.

172 Administering Actuate iSer ver System

For example, file system failover on a Microsoft Windows-based CIFS file
system is not transparent to Actuate iServer.
On a stateless file system such as an NFS-based file system, Actuate iServer
can handle a network storage system failover. The Actuate iServer machine
detects that the connection to a file system is broken and attempts to reconnect.
When the file system failover completes, the machine re-establishes a
connection with the file system. If the machine’s file system connection does
not time out during failover, the network file system failover appears
transparent to the Actuate iServer.
On a stateful file system such as a Microsoft Windows-based CIFS network file
system, a machine using the file system tracks file system connection states
including open files and locks. If the file system connection breaks, the
machine looses connection state information. The CIFS client machine must
manually re-establish file system connections. Actuate iServer can re-establish
file system connections on a stateful network file system.

Determining when an Actuate iServer file system I/O

failure occurs
Actuate iServer determines a file system failure based on a failure of following
file I/O functions:
■ Reading the Actuate iServer configuration lock file
■ Reading the Encyclopedia volume lock file
■ Reading or writing to an Encyclopedia volume
An I/O failure that occurs when reading the Actuate iServer configuration
lock file affects the Actuate iServer cluster master. The other two I/O failures
affect the Encyclopedia volume.

About failover due to a failure to read the configuration file

In an Actuate iServer cluster with cluster master failover configured, an I/O
failure occurs when Actuate iServer cannot access the configuration lock file.
This failure triggers a cluster master failover. The original master fails over to
the next backup master that has access to the partition. If cluster master
failover procedure fails, Actuate iServer tries to use the next backup master,
including the original cluster master, until the failover retry period expires.
If you do not configure Actuate iServer failover, Actuate iServer attempts to
access the configuration lock file until it exceeds the failover retry period. You
can configure both the failover retry period and the time to wait between
attempts for the Network Attached Storage NAS failover to take effect.

Chapter 5, Actuate iSer ver System administration overview 173

 About failover due to Encyclopedia volume read or write
failure
In an Actuate iServer cluster with Encyclopedia volume failover configured,
an if the Encyclopedia process detects an I/O failure, it triggers an
Encyclopedia volume failover. After putting the failed Encyclopedia volume
offline, the Actuate iServer cluster master attempts to fail over the volume to
the next available backup server. This procedure continues until a backup
server or the primary server loads the volume. This procedure aborts if the
failure retry period expires.
If you do not configure Encyclopedia volume failover, the cluster master tries
to put the Encyclopedia volume offline and reload the volume using its
primary owner.

About Actuate iServer node failover

The Actuate iServer cluster master performs an Actuate iServer node failover
under the following conditions:
■ An encycsrvr7 process on an Actuate iServer node fails. For example, the
Actuate iServer node loses power.
■ An encycsrvr7 process on an Actuate iServer node cannot send heartbeat
messages. For example, the Actuate iServer node cannot access the
network.
If the Actuate iServer cluster master can communicate with the Actuate
iServer node’s Process Management Daemon (PMD), the Message
Distribution service (MDS) on the cluster master shuts down and restarts the
node’s encycsrvr7 process.
If the Actuate iServer cluster master cannot communicate with the Actuate
iServer node’s PMD, the cluster master changes the node’s status to Failed and
distributes incoming requests to the remaining Actuate iServer nodes in the
Actuate iServer cluster. The cluster master adds the node to the cluster again
when the cluster master receives a heartbeat from the node’s encycsrvr7
process.

About Actuate iServer node autostart and failover

You can configure an Actuate iServer node to start and come online when an
Actuate iServer machine restarts. In some failover situations, you must use
Actuate Management Console to put the Actuate iServer node online.

174 Administering Actuate iSer ver System

 In an Actuate iServer cluster:
■ The first node in a cluster that starts when an Actuate iServer machine
restarts becomes the Actuate iServer cluster master. It manages an
Encyclopedia volume.
■ The second node that starts becomes a backup cluster master and a backup
server for the Encyclopedia volume.
If the Actuate Process Management Daemon (PMD) process and the Actuate
iServer process, encycsrvr7, fail on the first Actuate iServer node machine, the
backup Actuate iServer node takes over management of the Encyclopedia
volume and becomes the cluster master.
If you restart the first Actuate iServer node machine as part of an Actuate
iServer automatic restart, the PMD process on the first node attempts to start
the Actuate iServer encycsrvr7 process. Because the second node is now the
cluster master, and it manages the Encyclopedia volume, the encycsrvr7
process on the first node stops. After the encycsrvr7 process stops on the first
machine, you can start the Actuate iServer node manually using Actuate
Management Console.

Managing an Actuate iServer cluster

As Actuate iServer System administrator, you configure an Actuate iServer
cluster after you create a cluster. For general information about Actuate
iServer administration, see “About general Actuate iServer administration
tasks” in Chapter 5, “Actuate iServer System administration overview.”

About cluster networking requirements

This section describes networking requirements for an Actuate iServer cluster.
Actuate iServer supports both unicast and multicast communication within a
cluster. The following conditions apply:
■ When using multicast, you configure the Actuate iServer cluster to use a
multicast group address that corresponds to the hardware or software that
you configure on your network to support multicast communication.
■ If a multicast group address is not available, use unicast. For example, if a
network that you use for demonstration or as a prototype does not support
multicasting, use unicast. Most production networks support multicast. For
example, a WebLogic application server cluster requires multicasting. The
default cluster communication is unicast.
All Actuate iServer cluster nodes must have access to resources that the
Actuate iServer cluster uses. For example, to use a partition, the directory that

Chapter 5, Actuate iSer ver System administration overview 175

 contains the partition must be accessible to all nodes in the cluster. Similarly,
an Actuate iServer System printer must be accessible to all nodes in the cluster.
As an example, in a two-machine Actuate iServer cluster that consists of
Node1, Node2, and a partition named Part1 on the Node1 machine, Node2
must have access to the directory on Node1 that contains Part1.
To specify the location of an Encyclopedia volume for an Actuate iServer
cluster, you must specify the location relative to each Actuate iServer node. For
example, if the directory on Node1 is C:\Server\Part1 and the shared location
on Node2 is N:\Part1, you must specify:
■ For Node1, the Part1 partition is at C:\Server\Part1.
■ For Node2, the Part1 partition is at N:\Part1.

About Actuate iServer cluster option

requirements
An Actuate iServer System cluster uses a single license file. All Actuate iServer
nodes in a cluster have the same Actuate iServer System options enabled. Any
Actuate iServer node that you add to the cluster uses only the options that the
cluster master uses. For example, if an Actuate iServer System administrator
adds a node on which Actuate iServer was in a stand-alone configuration with
page-level security enabled, and the cluster master does not have page-level
security enabled, the new Actuate iServer node does not support page-level
security.
To support multiple Encyclopedia volumes in an Actuate iServer cluster
requires an Actuate iServer license file that enables the Actuate Additional
Volume Option. Without the Additional Volume Option enabled, there can be
only one Encyclopedia volume for each Actuate iServer cluster or stand-alone
Actuate iServer. For example, if each of two machines with Actuate iServer in a
stand-alone configuration has an Encyclopedia volume, you cannot create an
Actuate iServer cluster from the two Actuate iServer machines and maintain
the two volumes without a license file that enables the Additional Volume
Option.
For information about viewing and changing Actuate iServer options, see
“Working with Actuate iServer System license information” in Chapter 6,
“Working with system-wide Actuate iServer parameters.”
When Actuate iServer is offline, you can type a new a license file as a system
startup parameter. For information about system start-up parameters, see
“Managing an Actuate iServer cluster,” later in this chapter.

176 Administering Actuate iSer ver System

Changing start-up parameters for Actuate iServer
If you choose Modify Start Parameters on System—Status when Actuate
iServer is offline, System—Modify Start Parameters appears. The following
illustration shows System—Modify Start Parameters for Actuate iServer in a
stand-alone configuration.

For an Actuate iServer cluster, System—Modify Start Parameters looks like the
one in the following illustration.

Chapter 5, Actuate iSer ver System administration overview 177

 The following table describes the parameters that appear on System—Modify
Start Parameters. As shown in the preceding illustrations, not all of the
parameters are available for Actuate iServer in a stand-alone configuration.

Parameter Description
Message distribution IP IP address for the Message Distribution service on
address the Actuate iServer machine for which you set
this parameter.
Message distribution Port for the Message Distribution service on the
port Actuate iServer machine for which you set this
parameter.
Heartbeat send period Time, in seconds, after which the Message
Distribution service sends a request for Actuate
iServer machine health information from all the
cluster nodes. The default value is 30 seconds.
Heartbeat failure period Time, in seconds, between monitoring responses.
If Actuate iServer System does not receive a
response within this period, Actuate iServer
System assumes that the Actuate iServer machine
is down. The default value is 90 seconds.
System UDP port If you use UDP, the UDP port for unicast. If you
specify a value for this parameter, Actuate iServer
ignores the multicast address, the multicast port,
and the multicast TTL.
System multicast If you use Multicast, the multicast IP address to
address which all servers must belong for Actuate iServer
System to be multicast-enabled.
System multicast port If you use Multicast, the port to which all Actuate
iServer nodes listen for multicast communication.
Multicast TTL If you use Multicast, the maximum number of
point-to-point links (hops) allowed in a packet’s
transmission path. The default value is 1 hop.

Actuate iServer System uses:

■ The Message Distribution parameters for cluster communication. For
information about the Message Distribution parameters, see “Setting
Message Distribution service parameter values” in Chapter 7, “Working
with an Actuate iServer System server.”
■ The system heartbeat parameters for accessing Actuate iServer node status
when the Actuate iServer cluster is running. For information about the
system heartbeat parameters, see “Creating a cluster from stand-alone
Actuate iServer,” later in this chapter.

178 Administering Actuate iSer ver System

 How to modify start-up parameters for Actuate IServer
1 Put Actuate iServer offline, if necessary.
2 On System—Status, choose Modify Start Parameters.
System—Modify Start Parameters appears.
3 Specify values for the parameters, as necessary, to change the parameter
values that apply when you restart Actuate iServer.
When you finish setting up the start-up parameters, choose Start. When
Actuate iServer restarts, it uses the specified startup parameter values.
Actuate iServer saves the startup parameter values in the system
configuration file.

Understanding Actuate iServer System online

archive functionality
Actuate iServer System supports a SOAP-based API, Archive IDAPI. Using
the API, a developer can create an application that archives files from an
Encyclopedia volume. For information about configuring Actuate iServer to
use Archive IDAPI for archiving an Encyclopedia volume, see “Modifying
Actuate iServer parameter values for an Encyclopedia volume” in Chapter 9,
“Working with an Actuate iServer System volume.” For information about
configuring an Encyclopedia volume’s archiving settings, see “Archiving files
and removing empty folders” in Chapter 20, “Archiving files and backing up
an Encyclopedia volume.”
Using the Archive IDAPI, developers can create custom online archiving
applications. For information about using the Archive IDAPI, see Programming
with Actuate iServer APIs.

About the online archive application

Actuate iServer ships with a configurable, Java-based Encyclopedia volume
archive application that uses the Archive IDAPI. The online archive
application source code and build files ship with the Actuate iServer
Integration Technology product under the Volume Archive Service Example
directory. Using the application requires licensing the Online Archive Option
for Actuate iServer System. For information about the files that the online
archive application requires, see “About the online archive application files,”
later in this chapter.
The Actuate iServer online archive application copies expired Encyclopedia
volume files to a second Encyclopedia volume that serves as a file archive.

Chapter 5, Actuate iSer ver System administration overview 179

 The online archive application supports the following features:
■ Preserving file attributes, such as description, version name, and security
information. For more information, see “Retaining file attributes during
archiving,” later in this chapter.
■ Preserving file dependencies. For more information, see “Preserving file
dependencies during archiving,” later in this chapter.
■ Deleting empty folders from the source Encyclopedia volume. For more
information, see “Archiving files and removing empty folders,” in Chapter
20, “Archiving files and backing up an Encyclopedia volume.”.
You configure Actuate iServer to use the online archive application using the
System Administration console of Actuate Management Console. For
information about configuring Actuate iServer to use the online archive
application, see “Modifying Actuate iServer parameter values for an
Encyclopedia volume” in Chapter 9, “Working with an Actuate iServer System
volume.”

About the online archive application files

The online archive application uses Java Runtime Environment (JRE) version
1.4.1. This JRE ships with Actuate iServer. Actuate iServer installs the
following online archive application files:
■ A script that runs the application in the Actuate iServer bin directory. On a
UNIX system, the script is aconlinearchive.sh. On a Microsoft Windows
system, the script is aconlinearchive.bat. The script sets environment
variables and runs the autoarchive application.
■ The Java JAR files in the Actuate iServer drivers directory. The file names
are aconlinearchive.jar and aconlinearchiveDEP.jar.
The application also requires a configuration file, which is in XML format. The
default name of the configuration file is onlinearchive_<volume>.cfg, where
<volume> is the name of the Encyclopedia volume that runs the online archive
application. The default location for the configuration file is the Actuate
iServer etc directory. For more information about the online archive
application configuration file see, “Working with the Actuate iServer online
archive application configuration file,” later in this chapter.
The following illustration shows Volumes—Properties—General. In this
illustration, the Volume archive service uses the batch file aconlinearchive.bat.
The online archive application uses the default configuration file,
onlinearchive_urup.cfg, located in the Actuate iServer etc directory.

180 Administering Actuate iSer ver System

For more information about Volumes—Properties—General, see “Modifying
Actuate iServer parameter values for an Encyclopedia volume” in Chapter 5,
“Actuate iServer System administration overview.”

Retaining file attributes during archiving

When you configure the online archive application, specify whether the
application retains file information, including security information. In the
application’s configuration file, you can specify whether the application
retains the following file attributes:
■ Time stamp
■ Owner
■ Permissions
■ Dependencies

Chapter 5, Actuate iSer ver System administration overview 181

 For more information about retaining file dependency information, see
“Preserving file dependencies during archiving,” later in this chapter.
If the online archive application does not retain the permissions information
for an archived file, the file’s owner has full access. If the online archive
application retains security information of an archived file, including owner
and user privileges on the file, the application performs the following
functions:
■ If the owner or any user or role in the file’s access control list (ACL) refers
to a user or role, the application attempts to match the entity to a user or
role with the same name in the archive Encyclopedia volume. When using
an existing Encyclopedia volume user or role, the application does not
update the user’s or role’s properties with information from original
volume.
■ If the archive Encyclopedia volume uses RSSE external registration for user
and role information, the online archive application uses the RSSE
information to update the users and roles for the file’s privileges:
■ If the file’s original owner is not defined in the archive Encyclopedia
volume, the Encyclopedia volume user that the application’s
configuration file names becomes the owner of the file when the file is
added to the archive volume.
■ If a role or user is in the file’s original ACL and the user or role is not
defined in the archive volume, that user or role is not added to the file’s
privileges when the file is added to the archive volume.
■ If the user or role is not present in the archive Encyclopedia volume, the
application creates an Encyclopedia volume user or role with the same
name in the archive Encyclopedia volume. The user or role that the
application creates has the same properties as the original user or role,
except the online archive application does not enable login for a user or role
it creates.

Preserving file dependencies during archiving

When the online archive application archives a file that has a dependency on
another file, the application can archive both files and preserve the
dependency information. When the online archive application retains file
dependency, and an archived file depends on another file, the application
copies both files to the archive Encyclopedia volume and creates the same
relative file structure in the archive Encyclopedia volume. The application
does not delete the file on which the archived file has a dependency from the
original Encyclopedia volume, unless the application archives both files.
If more than one archived file depends on the same file, the online archive
application retains the original file dependency and typically retains only one
copy of the file on which the archived files depend. The online archive

182 Administering Actuate iSer ver System

application does not track dependencies between archive sessions. For
example, a file is in the dependency list of two files. If the online archive
application archives one file on one day and the other on another day, the
online archive application archives two copies of the file on which the other
files depend, one for each archived file that it archives in each session.

Using the online archive application

To use the online archive application:
■ Create an Encyclopedia volume to use as the archive volume. For more
information about creating an Encyclopedia volume, see “Adding and
configuring an Encyclopedia volume” in Chapter 9, “Working with an
Actuate iServer System volume.”
■ Create an configuration file that contains the configuration parameters for
the online archive application. For more information, see “Working with
the Actuate iServer online archive application configuration file,” later in
this chapter.
The online archive application applies changes to the configuration file
when Actuate iServer runs the online archive. Changes do not affect a
running archive process.
■ Specify the script file in Use command line on Volume—Properties—
General for the Encyclopedia volume. For more information, see
“Modifying Actuate iServer parameter values for an Encyclopedia
volume” in Chapter 9, “Working with an Actuate iServer System volume.”

Working with the Actuate iServer online archive

application configuration file
The online archive application uses an XML configuration file. The default
name of the configuration file is onlinearchive_<volume>.cfg, where
<volume> is the name of the Encyclopedia volume that runs the archive
application. The default location for the configuration file is the Actuate
iServer etc directory. You can specify the configuration file using the -c
command line option.
The online archive application supports the optional -c option. This option
specifies configuration file. The default file name and location is:
<AC_SERVER_HOME>/etc/acexarchive_<VolumeName>.cfg
where VolumeName is the name of the Encyclopedia volume to archive.
For example, to use the following configuration file:
/local/actuate8/archiveconfig.xml

Chapter 5, Actuate iSer ver System administration overview 183

 Specify the following command for the Encyclopedia volume parameter Use
command line on Volumes—Properties—General:
aconlinearchive.sh -c /local/actuate8/archiveconfig.xml

About the Encyclopedia volume archive folder

The Actuate iServer online archive application creates a folder in the archive
Encyclopedia volume and places files from an online archive session in that
folder. In the online archive application configuration file, you specify the
name of a root folder that contains the directories for all the online archive
sessions. The directory structure within the folder mirrors the folder structure
of the original Encyclopedia volume. The folder name containing the files
from the online archive session consists of the start date and time of the online
archive session the following format:
YYYY_mm_dd.hh_mm_ss
For example, you specify the online archive content folder as /archive2003.
For an autoarchive session starting on 8:25pm Dec 2, 2005, the application
copies the file /reports/sales/commission.roi to the archive Encyclopedia
volume in the following location:
/archive2003/2005_12_02.20_25_14/reports/sales/commission.roi

Understanding the online archive application configuration file

The following code is the content of the default autoarchive application
configuration file:
<?xml version="1.0" encoding="UTF-8"?>
<archiveconfig>
<!--TargetServer, TargetSOAPPort: [Required] -->
<!-- Name or IP of server and port for connecting to -->
<!-- the SOAP dispatcher service of the target volume -->
<TargetServer>localhost</TargetServer>
<TargetSOAPPort>8000</TargetSOAPPort>

<!--ArchiveVolume: [Required] -->

<!-- Name of target volume to copy archived files to -->
<ArchiveVolume>DefaultVolume</ArchiveVolume>

<!--AdminUser, AdminPassword: [Required] -->

<!-- Name and password of a user in the target volume -->
<!-- that belongs to the Administrator role -->
<AdminUser>administrator</AdminUser>
<AdminPassword></AdminPassword>

<!--RetainTimestamp: [Optional, default: false] -->

<!-- Whether timestamp of archived file is preserved -->

184 Administering Actuate iSer ver System

 <RetainTimestamp>false</RetainTimestamp>

<!--RetainOwner: [Optional, default: false] -->

<!-- Whether Owner of archived file is preserved -->
<RetainOwner>false</RetainOwner>

<!--RetainPermission: [Optional, default: false] -->

<!-- Whether Permission (ACL) of archived file is -->
<!-- preserved -->
<RetainPermission>false</RetainPermission>

<!--CopyDependOnFile: [Optional, default: true] -->

<!-- Whether files depended on by archived file are -->
<!-- copied -->
<CopyDependOnFile>true</CopyDependOnFile>

<!--CreateUserRole: [Optional, default: true] -->

<!-- Whether to create missing user or roles in target -->
<!-- volume in order to retain Owner or Permissions -->
<CreateUserRole>true</CreateUserRole>

<!--ArchiveRoot: [Optional, default: /] -->

<!-- Root encyc folder for all archived files -->
<ArchiveRoot>/</ArchiveRoot>

<!-- LogLevel: [Optional, default: Summary] -->

<!-- Leve of detail in log file. Valid values are: -->
<!-- Summary, Detail and Trace -->
<LogLevel>Summary</LogLevel>

</archiveconfig>
The following table describes the Actuate online archive application
configuration file parameters for the Encyclopedia volume that stores the
archived files.

Parameter Description
TargetServer Machine name or IP address to use to connect to
the Encyclopedia volume that holds the archived
files. A required parameter.
TargetSOAPPort Port number that the Actuate iServer SOAP
dispatcher service uses to connect to the
Encyclopedia volume. A required parameter.
ArchiveVolume Encyclopedia volume name. The default value is
DefaultVolume. A required parameter.

Chapter 5, Actuate iSer ver System administration overview 185

 Parameter Description
AdminUser Encyclopedia volume user name. The user must
belong to the Administrator role. A required
parameter.
AdminPassword Password of the user specified by the AdminUser
parameter. A required parameter.
RetainTimestamp Parameter that indicates whether the autoarchive
application archives the file’s time stamp. The
default value is false.
RetainOwner Parameter that indicates whether the autoarchive
application retains the identity of the file’s owner.
The default value is false.
RetainPermission Parameter that indicates whether the autoarchive
application archives the file’s permissions. The
default value is false.
CopyDependOnFile Parameter that indicates whether the autoarchive
application archives the file’s dependency list.
The default value is true.
CreateUserRole Parameter that indicates whether the autoarchive
application creates missing user or roles in the
archive Encyclopedia volume to retain the file’s
owner or permission information. The default
value is true.
ArchiveRoot Encyclopedia volume archive session root folder.
The default value is /, the Encyclopedia volume
root folder.

Consolidating Actuate iServer usage and error log

data
The usage and error log consolidator application is a Java-based application
that reads data from Actuate iServer usage and error log files. The consolidator
application runs as a separate process on a Actuate iServer machine and uses
JDBC to copy data from the log files to an Oracle database. Actuate iServer
stores the application’s configuration information, such as the database
connection properties and number of log files the application processes in the
consolidator.xml file. The configuration file is in the Actuate iServer etc
directory. For information about the configuration file, see “Configuring the
consolidator application,” later in this chapter.

186 Administering Actuate iSer ver System

The consolidator application uses usage and error log files generated by the
usage and error logging applications that ship with Actuate iServer. For
information about working with usage or error logging, see “Working with
Actuate iServer System usage and error logging” in Chapter 6, “Working with
system-wide Actuate iServer parameters.”
The following illustration shows how the consolidation process consolidates
data from two Actuate iServer machines. Actuate iServer running on the
machines can be part of the same Actuate iServer cluster, nodes of different
clusters or stand-alone Actuate iServer Systems.

Actuate Logging Configuration

iServer extension file

Log file Consolidation

process

Log
database
Log file Consolidation
process

Actuate Logging Configuration

iServer extension file

Actuate iServer installation process installs the consolidator application files

JAR files and startup files. The installation process also sets Microsoft
Windows Registry entries or UNIX environment variables used by the
consolidator application
Using the consolidator application, requires the following files from the
Actuate iServer Integration Technology product that are in the
UsageAndErrorConsolidator directory:
■ consolidatorconfig.xml is the consolidator application configuration file. A
sample file is in the directory UsageAndErrorConsolidator\Setup.
■ CreateActuateLogTables.sql is an SQL script that creates database tables
used by the consolidator application in an Oracle database. A sample file is
in the directory UsageAndErrorConsolidator\DBScripts.
The source code for the consolidation application and sample configuration
files ship with the Actuate iServer Integration Technology product in the

Chapter 5, Actuate iSer ver System administration overview 187

 UsageAndErrorConsolidator directory. The directory also contains the JAR
files and startup files that ship with Actuate iServer. The following list
describes the contents of the Actuate iServer Integration Technology
UsageAndErrorConsolidator directory:
■ /DBScripts contains an SQL script to create database tables in the target
database. A readme.txt file describes the SQL script file.
■ /lib contains all the supporting JAR files required by the consolidator
application.
■ /Setup/UNIX contains the startup and shutdown scripts for the
consolidator application. A readme.txt file describes how to use the scripts.
■ /Setup/Windows contains a setup application for the consolidator
application that can start and stop the consolidator application and install
the consolidator application as a Windows service. A readme.txt file
describes how to use the application.
■ /src contains source code for the consolidator application. At the top level
is build.xml, which is a build script. Execute the build script to generate
consolidator.jar. This folder also contains consolidator.xml, which is
configuration file for the consolidator application.

Setting up the consolidator application

To set up the Actuate iServer consolidator application, complete the following
tasks:
■ Set up database tables in the target database using the SQL script file
Actuate provides. For more information, see “Configuring the target
database for the consolidator application,” later in this chapter.
■ Ensure that the host machine can access the database on the database
server machine and that the database contains the correct file types and
output formats.
■ Ensure the required JAR files are in the Actuate iServer /jar/
UsageAndErrorConsolidator directory. On a Windows system, the default
directory is:
C:\Program Files\Actuate8\jar\UsageAndErrorConsolidator
■ Copy the sample consolidator.xml from the Actuate iServer Integration
Technology product to the Actuate iServer etc directory, and set the
configuration parameters. On a Windows system, the default etc directory
is:
C:\Program Files\Actuate8\iServer\etc

188 Administering Actuate iSer ver System

■ Configure the system to start and stop the application:
■ On UNIX, install the startup and shutdown scripts. For more
information, see “Using the UNIX startup and shutdown scripts for the
log consolidator application,” later in this chapter.
■ On Windows, use the setup utility to install the application as a
Windows service. For more information, see “Using the Windows
startup and shutdown utility for the log consolidator application,” later
in this chapter.
■ Ensure the following Actuate iServer Windows Registry entry or UNIX
environment variable exists. The Windows Registry entry is:
HKEY_LOCAL_MACHINE\SOFTWARE\Actuate\Common\8.0\AC_JRE_HOME
The following path is the default value for AC_JRE_HOME:
C:\Program Files\Common Files\Actuate\8.0\JDK141\jre
The UNIX environment variable is AC_JRE_HOME. The value is:
$AC_SERVER_HOME/jdk141/jre
The consolidator application uses the java executable from
AC_JRE_HOME/bin.
■ Disable the Display date time as string parameter. The consolidator
application support only storing dates as a numeric value, not as a
formatted string. For information about setting the log file date and time
format, see “Setting advanced usage and error logging property values”in
Chapter 6, “Working with system-wide Actuate iServer parameters.”

Configuring the target database for the consolidator

application
The consolidator application that ships with Actuate iServer uses an Oracle
database as a target database to consolidate the usage and error log
information from multiple log files. The sample SQL script
CreateActuateLogTables.sql creates and populate database tables in the target
Oracle database. The script performs the following functions:
■ Creates the tables in the target database for the consolidator application.
The script deletes old files from the database and creates tables with
appropriate primary keys and foreign keys.
■ Populates the tables with unique identifiers for database processing.
Before you use the consolidator application, ensure that the database contains
the correct list of file types and output formats.
The sample script file installs with the Actuate iServer Integration Technology
product in the directory UsageAndErrorConsolidator\DBScripts.

Chapter 5, Actuate iSer ver System administration overview 189

 Configuring the consolidator application
The configuration file for the usage and error log consolidator application is in
the etc directory of the Actuate iServer home directory. The configuration file
contains the following sections:
■ The JDBC section contains parameters for the JDBC connection information
to connect to an Oracle database.
■ The Consolidator section contains parameters for Actuate iServer log file
information.
The following table lists the parameters in each section of the consolidator
application configuration file.

Parameter Description
JDBC section
Driver Name Fully-qualified name of the JDBC driver.
URL JDBC URL for connecting to the database.
User Name User name used to connect to DB. Not required,
if part of the URL.
Password Password for the user specified by the User
Name parameter. Not required, if part of the
URL. If specified, the password is encrypted.
Encoding Database encoding to use.
Schema Name Schema name, if different from the user's default
schema.
Consolidation section
Refresh Time Interval, in seconds, between attempts by the
consolidator to retrieve data from the log files.
NumberOfRecordsTo Number of records to process in each refresh
Process iteration. This value indicates the number of
records to read from the usage log file and insert
in the database.
UsageLogConsolidation Indicator of whether to consolidate usage log
Enabled information.
ErrorLogConsolidation Indicator of whether to consolidate error log
Enabled information.
UsageLogFileName Usage log file name.
UsageLogFileSize Maximum size of the usage log file.
NumberOfUsageLog Maximum number of usage log files.
Files

190 Administering Actuate iSer ver System

Parameter Description
ErrorLogFileName Error log file name.
ErrorLogFileSize Maximum size of the error log file.
NumberOfErrorLogFiles Maximum number of error log files.

The consolidator application configuration values should match Actuate

iServer parameter settings. For example, if Actuate iServer uses 4 usage log
files, set the value for the number of log files in consolidator.xml to 4.

Using the UNIX startup and shutdown scripts for the log
consolidator application
On a UNIX system, Actuate supplies the following scripts to start and stop the
consolidator application:
■ start_consolidator.sh starts the consolidator application on a UNIX server.
This script takes $AC_SERVER_HOME as its argument. This script sets the
appropriate $CLASSPATH variables and tries to start consolidator. It stores
the resulting pid in $AC_SERVER_HOME/etc/consolidator.pid. If the
create process fails, it tries as many as 5 times. Call this script from
start_srvr.sh to start the consolidator the server starts.
■ stop_consolidator.sh stops the consolidator on a UNIX server. It takes
$AC_SERVER_HOME as its argument. It reads pid of consolidator from
$AC_SERVER_HOME/etc/consolidator.pid and kills that process.
To start or stop the consolidator application manually, run the script from a
command shell. To start the application automatically, add the appropriate
script to the Actuate iServer startup and shutdown scripts.

Using the Windows startup and shutdown utility for the

log consolidator application
On a Windows system, the consolidator.exe utility for Actuate iServer
manages the consolidator application. The utility starts and stops the
consolidator application and installs and removes the application as a
Windows service. Before using the consolidator.exe utility, complete the tasks
listed in “Setting up the consolidator application,” earlier in this chapter, and
ensure that the consolidator.exe utility is in the Actuate iServer bin directory.
The default directory is:
C:\Program Files\Actuate8\iServer\bin
Use the consolidator.exe utility to install and configure the consolidator
application. This utility assumes it is running in the bin directory for Actuate
iServer.

Chapter 5, Actuate iSer ver System administration overview 191

 Use the following syntax with the consolidator utility:
consolidator [-H/-?] [-SserviceType] [-UuserName] [-PpassWord]
There is no space between an option and its value. The following table
describes the options.

Option Description
-S<type of service> Specify how to run the application:
console Start the application as a command-
line application.
auto Add the application as a Windows
service, and set the service to start
automatically.
manual Add the application as a Windows
service, and set it to start
automatically.
remove Remove the Windows service.
-H or -? Display help information in the command shell
window.
-U<user> Specify a system user to run the application.
For example, -UDomainName\UserName
specifies a domain and user name.
-U.\UserName specifies a local machine user
name.
-P<password> Specify the password for the user.

The following examples assume the commands are run from

C:\Program Files\Actuate8\iServer\bin using a command shell window:
■ The following command adds the consolidator service to the machine’s
Windows services and sets the service to start automatically using the
account Actuate and password actu8:
consolidator -Sauto -UActuate -Pactu8
■ The following command runs the consolidator service and the consolidator
application as a command line application:
consolidator -Sconsole
To stop the consolidator, press Ctrl+c in the command shell window.
■ The following command removes the consolidator service from the
machine’s Windows services:
consolidator -Sremove

192 Administering Actuate iSer ver System

Working with information objects and caching
Information architects use information objects to:
■ Control information retrieved from data sources.
■ Consolidate information from multiple data sources.
■ Cache data from remote data sources for offline use.
When an information architect makes information objects available in an
Actuate iServer System Encyclopedia volume, Actuate reports can use the
information objects as data sources. To use information objects, you must first
purchase and enable Actuate Query option for Actuate iServer System. For
more information about Actuate iServer System options, see “Understanding
the Actuate iServer System options” in Chapter 1, “Actuate iServer
architecture overview.”
An Encyclopedia volume administrator controls caching of information object
data. An administrator runs an information object and stores the resulting data
in an ACS cache database. Future queries using that information object use the
data stored in the cache database. When caching data, Actuate iServer uses an
external database and manages each information object cache independently.
Developers create an information object that retrieves the data from the data
source. An Administrator configures an information object in an Encyclopedia
volume to cache data based on issues such as the value of real-time data, the
network bandwidth available to access the remote data source, and the cost of
building and maintaining the cache database.
You cannot cache data for an information object that uses pass-through
security. For information about pass-through security, see “About information
object pass-through security” in Chapter 16, “Managing Encyclopedia volume
security.”
The following sections introduce topics related to the use of information
objects in Actuate iServer System.

About the Actuate Integration service (AIS) and

the Actuate Caching service (ACS)
Actuate iServer manages two services associated with information objects and
caching:
■ Actuate Caching service (ACS) performs the following functions:
■ Manages information object data cache database. For more information
about the information object cache database, see “Working with an

Chapter 5, Actuate iSer ver System administration overview 193

 Actuate Caching service (ACS) cache” in Chapter 19, “Administering
jobs.”
■ Manages the Record Matcher cache database. For more information
about the Record Matcher cache database, see “Understanding Actuate
Record Matcher,” later in this chapter.
ACS manages the ACS database, which is a configurable database. ACS
also performs functions such as adding and dropping databases, tables,
indexes, and inserting data into databases. For information about
supported DBMS platforms, see “About DBMS platforms for Actuate
Caching service (ACS) databases” in Chapter 19, “Administering jobs.” For
information about configuring the ACS database, see “About database
configuration for information object and Record Matcher caching,” later in
this chapter.
Using Actuate Caching service requires an Actuate iServer System license
that enables the Information Object Caching Option. For more information
about Actuate iServer options, see “Understanding the Actuate iServer
System options” in Chapter 1, “Actuate iServer architecture overview.”
■ Actuate Integration service (AIS) runs information object jobs and uses the
ACS as needed.
AIS and ACS are persistent, multithreaded processes that accept multiple
simultaneous requests. A Factory process communicates directly with AIS
using the ODA interface, not through Actuate iServer Message Distribution
service (MDS). ACS and AIS use the IDAPI to communicate with Actuate
iServer.
Actuate iServer in a stand-alone configuration runs single AIS and ACS
processes. In an Actuate iServer cluster, each node can run AIS and ACS
processes. You start and stop the AIS and ACS processes when you enable or
disable the AIS and ACS services. An Actuate iServer cluster distributes
information object jobs among the Actuate iServer nodes with AIS enabled.
Actuate iServer supports updating an information object cache and Record
Matcher data as a scheduled job. When the update job runs, a significant
amount of communication occurs between the AIS process and an Actuate
iServer Factory process. Actuate recommends enabling AIS on each Actuate
iServer node in a cluster to avoid performance issues related to intermachine
communication between a Factory process and an AIS process.
When running an information object job, Actuate iServer uses the Actuate
Integration service (AIS) to run an information object that retrieves data from
distributed, heterogeneous data sources. In some cases, the remote sources
may be too slow or not available. To ensure data is available for an information
object job, you can configure the AIS to use the ACS to cache data. Caching
data ensures access to data and can improve access time.

194 Administering Actuate iSer ver System

The following diagram shows the communication among the Actuate iServer
components when running an information object that uses a Record Matcher
application from an Encyclopedia volume.

Actuate
iServer

Encyclopedia
volume

AIS ACS
process process

Data source
Record
Caching and
Matcher
Record Matcher
application
databases

About information object file types

Using Actuate Management Console, you create the following Encyclopedia
volume file types to cache information object data:
■ Information object cache definition (.icd) file
■ Record Matcher definition (.xrd) file
Creating an ICD or XRD creates the required data structures in the ACS DBMS
hold information object data or Record Matcher data. Deleting an ICD or XRD
deletes the corresponding data and data structures in the ACS DBMS. Both file
types require the Actuate iServer Actuate Caching Option for Actuate iServer
System and a DBMS that is configured to work with the Actuate Caching
service (ACS). For information about database configuration, see “About
database configuration for information object and Record Matcher caching,”
later in this chapter.

Chapter 5, Actuate iSer ver System administration overview 195

 The following table describes the file types for information objects in an
Encyclopedia volume.

File type Name Description

DCD Data connection Contains properties to identify and connect
definition to a particular external data source, such as a
database or external application.
Properties consist of data source type,
connection properties, and pass-through
security type.
SMA Data source map Represents a single set of data from a data
source, such as a database table, a stored
procedure, or an SAP BAPI.
Properties consist of schema information
such as parameter and column names,
information to access a data source, and
caching configuration.
IOB Information Presents a view of a data source, a logical set
object of data from other maps or information
objects. Supports row-level security.
Properties consist of schema information
such as parameter and columns names,
other properties such as a query, editing
state, and caching configuration.
ICD Information Contains configuration information for
object cache caching data that a data source map SMA or
definition information object IOB uses. Each cache is
stored in an external DBMS configured for
the Encyclopedia volume.
Properties consist of SMA or MAP
information and cache state information.
XRD Record Matcher Contains configuration information for a
definition Record Matcher database, which
implements indirect joins between disparate
data sources. For more information about
Record Matcher, see “Understanding
Actuate Record Matcher,” later in this
chapter.
Properties consist of list of data sources for
which to create joins, matching
configuration, location of resulting join table.

196 Administering Actuate iSer ver System

Actuate iServer does not support versioning an IOB, SMA, DCD, ICD, or XRD
file in an Encyclopedia volume. For example, when creating a new version of
an IOB, you must manually update the dependency information, Actuate
iServer does not manage dependencies between file versions in an
Encyclopedia volume.
If an information object uses another information object or map as input, that
relationship information is internal to the information object and is specified
only by name, no Encyclopedia version information such as file ID or version
is used.

About database configuration for information

object and Record Matcher caching
Use Actuate Management Console to configure Actuate iServer to access a
database for both information object caching and Record Matcher. Information
object caching and Record Matcher configuration includes:
■ Identifying the cluster nodes running ACS.
■ Identifying the ACS database using an information object cache definition
ICD, and the credentials used by ACS to access the database.
■ Identifying an information object or map that use the cache, including
configurable properties such as indices to add.
■ Identifying a Record Matcher database including properties used to create
the Record Matcher database, such as the Record Matcher application.
For more information, see “Working with an Actuate Caching service (ACS)
cache” in Chapter 19, “Administering jobs.”

Understanding Actuate Record Matcher

When integrating data, you often need match records from different data
sources. For example, you need to match records from the different databases
that refer to the same customer, product, or accounting category. Matching the
data requires a join key. A join key is a field or set of fields from each record
that is equal when both records refer to the same data. Actuate provides
several options for producing a join key when you want to integrate data from
disparate data sources.
Actuate supports the Record Matcher Framework, which consists of software
components and information objects that work together to create, update, and
use a Record Matcher cache. Actuate e.Services creates Record Matcher
applications using the framework. Actuate Record Matcher supports the
ability to merge two data sources that do not contain a common key field.
Actuate e.Services uses the Record Matcher Framework to create an
application that merges data from multiple databases.

Chapter 5, Actuate iSer ver System administration overview 197

 Actuate iServer uses a Record Matcher application and an information object
to merges two data sources into a single information object view. A Record
Matcher application creates a join key based on pattern matching algorithms
that match data from the two databases. The application stores the join key
and other matching information in a Record Matcher cache. In most cases, it is
more efficient to use a natural or generated join key directly in an information
object rather than to create a Record Matcher cache. Using the Record Matcher
involves the additional overhead of data access to the Record Matcher cache to
integrate and use the data.
Using the matching information from a Record Matcher cache, an information
object retrieves data from the data sources associated with the Record Matcher
cache in a manner similar to retrieving data from two joined tables using a
common key field.
The following illustration shows the relationship of various components of the
Record Matcher process.

Application
information
object

Record Matcher
Data source
Information
information
objects
objects

Record Matcher Record Matcher

Data source
file database cache
information
connection
objects

Related data Record Matcher

Record Matcher
sources application
cache

Record Matcher technology supports combining data from different data

sources that contain related information for which there is no common key. To
create an application information object or map that uses data from the data
sources, create Record Matcher components that match records from the data

198 Administering Actuate iSer ver System

sources. The preceding illustration uses the term information object for both
information objects and maps. In the illustration:
■ The data sources contain related data that has no common key.
■ The Record Matcher file contains the names of the information objects that
the Record Matcher application uses, the name of the Record Matcher
application, and the information about the Record Matcher database that
stores the Record Matcher cache. For information about creating and
configuring a Record Matcher file, see “Creating a Record Matcher
definition file” in Chapter 19, “Administering jobs.”
■ The Record Matcher application matches records from the data sources
based on data-source specific algorithms.
■ The Record Matcher cache contains the results of the Record Matcher
application that matches records from the data sources.
■ The Record Matcher information objects use the Record Matcher database
cache connection to retrieve information about the records that match in
the data sources.
■ The Application information object uses the data from the Record Matcher
information objects to match records from the data source information
objects.
In the illustration, there are two sets of data source information objects:
■ The Record Matcher file and Record Matcher application uses a set of data
source information objects to create the data in the Record Matcher cache.
■ The application information object uses the a set information objects to
retrieve data from the data sources.
The Application information object and the Record Matcher file can use the
same set of data source information objects.
Record Matcher application data in an Actuate Caching service (ACS)
database is a specialized form of information object data caching that takes
input data from an information object and stores it in a Record Matcher
database. A Record Matcher component performs the following functions:
■ The information object in the Encyclopedia volume determines input for
the job.
■ The Record Matcher application builds a Record Matcher cache and
populates the cache with data. For more information about the Record
Matcher application, see “About Record Matcher applications,” later in this
chapter.
■ The Record Matcher cache stores the output of the Record Matcher
application. For more information about the Record Matcher cache, see

Chapter 5, Actuate iSer ver System administration overview 199

 “Understanding the structure of the Record Matcher cache,” later in this
chapter.
The following table shows data integrated from two databases using customer
names. The table shows the exact name match for Mike Eaton and the
approximate name match for Dorothy Blakely and Dot Blakely.

Source 1 FullName Source 2 FullName

Empire Bill Ming
Empire Mike Eaton Acme Mike Eaton
Empire Harry Saski
Empire Dorthy Blakey Acme Dot Blakey
Empire G.H. Harrah
Empire Kelley Presott Acme Kelly Prescot
Empire Darren Bartels
Empire Jenifer Wats
Empire Lisa A. Cunningham Acme Lisa Cunningham

About Record Matcher Framework installation and

configuration
The Record Matcher Framework consists of software components and
information objects that work together to create, update, and use a Record
Matcher cache. The main components required to use a Record Matcher
application with Actuate iServer are the Actuate Caching service (ACS), a
Record Matcher application, information objects, and a Record Matcher cache.
You install and configure a Record Matcher application on an Actuate iServer
machine. In an Actuate iServer cluster, you must install and configure the
Record Matcher application on every Actuate iServer node with ACS enabled.
The Record Matcher application uses the standard matcher or customized
matching software. A Record Matcher application is a java archive (.jar) file.
The installation location for the JAR file is the Actuate iServer directory
\RecordMatcher\matchers.
The Record Matcher JAR contains the following files:
■ Configuration file that contains configuration information, including the
name of the matcher, matching schema, and supported parameters.
■ Java code archives that contain the Java implementations of matcher
transactions.
■ Shared library files that contain native implementations of matcher
transactions.

200 Administering Actuate iSer ver System

■ DDL template code that contains database-specific SQL implementations
of matcher transactions.
After you install and configure the application and start Actuate iServer, ACS
unpacks any new or changed files in the directory into another directory to get
access to the file’s contents.

About Record Matcher applications

A Record Matcher application and the Record Matcher cache it creates depend
on customer data and requirements. For example, an application that matches
names and addresses can work with many databases. An application that
matches data such as part inventories from two databases varies from one
enterprise to the next. Actuate supplies a standard matcher that handles a
wide variety of matching requirements. Actuate e.Services can create a custom
matching application for a specific situation using the Actuate Record Matcher
Framework.
Within the Actuate Record Matcher Framework, a Record Matcher application
contains the logic and business rules that associate data from different data
sources. The application uses the logic and rules to create and update a Record
Matcher cache that contains a mapping of matched records between the two
data sources.
The Record Matcher application takes data from a source application record,
compares the data with processed record data, and assigns a group ID
(ResultId) to the new record. The group IDs identify matching records from
the data sources based on the record’s data and the matcher’s logic and rules.
Actuate e.Services creates Record Matcher applications in Java or SQL. An
application can use simple string manipulation routines or sophisticated
components that perform name and address matching with built-in
knowledge of name variants. For example, a Record Matcher application can
match the name Bob with Robert or Bobby.
The Actuate Record Matcher Framework supports creating sophisticated
Record Matcher applications that are based on existing matching applications.
For example, Actuate e.Services can use the Record Matcher Framework to
build an application using the third party NameSearch matching program that
ships with the Record Matcher Framework or another matching application
that provides name and address matching.
The standard matcher is an Actuate Record Matcher application that provides
a wide range of name and address matching capabilities within the framework
of a single Record Matcher application, reducing the need to develop a
customer-specific Record Matcher application. The standard matcher relies on
a third-party library NameSearch, which is provided by Intelligent Search
Technology, Ltd. To use NameSearch confirm that it is installed and configured
before you begin your Record Matcher project.

Chapter 5, Actuate iSer ver System administration overview 201

 Understanding the structure of the Record Matcher cache
A Record Matcher application creates a Record Matcher cache that consists of
relational tables in an Actuate Caching service (ACS) database. The Record
Matcher cache contains the output of the Record Matcher application from the
set of data sources. The output includes a table that matches the data sources’
key fields. After you create the Record Matcher cache, you can map data from
the data sources as another XML data source to be used by an information
object. For information about creating the Record Matcher cache, see “Creating
a Record Matcher definition file” in Chapter 19, “Administering jobs.”
Not every Record Matcher cache has same schema. Each row in the Record
Matcher cache corresponds to a single record in one of the Record Matcher
data sources. In the Record Matcher cache, you can define manual overrides
for Record Matcher groupings that explicitly describe matching data source
records. The following table describes the fields that are common to all Record
Matcher caches.

Field Description
ResultId Identifies corresponding data source records. The
ResultId functions as a generated master key that
joins data sources. The Record Matcher
application assigns the same ResultId to each
matching data source record based on the data
source fields the matcher compares. For example,
if the matcher compares data from a name field
and matches the name Bob Jones with William
Jones, the matcher assigns the same ResultId to
the records in the Record Matcher database. Each
group of records with matching data have the
same ResultId. An information object uses the
ResultId to retrieve related data from the data
sources.
SourceApplicationName Identifies the data source.
SourceApplicationKey Identifies the data source record based on key
field data.

A Record Matcher application updates a Record Matcher cache by running

one or more transactions. For example, a transaction updates the Record
Matcher cache with new data from a source data. Another transaction updates
the database table that controls explicit Record Matcher groupings, manual
overrides of the matcher groupings.
ACS supports implementing, executing, and monitoring matcher transactions.
ACS also provides generic transaction implementations for common
operations, such as performing a simultaneous update or matching.

202 Administering Actuate iSer ver System

Use Record Matcher manual overrides to explicitly specify group membership
and override all other grouping processes. Specify manual overrides in the
database table SourceApplicationNames.
The manual override table contains source application names, source
application keys, and manual override actions. The Record Matcher
application performs the specified action on the associated source application
data. Creating and maintaining manual override data is typically a manual
process.
The following illustration shows the relationship of a Record Matcher
database with two data sources called Acme and Empire.
Empire

Data
Lname: Smith vchLastName: Smith
Fname: Mary vchFirstName: Marie
Lname: Adams vchLastName: Adams
Fname: Samuel vchFirstName: Sammy

Encyclopedia volume
Acme Empire
XML View XML View

Actuate Integration service (AIS) and

Record Matcher application

Samuel Adams Sammy Adams

SourceApplicationKey---- 1 matches SourceApplicationKey--- 83

Mary Smith Marie Smith

SourceApplicationKey---31 matches SourceApplicationKey--172

Record Matcher cache

Data SourceApplicationName SourceApplicationKet ResultID

Acme 1 2
Empire 83 2
Acme 37 48
Empire 172 48

Chapter 5, Actuate iSer ver System administration overview 203

 Understanding Record Matcher application limitations
Actuate iServer generates an error when a Record Matcher application
updates a Record Matcher cache with the with the following types of
information objects:
■ An information object that uses required parameters. Actuate iServer
ignores an information object’s optional parameters when it updates a
Record Matcher cache.
■ An information object that uses pass-through security.
■ An information object that uses a query with run-time information. For
example, the information object calls a function to determine an Actuate
iServer System user name or role.
■ An information object that does not conform to the Record Matcher source
schema and cannot be represented in the Record Matcher cache.
The following behaviors and characteristics affect the Record Matcher
database:
■ The Actuate Caching service assumes that the Record Matcher application
updates the Record Matcher cache.
■ Actuate iServer displays job information as part of a completed job’s detail
information on Jobs—Completed or as a log file entry. You can use IDAPI
to retrieve information about the Record Matcher jobs that you run using
IDAPI. A Record Matcher application developer can create separate
monitoring software to track details of updates, such as monitoring the
loading process or monitoring the matching process.
■ If the Record Matcher database DBMS fails catastrophically during an
update, and you cannot restore it, the Record Matcher DBMS DBA can
attempt to reset the cache database.

204 Administering Actuate iSer ver System

 Chapter

Working with Chapter 6

6
system-wide Actuate
iServer parameters
This chapter contains the following topics:
■ About parameters for an Actuate iServer node or stand-alone machine
■ Modifying general Actuate iServer parameter values
■ Setting up cluster master failover
■ Working with Actuate iServer System usage and error logging
■ Managing Actuate iServer e-mail notification
■ Configuring default regional settings
■ Working with Actuate iServer System license information
■ Specifying advanced Actuate iServer System parameter values

Chapter 6, Working with system-wide Actuate iServer parameters 205

About parameters for an Actuate iServer node or
stand-alone machine
An Actuate iServer System administrator specifies values for the parameters
that appear on the System—Properties subpages for an Actuate iServer node
or stand-alone Actuate iServer machine.
The following sections describe the System—Properties subpages.

Modifying general Actuate iServer parameter values

When Actuate iServer is online, an administrator can choose Properties on
System—Status to display System—Properties—General. On System—
Properties—General, an administrator can modify the values for the Actuate
iServer parameters that apply to an Actuate iServer node or an Actuate iServer
machine in a stand-alone configuration.

206 Administering Actuate iSer ver System

Chapter 6, Working with system-wide Actuate iServer parameters 207
 The following table describes the parameters that appear on System—
Properties—General. If Actuate iServer is in a stand-alone configuration, only
the System password, System password confirm, Volume, and Partition fields
appear. All fields that appear in the following table are available for an
Actuate iServer cluster.

Parameter Description
System name Actuate iServer machine name.
System password System password.
System password System password confirmation.
confirm
Heartbeat failure period Time, in seconds, between system monitoring
responses. If Actuate iServer System does not
receive a response within this period, Actuate
iServer System assumes that the Actuate iServer
machine is down. The default value is 90
seconds.
Heartbeat send period Time, in seconds, after which the Message
Distribution service sends a request for Actuate
iServer machine health information from all the
cluster nodes. The default value is 30 seconds.
System UDP port If you use UDP, the UDP port for unicast. If you
specify a value for this parameter, Actuate
iServer System ignores the multicast address, the
multicast port, and the multicast TTL.
System multicast If you use Multicast, the multicast IP address to
address which all servers must belong for Actuate iServer
System to be multicast-enabled.
System multicast port If you use Multicast, the port to which all Actuate
iServer machines in Actuate iServer System listen
for multicast communication.
Multicast TTL If you use Multicast, the maximum number of
point-to-point links (hops) allowed in a packet’s
transmission path. The default value is 1 hop.

208 Administering Actuate iSer ver System

 Parameter Description
Volume Default Encyclopedia volume for Actuate iServer
System. This volume is the Encyclopedia volume
that appears as the default volume on the
Actuate Management Console login page.
Partition Home partition for this configuration of Actuate
iServer. This partition stores the configuration
information for Actuate iServer. The default
value is the AC_SERVER_HOME/etc directory.
The location of the configuration information
affects how Actuate iServer starts. For
information about Actuate iServer System
startup, see “Managing an Actuate iServer
cluster” in Chapter 5, “Actuate iServer System
administration overview.”

How to modify general Actuate iServer parameter values

1 Take Actuate iServer online, if necessary. For information about how to
take stand-alone Actuate iServer online, see “Working with offline Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”
2 On System—Status, choose Properties.
System—Properties—General appears.
3 Change the general system parameter values, as necessary. Choose OK.

Setting up cluster master failover

The following sections provide information about setting up cluster master
failover.
For information about other types of failover that Actuate iServer System
supports, see “About the Actuate iServer cluster configuration file” in Chapter
5, “Actuate iServer System administration overview.”

About Actuate iServer cluster master failover

An Actuate iServer cluster performs a cluster master failover under the
following conditions:
■ The encycsrvr7 process on the Actuate iServer cluster master fails. For
example, the Actuate iServer cluster master loses power.

Chapter 6, Working with system-wide Actuate iServer parameters 209

 ■ The encycsrvr7 process on the Actuate iServer cluster master cannot send
heartbeat messages. For example, the cluster master machine cannot access
the network.
If the encycsrvr7 process on an Actuate iServer cluster master fails, the
Message Distribution service (MDS) for the cluster starts the failover sequence
to create a new cluster master. When an Actuate iServer cluster master backup
node with MDS enabled does not detect the cluster master’s heartbeat, the
backup nodes with MDS enabled start the cluster master failover to create a
new cluster master. If the failed Actuate iServer cluster master manages an
Encyclopedia volume, Encyclopedia volume failover begins when the cluster
master failover sequence completes. For information about Encyclopedia
volume failover, see “Failing over an Encyclopedia volume” in Chapter 9,
“Working with an Actuate iServer System volume.”

Specifying a backup cluster master

On System—Properties—Backup Master Assignment, an Actuate iServer
System administrator can view and manage Actuate iServer nodes that serve
as backup cluster masters, as shown in the following illustration.

To support backup cluster masters, you must enable the Message Distribution
Service for each Actuate iServer node that is a backup cluster master. The
configuration home partition must also be in a partition that the backup
cluster master can access. The default location of the configuration file is not in
a partition. For information about creating a partition, see “Adding a
partition” in Chapter 8, “Working with an Actuate iServer System partition.”

210 Administering Actuate iSer ver System

 For information about specifying the location of the configuration file, see
“Modifying general Actuate iServer parameter values” in Chapter 6, “Working
with system-wide Actuate iServer parameters.”
On Servers—Properties—Backup Master Assignment, an Actuate iServer
System administrator can use the left and right arrows to move Actuate
iServer names between Available servers and Assigned backup master
servers:
■ Available servers lists servers that meet the following conditions:
■ The server is an Actuate iServer node in the cluster.
■ The Message Distribution service is enabled on the Actuate iServer
node.
■ Assigned backup master servers lists the Actuate iServer nodes that can act
as cluster masters. The name of the current cluster master always appears
in Assigned backup master servers.
For information about changing the Actuate iServer cluster master, see
“Changing the cluster master” in Chapter 7, “Working with an Actuate iServer
System server.”

How to modify the backup cluster master setup

1 Take Actuate iServer online, if necessary. For information about how to
take stand-alone Actuate iServer online, see “Working with offline Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”
2 On System—Status, choose Properties.
System—Properties—General appears.
3 Choose Backup Master Assignment.
System—Properties—Backup Master Assignment appears.
4 Modify the backup cluster master setup:
■ To add an Actuate iServer node as a backup cluster master, select the
server in Available servers and choose the right arrow.
■ To remove an Actuate iServer node from the list of assigned backup
cluster masters, select the server in Assigned backup master servers,
and choose the left arrow.
Choose OK.

Chapter 6, Working with system-wide Actuate iServer parameters 211

Working with Actuate iServer System usage and
error logging
The Actuate iServer System usage and error logging is based on the Actuate
iServer monitoring framework. This framework uses two application
programming interface (API) to create applications that monitor Actuate
iServer, the Actuate Usage Logging Extension API and the Actuate Error
Logging Extension API. A developer can use the framework to integrate
information with monitoring tools, such as Windows 2000 performance
monitor. For more information about the monitoring framework, see
Chapter 4, “Using the Report Server API,” in Programming Actuate iServer
Applications.
Actuate ships usage and error logging applications with Actuate iServer based
on the Actuate iServer monitoring framework. The Actuate usage and error
logging applications that ship with Actuate iServer support sending usage
activity and error information to a log file. The logging applications use
Actuate Logging APIs.
Actuate iServer Release 8 introduces support for the consolidation of log
information into a database. The application consolidates log data in an Oracle
database.
For information about configuring and using system usage or error logging,
see the appropriate topic:
■ “Configuring and using system usage logging”
■ “Configuring and using error logging”
For information about using the consolidator application to consolidate
Actuate iServer System usage and error log information, see “Consolidating
Actuate iServer usage and error log data” in Chapter 5, “Actuate iServer
System administration overview.”
In an Actuate iServer cluster, asynchronous report execution log entry is in the
log of the Encyclopedia process node. For a synchronous or transient report
generation, the log entry is in the log file of the node that runs the report.
The Actuate iServer Release 7 implementation of usage and error logging is
compatible with usage and error logging in Actuate iServer Release 8. The
APIs support previous release usage and error logging applications. Actuate
iServer does not support using logging applications from different releases.
For example, you cannot use a Release 7 usage logging application with a
Release 8 an error logging application.
To use a Release 7 error logging or usage logging application, recompile the
application with the Release 8 usage logging and error logging header files.
The header files ship with the Actuate iServer Integration Technology product.

212 Administering Actuate iSer ver System

 Actuate iServer Release 8 can use a usage logging or error logging application
that you created for a previous release of Actuate iServer. To use a usage or
error logging application that you created for a previous release of Actuate
iServer, you must configure Actuate iServer Release 8 to use the logging
application from the earlier release. You cannot use the consolidator
application with a previous release usage or error logging application.
For the usage and error logging applications that ships with Actuate iServer,
usage and error log file entries are not backward compatible. The format and
of the log file entries and the information logged change from release to
release. The entries in Actuate Release 8 usage and error log files contain more
information than in previous releases. If a developer uses an application that
uses information from an Actuate iServer log file and uses the Actuate Release
8 usage and error logging extension applications, the developer must ensure
that the utility can process the data in the log files.

Configuring and using system usage logging

For the Actuate usage logging application that ships with Actuate iServer, the
name of the system usage log file for Actuate iServer is usage_log.csv. The
default location for the log file is $AC_SERVER_HOME/log, which is the log
directory for Actuate iServer. An administrator can configure each log to
record either standard or detailed information.
Before you set up system usage for an Actuate iServer System cluster, you
must ensure that each Actuate iServer node in a cluster has the same logging
applications installed. The following sections contain information about how
to configure and use the system usage logging functionality:
■ For information about how to enable system usage logging, see “Enabling
system usage logging for Actuate iServer,” later in this chapter.
■ For information about standard and detailed log entries and other
information about system usage logging, see “Understanding the system
usage log,” later in this chapter.
For information about using Actuate iServer diagnostic logging, see
“Configuring and using diagnostic logging” in Chapter 7, “Working with an
Actuate iServer System server.” For information about Actuate iServer error
logging, see “Configuring and using error logging,” later in this chapter.

Chapter 6, Working with system-wide Actuate iServer parameters 213

 Enabling system usage logging for Actuate iServer
An Actuate iServer administrator can configure usage log settings for report
viewing, printing, generation, and deletion on System—Properties—Usage
Logging.

214 Administering Actuate iSer ver System

 The default usage logging configuration uses the usage logging application
that ships with Actuate iServer. The following table describes the parameters
that appear on System—Properties—Usage Logging.

Parameter Description
Enable If selected for a type of log, Actuate iServer logs
the corresponding information. The options are:
■ A viewing log records report viewing events
that use the View process.
■ A printing log records report printing events.
■ A factory log records report generation
events.
■ A deletion log records the deletion of
Encyclopedia volume files.
■ An administration log records Encyclopedia
volume administration events, such as:
■ Managing users, roles, groups, and
channels
■ Uploading and deleting files
■ Changing file and folder properties
■ A Data Integration log records Actuate
Integration service (AIS) events, such as:
■ Information object jobs
■ Cache update jobs
■ Record Matcher update jobs

Chapter 6, Working with system-wide Actuate iServer parameters 215

 Parameter Description
Logging level Type of information or events to log. The options
are:
■ Standard
■ Detailed
If you select Detailed, the application writes more
information to the log file, decreasing Actuate
iServer performance.
Usage logging Name of the DLL or shared library that Actuate
extension iServer uses to generate the log files.
The default name is UserActivityLoggingExt, the
usage logging application that ships with
Actuate iServer. The default location for the
application is $AC_SERVER_HOME/bin, the bin
directory for Actuate iServer.
Type the name of the DLL or shared library
without the file-name extension. For example, on
a Windows system, if the DLL is
CustomUsage.dll, type:
CustomUsage

For information about the type of information that Actuate iServer the usage
logging application records, see “Understanding the system usage log,” later
in this chapter.

How to configure system usage logging

1 Take Actuate iServer online, if necessary. For information about how to
take stand-alone Actuate iServer online, see “Working with offline Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”
2 On System—Status, choose Properties.
System—Properties—General appears.
3 Choose Usage Logging.
System—Properties—Usage Logging appears.
4 Set up system usage logging. Choose OK.

Understanding the system usage log

For the usage logging application that ships with Actuate iServer, the system
usage log stores either standard or detailed information about user activity. A

216 Administering Actuate iSer ver System

 user can choose to log different types of activities and to record either standard
or detailed information.
For viewing, deletion, and printing activity, detailed and standard information
are the same in logging application that ships with Actuate iServer. For
Factory activity, detailed information includes report parameters. Logging
detailed Factory information, instead of standard Factory information, causes
performance degradation.
To log usage information at a level similar to Release 7 Actuate iServer, specify
standard level for Viewing, Printing, Factory, and Deletion logging and disable
Admin and Data integration logging. For information about setting up system
usage logging, see “Configuring and using system usage logging,” earlier in
this chapter.
The following table lists the system usage information that Actuate iServer
records.

Attribute Description
ClusterName Name of the cluster node that processes the
request.
FinishRequest Time when Actuate iServer finishes processing
Processing the request. The value is the time, in seconds,
since 00:00:00, Jan. 1, 1901, GMT. The usage
logging application that ships with Actuate
iServer translates the number to a date and time
when you enable the advanced usage and error
logging parameter Display date time as string.
NumberOfPages Number of pages generated. Only for report
Generated generation.
NumberOfPagesPrinted Number of pages printed. Only for server-side
printing.
NumberOfPagesViewed Number of pages viewed. If the transaction type
is to download a report, this attribute records the
number of pages that were downloaded after
viewing.
PrintedPageNumbers Page numbers that were printed. Only for server-
side printing.
PrintTime Time that it takes a job to print. Only for server-
side printing.
ReportExecutableName Full path and name of the report object
executable (.rox) file. Only for report generation.
ReportExecutable Version number of the report object executable
Version (.rox) file. Only for report generation.

Chapter 6, Working with system-wide Actuate iServer parameters 217

 Attribute Description
ReportName Full path of the report the user accesses.
ReportVersion Version number of the report the user accesses.
ReportParameters Parameters that Actuate iServer uses to execute
the report. Only for report generation.
RequestStatus Status of the transaction or request. The status is
either failure or success.
ServerName Name of the Actuate iServer machine that
processes the request.
SizeOfReport Size, in bytes, of the report that the user accesses.
StartRequestProcessing Time when Actuate iServer starts processing the
request. The value is the time, in seconds, since
00:00:00, Jan. 1, 1901, GMT. The usage logging
application that ships with Actuate iServer
translates the number to a date and time when
you enable the advanced usage and error logging
parameter Display date time as string.
SubmitTimestamp Time when the Actuate iServer receives the
transaction or request. The value is the time, in
seconds, since 00:00:00, Jan. 1, 1901, GMT. The
usage logging application that ships with
Actuate iServer translates the number to a date
and time when you enable the advanced usage
and error logging parameter Display date time as
string.
TransactionType Type of the transaction, such as print a report,
execute a report, view a report document,
download a report file, delete or update a report,
update report properties, shut down or restart
Actuate iServer, or update the Actuate iServer
configuration.
UserName Name of the person who submits the transaction.
Viewed page numbers Page numbers that the user views. Only for
viewing events.
View format Format in which reports a user views a report
before downloading it. Only for viewing.
Volume Name of the Encyclopedia volume that originates
the request.
File type Encyclopedia volume file type.

218 Administering Actuate iSer ver System

 Attribute Description
Job type Job type. The values are 1 for Asynchronous, 2
for Persistent, or 3 for Transient.
Object type Encyclopedia volume item, such as user, role,
channel, file, folder.
Job name Name of job.
job priority Job priority level.
Output format Format to use for the output of the request.
Resource group name Resource group specified for request.
Operation Administrative operation such as create, delete,
modify, login

About the system usage log

For the usage logging application that ships with Actuate iServer, a usage log
entry is a comma-separated list of 40 fields of data. The data consist of four
groups, which the file lists in the order in which they appear in the following
table.

Group Description
General Fields 1 through 5. The general information
consists of a comma-separated list of general
event information:
■ Log file time stamp
■ Event type
■ Event result
■ Start time
■ Finish time
The event result is either 1 for success or 0 for
failure.
Report output Fields 6 through 8. The report information
consists of a comma-separated list of report
output information for report generation,
viewing, and download events:
■ Document file name, – for no file name.
■ Document file version, – for no file version.
■ File size, 0 for no file size.
The report output group information appears
only with report events and not with user, or role
events.

Chapter 6, Working with system-wide Actuate iServer parameters 219

 Group Description
Execution Fields 9 and 10. The execution information
consists of the following of a comma-separated
list of information:
■ User name
■ Actuate iServer subsystem
Operation String fields 11 through 25 followed by numeric
fields 26 through 40
The operation group information in a log entry
depends on the type of event logged. In general,
the operation group information consists of items
such as the Encyclopedia volume name, the
Actuate iServer machine name, and the job type
of a job request.

The logging application that ships with Actuate iServer enters a dash –, for a
string field with no data, and enters a 0 for a numeric field with no data.
The logging application uses the Microsoft Excel quoting conventions for
string fields.
For each event type, the logging application lists one of the following
execution subsystems in field 10.

Subsystem ID number
ReportEngine 1
ViewEngine 2
EncycEngine 3
IntegrationEngine 4
Cache 5

Administration event can have one of the following operation IDs as numeric
field 26:

Operation ID number
Create 1
Delete 2
Modify 3
Login 4
Logout 5

220 Administering Actuate iSer ver System

 The following table describes the data Actuate iServer logs for each of the
different event types.

Type of event Description of log entry

Report For report generation events, Actuate iServer records general, report, and
generation. Field operation group information. The following comma-separated list is the
2 value is 1. operation data for a for report generation entry at the standard logging
level. String fields 11 through 21 display the following information:
– ,executable name, executable version, volume name, server name,
cluster name, resource group name, node running request, page count,
job name, request ID

Numeric fields 26 through 29 display the following information:

number of pages,submit time, job type, job priority

At the detailed logging level, the logging application enters the report
parameters in field 11.
For cube report or e.Spreadsheet report generation events, Actuate iServer
logs the following operation data when using either the standard or detail
logging level. String fields 11 through 16 display the following
information:
executable name, executable version, volume name, server name, cluster
name, job priority

Report printing. For report printing events, Actuate iServer logs general, report, and
Field 2 value is 2. operation group information. The following comma-separated list is the
operation group information for report printing errors at the standard
logging level.
String fields 11 through 18 display the following information:
page numbers printed, volume name, printer name, server name, cluster
name, node sent to, file type, server request id

Numeric fields 26 through 29 display the following information:

number of pages printed, submit time, job type, job priority

At the detailed logging level, Actuate iServer add the printer name to
string field 13.

Chapter 6, Working with system-wide Actuate iServer parameters 221

Type of event Description of log entry
Report viewing. For report viewing events, Actuate iServer logs general, report, and
Field 2 value is 3 operation group information. Download operations, such as download as
Excel or RTF, are viewing operations. The following comma-separated list
is the operation group information for viewing operations at the standard
logging level.
String fields 11 through 18 display the following information:
output format, page numbers, volume name, server name, cluster name

Numeric field 26 displays the number of pages viewed.

Search. Field 2 For report search events for reports viewed in DHTML format, Actuate
value is 7. iServer logs general, and operation group information. Download
operations, such as download as Excel or RTF, are viewing operations. The
following comma-separated list is the operation group information for
viewing operations at the standard logging level. String fields 11 through
15 display the following information:
report format, page numbers, volume name, server name, cluster name

Numeric field 26 displays the number of pages viewed.

Administrative. For administrative events, Actuate iServer logs general and operation
Field 2 value is 5. group information. The operation group starts with the following
information String fields 11 through 13display the following information:
<volume name>, <server name>, <cluster name>

Field 10, the subsystem, is EncyclopediaEngine, ID 3.

The following rows in this table describe the information that Actuate
iServer appends to the operation group information for the following
operation types:
■ User login
■ Create, delete, and update the following Encyclopedia volume items:
■ User
■ Role
■ Group
■ Channel
■ Folder
■ File

222 Administering Actuate iSer ver System

Type of event Description of log entry
User For user login events, Actuate iServer appends the comma-
separated list of operation information fields for standard
and detailed logging levels. String fields 14 through 16
display the following information:
Login, <user name>, <client>

Numeric field 26 is 4.
The field 14 value is Login and the client value is either
RSAPI or IDAPI.
For user logout events, Actuate iServer logs only RSAPI
client logout.
Logout, <user name>, RSAPI

Numeric field 26 is 5.
When creating a user, Actuate iServer appends the comma-
separated list of operation information fields for both
standard and detailed logging levels. String fields 14 and 15
display the following information:
User, <name of the user>

Numeric field 26 value is 1.

When deleting a user, Actuate iServer appends the comma-
separated list of operation information fields for both
standard and detailed log levels. String fields 14 and 15
display the following information:
User, <name of the user>

Numeric field 26 value is 2.

When modifying a user’s name, e-mail, home folder, notice
expiration time, or privileges, Actuate iServer appends the
comma-separated list of operation information fields for
both standard and detailed logging levels. String fields 14
through 17 display the following information:
User, <user attribute>, <old value>, <new value>

Numeric field 26 value is 3.

User attribute can be Name, Email, HomeFolder,
NoticeExpiration or Privilege.
When changing a user’s privilege template, Actuate iServer
logs the attribute changed as Privilege and lists the new
privileges.

Chapter 6, Working with system-wide Actuate iServer parameters 223

Type of event Description of log entry
Role When creating a role, Actuate iServer appends the comma-
separated list of operation information fields for both
standard and detailed logging levels. String fields 14 and 15
display the following information:
Role, <role name>

Numeric field 26 is 1.
When deleting a role, Actuate iServer appends the comma-
separated list of operation information fields for standard
and detailed logging levels. String fields 14 and 15 display
the following information:
Role, <role name>

Numeric field 26 is 2.
When updating role properties, Actuate iServer logs the
following comma-separated list of operation information
fields for standard and detailed logging levels. String fields
14 through 17 display the following information:
Role, <role property>, <old name>, <new name>

Numeric field 26 is 3.
Actuate iServer logs the following changes for a role:
■ Changing a role name
■ Adding a user
■ Deleting a user
■ Changing privileges
Role property can be Name, AddUser, DeleteUser, or
Privilege. When changing a roles’s privileges, Actuate
iServer logs the attribute changed as Privilege lists the new
privileges.

224 Administering Actuate iSer ver System

Type of event Description of log entry
Notification When creating a notification group, Actuate iServer
group appends the comma-separated list of operation information
fields for standard and detail log levels. String fields 14 and
15 display the following information:
Group, <notification group name>

Numeric field 26 is 1.
When deleting a notification group, Actuate iServer logs the
following comma-separated list of operation information
fields for standard and detail log levels. String fields 14 and
15display the following information:
Group, <notification group name>

Numeric field 26 is 2.
When updating notification group properties, Actuate
iServer appends the comma-separated list of operation
information fields for standard and detail log levels. String
fields 14 through 17 display the following information:
Group, <attribute>, <old value>, <new value>

Numeric field 26 is 3.
Actuate iServer logs changes to the following notification
group properties:
■ Group name
■ Adding a user
■ Deleting a user
Attribute can be Name, AddUser, or DeleteUser.

Chapter 6, Working with system-wide Actuate iServer parameters 225

Type of event Description of log entry
Channel When creating a channel, Actuate iServer appends the
comma-separated list of operation information fields for
standard and detail log levels. String fields 14 and 15
display the following information:
Channel, <channel name>

Numeric field 26 is 1.
When deleting a channel, Actuate iServer appends the
comma-separated list of operation information fields for
standard and detail log levels. String fields 14 and 15
display the following information:
Channel, <channel name>

Numeric field 26 is 2.
When updating a channel, Actuate iServer appends the
comma-separated list of operation information fields for
standard and detail log levels. String fields 14 through 17
display the following information:
Channel, <attribute>, <old value>, <new value>

Actuate iServer logs the following channel property change:

channel name, adding a user, deleting user, channel
privileges, expiration time

Numeric field 26 is 3.
Role property can be Name, AddUser, DeleteUser, Privilege
or ExpirationTime. When changing a channel’s privileges,
Actuate iServer logs the attribute changed as Privilege.and
lists the new privileges.

226 Administering Actuate iSer ver System

Type of event Description of log entry
Folder When creating a folder, Actuate iServer appends the
comma-separated list of operation information fields for
standard and detail log levels. String fields 14 and 15
display the following information:
Folder, <full pathname of the folder>

Numeric field 26 is 1.
When deleting a folder, Actuate iServer appends the
comma-separated list of operation information fields for
standard and detail log levels. String fields 14 and 15
display the following information:
Folder, <full pathname of the folder>

Numeric field 26 is 2.
When updating a folder, Actuate iServer appends the
comma-separated list of operation information fields for
standard and detail log levels. String fields 14 through
17display the following information:
Folder, <attribute>, <old value>, <new value>

Numeric field 26 is 3.
Actuate iServer logs the following changes to folder
properties:
folder name, modification of user list, modification of role
list, privilege change

Numeric field 26 is 3.
Attribute can be Name, AddUser, DeleteUser, or Privilege.
When changing a folder’s privileges, Actuate iServer logs
the attribute changed as Privilege and lists the new
privileges.

Chapter 6, Working with system-wide Actuate iServer parameters 227

Type of event Description of log entry
File When creating a file, Actuate iServer enters file name,
version and size information in fields 6 through 8, and
appends the comma-separated list of operation information
fields for standard and detail log level. String field 14
displays the following information:
File

Numeric field 26 is 1.
When deleting a file, Actuate iServer enters file name,
version and size information in fields 6 through 8, and
appends the comma-separated list of operation information
fields for standard and detail log levels. String field 14
display the following information:
File

Numeric field 26 is 2.
When updating a file, Actuate iServer enters file name,
version and size information in fields 6 through 8, and
appends the comma-separated list of operation information
fields for standard and detail log levels. String fields 14
through 18 display the following information:
File,–,<attribute>, <old value>, <new value>

Numeric field 26 is 3.
Actuate iServer logs the following changes to file
properties:
■ File name
■ File version name
■ File type
■ Change to role, channel, or user privileges
Attribute can be Name, AddUser, DeleteUser, or Privilege.
When changing a file’s privileges, Actuate iServer logs the
attribute changed as Privilege and lists the new privileges.

228 Administering Actuate iSer ver System

Type of event Description of log entry
Actuate For Actuate Integration Service (AIS) events, the value of
Integration Field 10 is 4, IntegrationEngine. Actuate iServer logs
service. Field 2 general information and the following operational
value is 6. information. String fields 11 through 14 display the
following information:
volume name, server name, cluster name, server request
id

Numeric fields 26 and 27 display the following information:

Request wait time, request generation time

Examining a sample usage log entry about report generation

The following example is a report generation usage log entry with the logging
parameter Display date time as string disabled. The log entry is listed on three
lines, appears as a single line in the log file:

3262961552,1,1,3262961549,3262961552,/office-info.roi,0,57115,jsmith,1,
"-",/office-info.rox,1,urup,urup,urup,rox,-,urup,office-info,-,-,-,-,-,
21,3262961549,1,500,0,0,0,0,0,0,0,0,0,0,0
The first line is the general information, fields 1 through 10, the second line is
the list of string field operational information, fields 11 through 25, and the
third line is the list of numeric field operational information, fields 26 through
40.
Fields 1, 4 and 5 are times, in seconds, since 00:00:00, Jan. 1, 1901, GMT.
The dash in quotes in field 11, at the beginning of the second line, indicate that
there are no parameters associated with this report generation.
The dashes at the end of the second line and the zeros at the end of the third
line indicate the fields are not used.

Examining a sample usage log entry about report printing

The following example shows a report printing usage log entry with the
logging parameter Display date time as string enabled:

05/27/2004 10:21:33,ReportPrinting,0,05/27/2004 10:21:19,05/27/2004 10:21:33,

/test.roi,1, 20785,Administrator, ReportEngine,
"1-3",caligari,marketing-printer,caligari,caligari,caligari,roi,-,-,-,-,-,-,-,-,
3,05/27/2004 10:21:16,1,500,0,0,0,0,0,0,0,0,0,0,0

Chapter 6, Working with system-wide Actuate iServer parameters 229

 The first two lines are the general usage entry. The the third and fourth lines
contain printing request information such as page numbers printed, number
of pages printed, and printer, and request priority.

Examining a sample usage log entry about report deletion

The following example is a report deletion usage log entry:
3263132450,5,1,3263107250,3263107250,Customers.roi,1,20785,bsmith,3,
caligari,caligari,caligari,File,Customers.roi,-,-,-,-,-,-,-,-,-,-
,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0
After the usage log information, the entry lists the report deletion information,
starting with the file name and version, Customers.roi,1. The entry lists the
following deletion-specific information as comma-separated values:
■ File name
■ File version
■ File size in bytes
■ User ID
■ Process ID
■ Encyclopedia volume, Actuate iServer, and Actuate iServer cluster names

Configuring and using error logging

Actuate iServer System supports error logging. Actuate iServer ships with an
error logging application. For the Actuate iServer error logging application,
the default name of the error log file is error_log.csv. The default location for
the error log file is $AC_SERVER_HOME/log the log directory for Actuate
iServer.
Before you set up error logging for an Actuate iServer System cluster, you
must ensure that each Actuate iServer node in a cluster has the same logging
applications installed. The following sections contain information about how
to configure and use the error logging functionality:
■ For information about how to enable error logging, see “Enabling error
logging for Actuate iServer,” later in this chapter.
■ For information about error log entries, see “Understanding the Actuate
iServer error log,” later in this chapter.
To log error information at a level similar to Release 7 Actuate iServer, set
Actuate iServer error logging to the warning level.
For information about using Actuate iServer diagnostic logging, see
“Configuring and using diagnostic logging” in Chapter 7, “Working with an
Actuate iServer System server.” For information about Actuate iServer System

230 Administering Actuate iSer ver System

 usage logging, see “Configuring and using system usage logging,” earlier in
this chapter.

Enabling error logging for Actuate iServer

An Actuate iServer administrator can configure Actuate iServer System error
log settings on System—Properties— Error Logging.

Chapter 6, Working with system-wide Actuate iServer parameters 231

 The default error logging configuration uses the error logging application that
ships with Actuate iServer. The following table describes the parameters that
appear on System—Properties—Error Logging.

Parameter Description
Enable error logging If selected, Actuate iServer logs information
about errors.
Logging level The type of events to log:
■ Fatal logs critical errors from which Actuate
iServer cannot recover. A fatal error typically
causes Actuate iServer to abort execution.
■ Information logs informational messages.
This type of error helps trace Actuate iServer
behavior.
■ Severe logs errors that can cause Actuate
iServer to abort execution if you do not rectify
the cause of the error. A severe error does not
typically cause Actuate iServer to abort
execution immediately.
■ Warning generates a warning in the event of
an error. A warning error is unlikely to impact
normal Actuate iServer operation.
Error logging extension Name of the DLL or shared library that Actuate
name iServer uses to generate the log files. The default
name is ErrorLoggingExt, the error logging
application that ships with Actuate iServer. The
default location for the application is
$AC_SERVER_HOME/bin, the bin directory for
Actuate iServer.
Type the name without the file-name extension.
For example, on a Windows system, if the DLL is
CustomError.dll, type:
CustomError

For more information about the error log file, see “Understanding the Actuate
iServer error log,” later in this chapter.

How to configure system error logging

1 Take Actuate iServer online, if necessary. For information about how to
take stand-alone Actuate iServer online, see “Working with offline Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”

232 Administering Actuate iSer ver System

 2 On System—Status, choose Properties.
System—Properties—General appears.
3 Choose Error Logging.
System—Properties—Error Logging appears.
4 Set up system error logging. Choose OK.

Understanding the Actuate iServer error log

The Actuate iServer error log stores information about Actuate iServer errors.
The following table lists the information log attributes the error logging
application that ships with Actuate iServer.

Attribute Description
ClusterName Name of the cluster node on which the source of
the error occurred.
ErrorDescription Brief description of the error.
ErrorID Error code of the error:
0001 - 1000 System errors, such as Out of
memory or Low thread count
1001 - 3000 Actuate server errors, such as
Corrupt encyclopedia or
Transient storage full:
1001 - 2000 Actuate
internal
datastore
2001 - 3000 Actuate
internal
3001 - 12000 User errors, such as
Permission denied or ROX not
found:
3001 - 4000 Encyclopedia
engine
4001 - 5000 Report engine
5001 - 6000 View engine
6001 - 7000 SOAP engine
7001 - 8000 Process
management
daemon

Chapter 6, Working with system-wide Actuate iServer parameters 233

 Attribute Description
8001 - 9000 Cluster
engine
10001 - 11000 Server
configuration
11001 - 12000 XML parsing
12001 - 13000 Viewing server errors
13000 - 14000 AcMail exceptions
100001 -100600 Actuate Information service
100601 - 100699 Actuate Caching service
100700 - 150000 Shared by Actuate
Information service and
Actuate Caching service
ErrorSeverity Severity level of the error. Actuate iServer uses
the severity level to determine errors added to
the log file. Specifying a severity logs that level of
error message and any higher error messages.
For example, the default level of warning logs
warning, severe and fatal error messages. The
error severity levels are:
1 Informational
2 Warning
3 Severe
4 Fatal
ServerName Name of the Actuate iServer node on which the
source of the error occurred.
ServiceName Name of the service or subsystem where the error
occurred: Factory service, Encyclopedia service,
View service, or Request service. The log also
indicates where the error occurred, either Cluster,
Server, Volume.
Timestamp Time when the error occurred. The value is the
time, in seconds, since 00:00:00, Jan. 1, 1901,
GMT.
UserName Name of the user who caused the error.

For the error logging application that ships with Actuate iServer, each error log
entry consists of a comma separated list of 12 fields. The following table

234 Administering Actuate iSer ver System

 describes the data in the first 9 fields. The data in fields 10 through 12 depend
on the error logged.

Field ID Description
1 Error entry time stamp.
2 Error severity, an integer between 1 and 4.
3 Error ID code
4 Service name
5 Encyclopedia volume User
6 Error message
7 Encyclopedia volume name
8 Actuate iServer Cluster name
9 Actuate iServer node name

Depending on the error Fields 10 through 12 can contain information such as a

file name and ID number. For example, the Actuate error logging application,
creates an log entry similar to the following when an Encyclopedia volume
user attempts to view a report without sufficient privileges.
3263048938,4,12009,GetPageCount,-,Permission is not granted to file:
,test1,urup,caligari, Object Name: /Customers.roi;1 , Object ID: 58,-,-
The following table describes the types of information that Actuate iServer
appends to an error log entry for each of the types of errors it logs.

Type of error Description of log entry

Cluster master failover Actuate iServer appends information to a error
entry for either an administrative cluster master
failover or a crash failover. Fields 10 and 11
contain the following data:
■ Original cluster master
■ New cluster master
Encyclopedia volume Actuate iServer appends information to a error
user activity entry for Encyclopedia volume user errors.
Depending on the error, fields 10 through 12 can
contain error parameters such as object name and
ID number.

Chapter 6, Working with system-wide Actuate iServer parameters 235

 Type of error Description of log entry
Volume failover Actuate iServer appends information to a error
entry for either an administrative volume
failover or volume failure. Fields 10 and 11
contain the following data:
■ Primary server
■ Backup server used
Volume online or offline Actuate iServer appends information to a error
entry for a failure putting an Encyclopedia online
or taking it offline. Fields 10 and 11 contain the
following data:
■ Volume name
■ Operation type either online or offline
Actuate iServer node Actuate iServer appends the following
start or stop information to a error entry for a failure when
starting or stopping an Actuate iServer node:
Field 10 contains the following data:
■ Server name
Service enable or disable Actuate iServer appends information to a error
entry for a failure when enabling or disabling an
Actuate iServer service. Fields 10 and 11 contain
the following data:
■ Server name
■ List of services
Archive service error Actuate iServer appends information to a error
entry for a failure when enabling or disabling an
Actuate iServer service. Fields 10 through 12
contain error parameters.
Encyclopedia volume Actuate iServer appends information to a error
job purging entry for a failure when enabling or disabling an
Field 4 is Job Purge Actuate iServer service. Fields 10 through 12
contain error parameters.
Encyclopedia volume Actuate iServer appends information to a error
health monitoring entry for a failure when enabling or disabling an
Field 4 is Encyclopedia Actuate iServer service. Fields 10 through 12
Health Monitor contain error parameters.

For information about setting up error logging and for descriptions of the
error logging levels, see “Enabling error logging for Actuate iServer,” earlier in
this chapter.

236 Administering Actuate iSer ver System

 The following are example error log entries created by the Actuate iServer
error logging application:
■ Cannot run a report:
3263048773,4,3033,ExecuteReport,-,You do not have permission to perform
this operation.,test1,urup,caligari,-,-,-
■ Cannot view an Actuate Basic report in DHTML format:
3263048938,4,12009,GetPageCount,-,Permission is not granted to file:
,test1,urup,caligari, Object Name: /Customers.roi;1 , Object ID: 58,-,-
■ Creating a folder:
3263049292,4,3033,Administrate,-,You do not have permission to perform
this operation.,test1,urup,caligari,-,-,-
■ Failure to start a server:
3263046297,4,8049,StartServer,Administrator,Cannot start the server. The
member server failed to start.,urup,urup,urup,caligari,-,-
■ Cannot test a Encyclopedia volume:
3263046691,4,3188,TestConfigurationAttributes,-,Cannot fully check
partition settings: Server is offline.,urup,urup,urup,-,-,-
■ Cannot start an Encyclopedia volume
3263047159,3,10017,AddConfigurationObject,-,The specified Object already
exists.,urup,urup,urup,Volume/,-,-

Managing Actuate iServer e-mail notification

As an administrator, you can configure Actuate iServer System to use multiple
SMTP e-mail servers for Actuate e-mail notification. For information about
Actuate iServer e-mail notification configuration, see “Setting up e-mail
notification” in Chapter 2, “Setting up Actuate iServer System hardware.”
In an Actuate iServer cluster, Actuate iServer distributes e-mail notification
requests among the Actuate iServer nodes that have the View service enabled.
The nodes that have the View service enabled send the e-mail notices. If the
Actuate iServer cluster does not have an Actuate iServer node that has the
View service enabled, Actuate iServer cannot send e-mail notices. If you use
Actuate iServer in a stand-alone configuration, Actuate iServer must be able to
use any of the configured SMTP servers.
Using SMTP server load-balancing weights, you can configure Actuate iServer
System to send e-mail notices through the STMP servers bases on the SMTP
server’s processing resources. For information about SMTP server load
balancing, see “Balancing the e-mail notice load,” later in this chapter.

Chapter 6, Working with system-wide Actuate iServer parameters 237

 Setting up Actuate iServer System to use an
SMTP server for e-mail notification
When Actuate iServer System uses SMTP e-mail servers for e-mail
notification, an Actuate iServer System administrator can view and configure
Actuate iServer e-mail notification parameters on System—Properties—
Notification. The following illustration shows System—Properties—
Notification with two SMTP e-mail servers.

On System—Properties—Notification, an Actuate iServer System

administrator can access the following functionality:
■ Specify a Maximum message size for messages that Actuate iServer sends.
■ Select Enable SMTP to use SMTP e-mail servers for Actuate iServer e-mail
notification. Deselect this option to disable the use of SMTP e-mail servers
for e-mail notification from Actuate iServer System.
■ Choose Add SMTP Server to add an SMTP e-mail server to the list that
Actuate iServer uses for e-mail notification. For more information, see
“Adding an SMTP e-mail server for Actuate iServer System,” later in this
chapter.
■ In the list SMTP e-mail servers, choose Delete to delete an SMTP e-mail
server that Actuate iServer uses for notification.
■ In the list SMTP e-mail servers, choose Edit to edit the parameters for an
SMTP e-mail server that Actuate iServer uses for notification. For
information about the SMTP e-mail server parameters, see “Adding an
SMTP e-mail server for Actuate iServer System,” later in this chapter.

238 Administering Actuate iSer ver System

 The following table describes the parameters that appear on System—
Properties—Notification.

Parameter Description
Enable SMTP If selected, Actuate iServer System uses SMTP e-
mail servers for e-mail notification.
Maximum mail message Maximum size, in kilobytes (KB), of an e-mail
size message that Actuate iServer sends. When the
combined size of the message text and the
attachment exceeds the maximum size, Actuate
iServer cannot send the e-mail message and
writes errors to the diagnostic and error log files.
The default value for this parameter is 5120KB
(5MB). The minimum value is 100KB. The
maximum value is 1048576 (1GB). Changes to
this parameter take effect when Actuate iServer
System restarts.
In the acserverconfig.xml file, the maximum mail
message size is a system attribute. The following
example specifies a maximum message size of
8000KB:
<System
MaxMailMessageSize="8000"
>

For more information about acserverconfig.xml,

see “About the Actuate iServer System
configuration file” in Chapter 6, “Working with
system-wide Actuate iServer parameters.”
Name List of display names for the SMTP e-mail servers
that Actuate iServer uses for e-mail notification.

How to modify Actuate iServer System’s SMTP server setup

1 In the System Administration console, on System—Status, choose
Properties.
System—Properties appears.
2 Choose Notification.
System—Properties—Notification appears.
3 Modify the SMTP server setup as necessary. Choose OK.

Chapter 6, Working with system-wide Actuate iServer parameters 239

 Adding an SMTP e-mail server for Actuate iServer
System
On SMTP Servers—New SMTP Server, an administrator can add an SMTP e-
mail server to the list of e-mail servers that Actuate iServer System uses.

The following table describes the SMTP server parameters that appear on
SMTP Servers—New SMTP Server.

Parameter Description
SMTP Server name Name that Actuate iServer displays in the list of
SMTP servers. A required parameter.
Hostname or IP Address Host name or IP address for the SMTP server. A
required parameter.
Listen port Port number on which to contact the SMTP
server. The minimum value is 1. The maximum
value is 65535. The default value is 25, a typical
listen port for SMTP e-mail servers.
Sender e-mail address E-mail return address for the SMTP server. The
format is name@domain. The SMTP server sends
e-mail to this address it cannot deliver an e-mail
message. A required parameter.
Sender name Name that appears in the From field of an e-mail
message. An optional parameter.

240 Administering Actuate iSer ver System

 Parameter Description
SMTP greeting The greeting attribute for the SMTP greeting
command. The default value is blank, Actuate
iServer uses HELO. Otherwise, Actuate iServer
uses HELO <value>.
Mailing weight Relative weight to use to determine message
routing. The default value is 100. The minimum
value is 0. The maximum value is 1,000,000. If the
value is zero, Actuate iServer uses the SMTP
server only after receiving errors from all other
SMTP servers.

How to add an SMTP server to Actuate iServer System

1 Take Actuate iServer online, if necessary. For information about how to
take stand-alone Actuate iServer online, see “Working with offline Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”
2 On System—Status, choose Properties.
System—Properties—General appears.
3 Choose Notification.
System—Properties—Notification appears.
4 Choose Add SMTP Server.
SMTP Servers—New SMTP Server appears.
5 To set up the SMTP server, you must provide the following information:
■ SMTP Server name
■ Hostname or IP address
■ Sender e-mail address
If you do not type values for the other parameters, Actuate iServer uses
default values.
Choose OK.

Limiting the number of e-mail recipients

The Maximum number of e-mail recipients parameter specifies the maximum
number of e-mail address recipients to which Actuate iServer can address a
single e-mail message. If the number of recipients exceeds the maximum,
Actuate iServer sends multiple copies of the message. For example, an Actuate
iServer notification request sends an e-mail notice to 500 e-mail addresses, and
the Actuate iServer maximum number of e-mail recipients is 300. Actuate
iServer sends two copies of the e-mail message. The first message contains 300

Chapter 6, Working with system-wide Actuate iServer parameters 241

 e-mail addresses. The second message contains the remaining 200 e-mail
addresses.
The maximum number of e-mail recipients for an Actuate iServer e-mail
message cannot exceed the maximum number of e-mail recipients limit for the
e-mail server. If the e-mail server receives a request that contains more e-mail
recipients than it permits, the e-mail server does not send the e-mail message.
The e-mail server sends a failure notice to Actuate iServer. Actuate iServer
does not attempt to resend the message.
In the Actuate iServer acserverconfig.xml file, the maximum number of e-mail
recipients is a system attribute. The default value is 10,000 e-mail addresses.
The minimum value is 100. The maximum value is 100,000. The following
example sets the maximum number of e-mail recipients to 200 e-mail names:
<System
MaxMailRecipients="200"
>
For more information about acserverconfig.xml, see “About the Actuate
iServer System configuration file” in Chapter 6, “Working with system-wide
Actuate iServer parameters.”

Balancing the e-mail notice load

When sending e-mail notices, Actuate iServer uses the Encyclopedia service’s
load-balancing capability to distribute the e-mail notice requests among
Actuate iServer nodes that have the View service enabled. When using SMTP
e-mail servers, Actuate iServer also uses a load-balancing algorithm to
distribute e-mail requests to the SMTP servers.

About SMTP load balancing

The Mailing weight parameter value is the relative weight that determines
how Actuate iServer routes e-mail requests to an SMTP server, according to a
round-robin load-balancing algorithm. For information about setting the
Mailing weight parameter, see “Adding an SMTP e-mail server for Actuate
iServer System,” earlier in this chapter.
Actuate iServer System distributes e-mail notice requests among SMTP
servers. Actuate iServer uses a round-robin load-balancing algorithm based on
load-balancing weight. For example, Actuate iServer System has the relative
load-balancing ratio of 3:2:2 among three SMTP servers. For every 30 messages
Actuate iServer System distributes, Actuate iServer sends 13 to the first SMTP
server, 9 to the next SMTP server, and 8 to the last SMTP server.
When an Actuate iServer node receives an error when it sends an e-mail notice
to one SMTP server, and it succeeds when it sends the notice to another SMTP
server, the notice counts as part of the load-balancing quota for the SMTP

242 Administering Actuate iSer ver System

 server that failed. The notice also counts towards the quota of the SMTP server
that succeeds, unless its quota for that round is already exhausted.
For information about retryable failures, see “About errors when sending e-
mail using SMTP,” later in this chapter.

About MAPI and sendmail load balancing

When Actuate iServer System uses Microsoft Exchange MAPI on a Windows
system and UNIX sendmail on a UNIX system, Actuate iServer System
distributes e-mail notice requests among the Actuate iServer nodes that have
the View service enabled. An Actuate iServer node uses its Actuate iServer e-
mail account. If the Actuate iServer node receives an error, it writes a message
to the diagnostic log.

About errors when sending e-mail using SMTP

When configured to use SMTP e-mail servers, Actuate iServer categorizes
errors that occur when sending e-mail messages as either retryable or non-
retryable.
Actuate iServer System supports resending e-mail messages when a retryable
e-mail error occurs. If an Actuate iServer node receives an error when sending
an e-mail message to an SMTP server, the Actuate iServer node sends the e-
mail message using the next configured SMTP server. For information about
retryable errors, see “About errors that cause Actuate iServer to resend e-mail
messages,” later in this chapter.
If the Actuate iServer node that sends the e-mail message receives non-
retryable errors when sending the e-mail message to all SMTP servers, the
Actuate iServer node writes a message to the error log. For information about
non-retryable errors, see “About errors that do not cause Actuate iServer to
resend e-mail messages,” later in this chapter.
If the Actuate iServer node that sends the e-mail message receives an error
from all the SMTP servers, and at least one of the errors is a retryable error, the
Actuate iServer node waits for the retry interval of one second and tries to
send the message to the SMTP server that returns a retryable error. If the SMTP
server returns an error again, the Actuate iServer node writes a message to the
error log.
When you use the default configuration for Actuate iServer e-mail notification,
which uses Microsoft Exchange MAPI on a Windows system and UNIX
sendmail on a UNIX system, Actuate iServer makes one attempt to send an e-
mail message. If the Actuate iServer node receives an error, it writes a message
to the diagnostic log.

Chapter 6, Working with system-wide Actuate iServer parameters 243

 About errors that cause Actuate iServer to resend e-mail
messages
If Actuate iServer receives one of the following types of errors, it attempts to
resend the e-mail message:
■ Cannot connect to SMTP server
■ Network connection fails
■ Wait for response times out while sending message
For each error Actuate iServer receives, it writes a message to the diagnostic
log.

About errors that do not cause Actuate iServer to resend

e-mail messages
If Actuate iServer receives one of the following types of errors, it does not
attempt to resend the e-mail message:
■ Unrecognized recipient
■ Message too large
■ Message contains too many recipients
You can configure the maximum number of recipients and the maximum
message size. For information about these parameters, see “Setting up Actuate
iServer System to use an SMTP server for e-mail notification” and “Limiting
the number of e-mail recipients,” earlier in this chapter.
For each error Actuate iServer receives, it writes a message to the diagnostic
log.

About e-mail notification error logging

Actuate iServer System logs e-mail notification error messages:
■ If an error occurs while an Encyclopedia volume is locating an Actuate
iServer node to which to send an e-mail notice request, the Actuate iServer
node that runs the Encyclopedia service writes error messages to its
diagnostic and error logs.
■ If an Actuate iServer node receives a request to send an e-mail notice, and
the node encounters an error, the node writes an error message to its
diagnostic and error logs. For example, if the node encounters an error
when it converts an ROI or when it contacts an SMTP server, the node
writes a message to its diagnostic and error logs.
Actuate iServer localizes all errors that it writes to the error log to the default
locale for the Actuate iServer machine.

244 Administering Actuate iSer ver System

Configuring default regional settings
As an Actuate iServer System administrator, you can configure the default
regional settings for Actuate iServer or an Actuate iServer System cluster on
System—Properties—Regional Settings.

The following table describes the parameters that appear on System—

Properties—Regional Settings.

Parameter Description
Locale Locale that Actuate iServer System uses.
Encoding Default code page that Actuate iServer System
uses.

For more information about locales and encoding, see Chapter 2, “Formatting
Actuate Basic report data for multiple locales,” and Chapter 3,
“Understanding Actuate Basic report encoding,” in Working with Multiple
Locales.

How to configure default regional settings

1 From the side menu of the System Administration console, choose System.
System—Status appears. For more information about System—Status, see
“Understanding Actuate iServer status” in Chapter 5, “Actuate iServer
System administration overview.”
2 Choose Properties

Chapter 6, Working with system-wide Actuate iServer parameters 245

 System—Properties—General appears.
3 Choose Regional Settings.
System—Properties—Regional Settings appears.
4 Specify values for the parameters that appear on System—Properties—
Regional Settings.
Choose OK.

Working with Actuate iServer System license

information
System—Properties—License displays a list of licensed options. As an Actuate
iServer System administrator, you can use this page to view which Actuate
iServer System options you license and enable. You can also specify a new
Actuate iServer System license file to enable or disable options, as necessary.

246 Administering Actuate iSer ver System

 The following table describes the parameters that appear on System—
Properties—License.

Parameter Description
Expiration date Date on which the current license file expires.
Options List of options the license file enables and the
maximum number of CPUs that the license file
permits.
Update license Choose to specify the location of a new Actuate
iServer System license file to enable or disable
Actuate iServer System options.

For information about Actuate iServer options, see “Working with Actuate
iServer System licensing” in Chapter 1, “Actuate iServer architecture
overview,” and Chapter 21, “Understanding Actuate iServer options.”

How to view and update an Actuate iServer System license

An Actuate iServer System administrator can update the license file by
replacing it with a new, valid license file in the Actuate iServer System
configuration directory. This change takes effect when Actuate iServer restarts
or the cluster master fails over to another Actuate iServer node. To cause
license changes to take effect immediately, update the license using the System
Administration console of Actuate Management Console, as described in the
following procedure.
1 From the side menu of the System Administration console, choose System.
System—Status appears. For more information about System—Status, see
“Understanding Actuate iServer status” in Chapter 5, “Actuate iServer
System administration overview.”
2 Choose Properties
System—Properties—General appears.
3 Choose License.
System—Properties—License appears, displaying Actuate iServer System
license information.
4 To supply a new Actuate iServer System license file:
1 Choose Update License.
The following page appears.

Chapter 6, Working with system-wide Actuate iServer parameters 247

 2 Specify a new Actuate iServer System license file. Choose OK.

Specifying advanced Actuate iServer System

parameter values
On System—Properties—Advanced, an Actuate iServer System
administration can specify values for advanced Actuate iServer System
parameters. For more information about specifying advanced parameter
values, see “Changing advanced Actuate iServer System settings” in Chapter
5, “Actuate iServer System administration overview.”

System—Properties—Advanced lists the following categories:

■ Usage and error logging. For more information about the usage and error
logging properties, see “Setting advanced usage and error logging property
values,” later in this chapter.
■ Printing. For more information about the printing properties, see “Setting
advanced printing property values,” later in this chapter.
■ Cluster Operation. For more information about the cluster operation
properties, see “Setting advanced cluster operation property values,” later
in this chapter.

248 Administering Actuate iSer ver System

 ■ Information Display. For more information about the information display
properties, see “Setting advanced information display property values,”
later in this chapter.
■ Notification. For more information about the notification properties, see
“Setting advanced notification property values,” later in this chapter.

Setting advanced usage and error logging

property values
On System—Properties—Usage and Error Logging—Usage And Error Log
File Settings, an Actuate iServer System administrator can specify settings for
the files that store the usage and error logs.

Chapter 6, Working with system-wide Actuate iServer parameters 249

 The following table describes the parameters that appear on System—
Properties—Usage and Error Logging—Usage And Error Log File Settings.

Parameter Description
Usage and error log Release level of the usage and error logging
version extension application to use. The default value is
8, the current release of the usage and error
logging application. Possible values are 7 and 8.
A value of 7 specifies the previous release of the
usage and error logging application. Use this
setting for backward compatibility, if necessary.
Takes effect at system restart.
Usage log file name Base name for the usage log file. Actuate iServer
sends this value to the usage logging application.
The default value is usage_log.
The usage logging application that ships with
Actuate iServer uses this value to create a file
name with the .csv file-name extension. A custom
usage logging application can use a different
value. The Actuate usage logging application
places the log file in the log subdirectory of the
Actuate iServer home directory.
Takes effect at system restart.
Usage log file size Maximum size, in kilobytes (KB), of the usage log
files. If Actuate iServer uses multiple log files,
this value is the maximum size of each log file.
The default value is 2048KB.
The usage logging application that ships with
Actuate iServer uses this value. A custom usage
logging application can use a different value.
Takes effect at system restart.
Number of usage log Maximum number of usage log files. The default
files value is 2.
The usage logging application that ships with
Actuate iServer uses this value to create log file
names, such as usage_log.csv and
usage_log_1.csv. A custom usage logging
application can use a different value.
Takes effect at system restart.

250 Administering Actuate iSer ver System

 Parameter Description
Display date time as Format of the date and time field for usage and
string error log entries. The format is either a string in
the format mm/dd/yyyy or an unsigned long
that specifies the number of seconds since
January 1, 1970. The default value is false. With
the default value, Actuate iServer System uses
the unsigned long format.
The usage and error logging applications that
ship with Actuate iServer use this value. A
custom usage or error logging application can
use a different value.
Takes effect at system restart.
Error log file name Base name for the error log file. Actuate iServer
sends this value to the error logging application.
The default value is error_log.
The error logging application that ships with
Actuate iServer uses this value to create a file
name with the .csv file-name extension. A custom
error logging application can use a different
value. The Actuate error logging application
places the log file in the log subdirectory of the
Actuate iServer home directory.
Takes effect at system restart.
Error log file size Maximum size, in kilobytes (KB) of an error log
file. If Actuate iServer uses multiple log files, this
is the maximum size of each log file. The default
value is 2048KB.
The error logging application that ships with
Actuate iServer uses this value. A custom error
logging application can use a different value.
Takes effect at system restart.
Number of error log files Maximum number of error log files. The default
value is 2.
The error logging application that ships with
Actuate iServer uses this value. A custom error
logging application can use a different value.
Takes effect at system restart.

For more information about Actuate iServer System usage and error logging,
see “Working with Actuate iServer System usage and error logging,” earlier in
this chapter.

Chapter 6, Working with system-wide Actuate iServer parameters 251

 Setting advanced printing property values
The following table describes the parameters that appear on the advanced
printing property dialog that you access from System—Properties—
Advanced.

Parameter Description
Maximum number of Maximum number of printers that Actuate
printers to automatically iServer in a stand-alone configuration adds to the
configure server’s printer list during startup. During
restart, Actuate iServer typically deletes Actuate
iServer printer information and adds the names
the operating system's list of printers to the
Actuate iServer configuration. The value can be
from 0 to 50. 0 disables automatic printer
configuration. With a value of 0, Actuate iServer
does not update the list of printers during server
restart. For example, set the value to 0 if Actuate
iServer uses printers that are not detected by the
operating system. The default value is 15.
If you configure a large number of printers for
Actuate iServer, performance drops significantly
for operations such as listing the printers in the
System Administration console of Actuate
Management Console.
Takes effect at system restart.

252 Administering Actuate iSer ver System

 Setting advanced cluster operation property
values
The following table describes the parameters that appear on System—
Properties—Cluster Operation—Administrative, which you access from
System—Properties—Advanced.

Parameter Description
Account to receive E-mail account that receives Actuate iServer
administrative e-mail administrative e-mail. For example, Actuate
iServer sends an e-mail notice when Actuate
iServer license problems occur. Specify an e-mail
address that Actuate iServer e-mail servers
recognize. The default value is blank. With the
default value, Actuate iServer does not send an e-
mail message.
Takes effect at system restart.

On System—Properties—Cluster Operation—Failover, an Actuate iServer

System administrator can specify failover retry parameters.

Chapter 6, Working with system-wide Actuate iServer parameters 253

 The following table describes the parameters that appear on System—
Properties—Cluster Operation—Failover.

Parameter Description
Failover retry period Failover retry period, in seconds, for cluster
when IO failure occurs master configuration file lock failure and volume
I/O file failure. The default value is 300 seconds.
Takes effect immediately.
Delay between each The time delay between each attempt of master
failover retry when IO configuration file lock failover and volume
failure occurs failover after a file I/O failure. The default value
is 30 seconds.
Takes effect immediately.

Setting advanced information display property

values
The following table describes the parameters that appear on Information
Display—Fonts, which you access from System—Properties—Advanced.

Parameter Description
Use externalized font file Parameter that indicates how Actuate iServer
System uses customized_fonts.rox and
master_fonts.rox when it searches for fonts when
a user runs or views an Actuate Basic report. The
available values are no, primary, or secondary.
The default value is Primary.
Takes effect at system restart.

Setting advanced notification property values

On System—Properties—Notification, an Actuate iServer System
administrator can specify settings for parameters that determine how Actuate
iServer System notifies users and administrators of events.

254 Administering Actuate iSer ver System

 The following table describes the parameters that appear on System—
Properties—Notification, which you access from System—Properties—
Advanced.

Parameter Description
Maximum number of Maximum number of e-mail address recipients to
recipients per e-mail which Actuate iServer can send a single e-mail.
message The value can be any number between 100 and
100,000. The default value is 10000.
If the number of e-mail recipients exceeds the
value of this parameter, Actuate iServer divides
the list into smaller lists and sends the same e-
mail message to each of the smaller lists.
Takes effect at system restart.
Use dummy line in place Parameter used when Actuate iServer uses UNIX
of empty To: line sendmail or SMTP to send e-mail notification.
This parameter indicates whether to use the
value of the Dummy To: line parameter in an
e-mail notice that Actuate iServer sends if both
the To: and Cc: values are empty. The available
values are true and false. The default value is
true. With the default value, Actuate iServer uses
the Dummy To: line value.
Takes effect at system restart.
Dummy To: line Text to use in the To: line of an e-mail notice from
Actuate iServer if the value of the Use dummy
line in place of empty To: line parameter is true
and both the To: and Cc: values are empty. The
default value is (names withheld).
Takes effect at system restart.

Chapter 6, Working with system-wide Actuate iServer parameters 255

256 Administering Actuate iSer ver System
 Chapter

Working with an
Chapter 7
7
Actuate iServer System
server
This chapter contains the following topics:
■ About server parameters for Actuate iServer System
■ Setting general Actuate iServer parameter values for an Actuate iServer
machine
■ Setting Message Distribution service parameter values
■ Setting View service parameter values
■ Specifying Factory service parameter values
■ Specifying Caching service parameter values
■ Specifying Integration service parameter values
■ Setting server parameter values for an Actuate iServer System resource
group
■ Specifying the buffer pool size for an Encyclopedia volume
■ Assigning backup responsibility for an Encyclopedia volume to an Actuate
iServer node
■ Designating partition space for Actuate iServer
■ Specifying parameter values for an Actuate iServer System printer
■ Working with advanced Actuate iServer parameter values
■ Changing the cluster master

Chapter 7, Working with an Actuate iServer System ser ver 257

Working with the list of servers
When you choose Servers from the side menu of the System Administration
console, Servers appears, as shown in the following illustration. In an Actuate
iServer System cluster, Servers lists the Actuate iServer nodes in the cluster. In
a stand-alone configuration, Servers lists the name of the stand-alone Actuate
iServer machine.

On Servers, an Actuate iServer System administrator can access the following

functionality:
■ View the current status and configuration of Actuate iServer machines. For
more information about Actuate iServer status, see “Understanding
Actuate iServer status” in Chapter 5, “Actuate iServer System
administration overview.” A flag appears in the status column when a
server requires a restart due to updates to the server configuration.
■ Choose Add Server to add a node to an Actuate iServer cluster. For
information about creating a cluster, see “About creating an Actuate
iServer System cluster” in Chapter 5, “Actuate iServer System
administration overview.”
■ Hover the pointer over the arrow icon for an Actuate iServer machine and
choose one of the following options:
■ Choose Properties to change the server parameter values and
configuration of an Actuate iServer System machine. For information
about server parameters for Actuate iServer System, see “About server
parameters for Actuate iServer System,” later in this chapter.
■ Choose Master failover to perform an administrative failover. For
information about performing an administrative failover, see “Failing
over an Encyclopedia volume” in Chapter 9, “Working with an Actuate
iServer System volume.”
■ Choose Check CPU limit to check the maximum number of CPUs on which
you can run Actuate iServer. Your Actuate iServer System license imposes

258 Administering Actuate iSer ver System

 this limit. For more information about the Actuate iServer System CPU
limit, see “Understanding Actuate iServer CPU binding” in Chapter 2,
“Setting up Actuate iServer System hardware.”

About server parameters for Actuate iServer System

The server parameters for Actuate iServer System machines appear on
subpages of Servers—Properties. For example, general server parameters and
their values appear on Servers—Properties—General. For information about
server parameters, see the sections listed in the following table.

Servers—Properties
subpage Relevant section
General “Setting general Actuate iServer parameter values
for an Actuate iServer machine”
Message Distribution “Setting Message Distribution service parameter
Service values”
View Service “Setting View service parameter values”
Factory Service “Specifying Factory service parameter values”
Resource Groups “Setting server parameter values for an Actuate
iServer System resource group”
Volumes “Specifying the buffer pool size for an
Encyclopedia volume”
Failover Volumes “Assigning backup responsibility for an
Encyclopedia volume to an Actuate iServer node”
Partitions “Designating partition space for Actuate iServer”
Printers “Specifying parameter values for an Actuate
iServer System printer”
Advanced “Working with advanced Actuate iServer
parameter values”

Even if a service is not enabled, you can change parameter values for the
service when you modify the parameter values for a server. Actuate iServer
System updates the parameter values when you enable the service on that
server. For information about enabling an Actuate iServer Service, see “Setting
general Actuate iServer parameter values for an Actuate iServer machine,”
later in this chapter.

Chapter 7, Working with an Actuate iServer System ser ver 259

Setting general Actuate iServer parameter values
for an Actuate iServer machine
When you choose an Actuate iServer machine name from the list of servers on
Servers in the System Administration console, Servers—Properties—General
appears. On Servers—Properties—General, an Actuate iServer System
administrator can view and set general parameter values for an Actuate
iServer machine.

260 Administering Actuate iSer ver System

The following table describes the Actuate iServer machine parameters that
appear on Servers—Properties—General.

Parameter Description
Description Description of the Actuate iServer machine. This
parameter is optional. This parameter value
appears in the list of servers on Servers.
Machine name Name of the Actuate iServer machine. This
parameter value appears in the list of servers on
Servers.
Operating system Machine’s operating system and version. This
parameter value appears in the list of servers on
Servers.
Application container The Actuate iServer application container port.
process listen port Actuate iServer uses application container to host
web services applications. A port number is a
valid, unused port, an integer between 1 and
65535.
The application container process hosts
applications such as Actuate Management
Console and the Actuate Formula One
application engine that generates Formula One
reports.
You can configure Actuate iServer to use a
different application server to host web services
used by Actuate iServer.
Takes effect at server restart.
Daemon listen IP IP address that Actuate Process Manager uses.
address
Daemon listen port Daemon listen port for Actuate Process Manager.
Server IP address IP address for Actuate iServer services.
Server port Internal server port for communication with
other Actuate iServer nodes in a cluster.
Server port base Server port base for internal communication on
an Actuate iServer machine.
Server port count Maximum number of Actuate iServer ports
available for internal Actuate iServer
communication, starting from the server port
base.
RPC listen base Report Server API (RSAPI) port base.
RPC listen count Number of Actuate iServer RSAPI ports.

Chapter 7, Working with an Actuate iServer System ser ver 261

 Parameter Description
Factory service If selected, the Factory service is enabled for the
Actuate iServer machine.
Message Distribution If selected, the Message Distribution service is
service enabled for the Actuate iServer cluster node.
View service If selected, the View service is enabled for the
Actuate iServer machine.
Caching service If selected, the Caching service is enabled for the
Actuate iServer machine.
Integration service If selected, the Integration service is enabled for
the Actuate iServer machine.

For more information about Actuate iServer communication, see “About

Actuate iServer ports” in Chapter 2, “Setting up Actuate iServer System
hardware.”
To generate temporary reports, enable both the Factory and View services for
Actuate iServer. For more information about enabling Actuate iServer services,
see “About the Actuate iServer architecture” in Chapter 1, “Actuate iServer
architecture overview.”
Downloading a file from an Encyclopedia volume using Actuate Active Portal,
Actuate Management Console, or an Actuate IDAPI application requires the
View service. In an Actuate iServer cluster, the View service must be enabled
on at least one running Actuate iServer node.
If you enable diagnostic logging for any of the services, a message on
Servers—Properties—General indicates that diagnostic logging is enabled for
that service. For more information about diagnostic logging, see “Configuring
and using diagnostic logging,” later in this chapter.

How to set general Actuate iServer parameter values

1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for the server for which you want to
set parameter values and choose Properties.
Servers—Properties—General appears.
3 Specify values for the parameters that appear on System—Properties—
General.
Choose OK.

262 Administering Actuate iSer ver System

Setting Message Distribution service parameter
values
On Servers—Properties—Message Distribution Service, you can view and set
the Message Distribution service parameter values. For a general description
of the Message Distribution service, see “About the Actuate iServer
architecture” in Chapter 1, “Actuate iServer architecture overview.”

The following table describes the parameters that appear on Servers—

Properties—Message Distribution Service.

Parameter Description
Max concurrent SOAP Maximum number of concurrent Message
requests Distribution service requests for Actuate iServer
System. The default value is 1000.
Message distribution IP IP address for the Message Distribution service
Address on the Actuate iServer machine for which you set
this parameter.
Message distribution Port for the Message Distribution service on the
port Actuate iServer machine for which you set this
parameter.

Chapter 7, Working with an Actuate iServer System ser ver 263

 How to set Message Distribution service parameter values
1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for the server for which you want to
set parameter values and choose Properties.
Servers—Properties—General appears.
3 Choose Message Distribution Service.
Servers—Properties—Message Distribution Service appears.
4 Specify values for the parameters that appear on System—Properties—
Message Distribution Service.
Choose OK.

Setting View service parameter values

On Servers—Properties—View Service, you can specify the View Service
parameter values. For general information about the View service, see “About
the Actuate iServer architecture” in Chapter 1, “Actuate iServer architecture
overview.”

264 Administering Actuate iSer ver System

The following table describes the parameters that appear on Servers—
Properties—View Service.

Parameter Description
Max View processes Maximum number of view server processes that
can run concurrently.
Min View processes Minimum number of view server processes
running at one time.
Max concurrent requests Maximum number of concurrent view server
requests.

Chapter 7, Working with an Actuate iServer System ser ver 265

 Parameter Description
Viewing weight for this Relative weight assigned to the Actuate iServer
server for viewing reports. Actuate iServer System uses
the Actuate iServer node’s weight numbers when
it distributes viewing jobs to nodes in an Actuate
iServer System cluster.
Max Excel pages Maximum number of Excel pages to generate for
each job.
Quality of images in Relative quality of images for PDFs that contain
PDF images. A higher value indicates a higher quality
graphic, but the higher quality requires more
system resources and generates a larger file.
Use JPEG images in PDF If selected, enable to use JPEG images in PDF
documents documents. Disable to use bitmap (BMP) images.
Max cache size Maximum total size of files in the cache directory
for all the cached files. The default value is 128
(128MB).
Max cache timeout Maximum time, in seconds, before the cache
times out and Actuate iServer clears the cache.
Extended viewing cache When to use extended viewing cache when
level viewing reports. Extended viewing cache
produces better viewing performance when
viewing large reports but requires more system
resources. Values are:
■ NoCache turns off caching.
■ CacheAll caches previous viewing operations
for all reports.
■ PLSOnly caches previous viewing operations
when viewing reports with page-level
security enabled.
The default value is NoCache.
Maximum extended Maximum extended viewing cache size for each
viewing cache size per View process. Value is in number of entries.
process
Extended viewing cache Timeout value, in seconds, for the data in the
timeout extended viewing cache when the value for
Enable extended view cache is CacheAll or
PLSOnly.

266 Administering Actuate iSer ver System

 How to set View service parameter values
1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for the server for which you want to
set parameter values and choose Properties.
Servers—Properties—View Service appears.
3 Choose View Service.
Servers—Properties—View Service appears.
4 Specify values for the parameters that appear on System—Properties—
View Service.
Choose OK.

Specifying Factory service parameter values

On Servers—Properties—Factory Service, you can specify the Factory service
parameter values. For a general description of the Factory service, see “About
the Actuate iServer architecture” in Chapter 1, “Actuate iServer architecture
overview.”

Chapter 7, Working with an Actuate iServer System ser ver 267

 On Servers—Properties—Factory Service:
■ Transient report cache settings apply only to temporary reports. Using the
parameters on Servers—Properties—Factory Service, an Actuate iServer
System administrator can control temporary report settings for Actuate
iServer. To generate temporary reports, you must enable both the Factory
and View services for Actuate iServer. For information about Actuate
iServer services, see “About the Actuate iServer architecture” in Chapter 1,
“Actuate iServer architecture overview.”
■ Synchronous report settings apply only to scheduled jobs.
■ Factory process executable file cache settings determine how the Factory
process caches report object executable (.rox) files when it runs them.

268 Administering Actuate iSer ver System

The following table describes the report generation and report printing
parameters that appear on Servers—Properties—Factory Service.

Parameter Description
Maximum number of Maximum number of factories to run to support
factories asynchronous and synchronous report
generation. The value for this parameter is the
maximum number of concurrent synchronous
and asynchronous factories that Actuate iServer
System runs for all resource groups on an
Actuate iServer node. For information about
Actuate iServer resource groups, see “Setting
server parameter values for an Actuate iServer
System resource group,” later in this chapter.
Transient report cache Maximum size, in megabytes (MB), of the cache
size for temporary reports. The default value is
100MB.
Actuate iServer stores temporary reports in an
external cache and deletes the files after a
specified time. If users fill the transient store
cache with temporary reports, Actuate iServer
shortens the time that each report remains in the
cache. By temporarily shortening this time,
Actuate iServer System can handle the incoming
temporary reports. Actuate iServer returns to
normal operation when the available space in the
cache increases.
Transient report cache Location of the cache for temporary reports.
location
Transient report timeout Maximum number of minutes before Actuate
iServer deletes a temporary report file from the
cache. The default value is 30 minutes. Actuate
iServer uses the longer of the following two
values:
■ Transient report timeout parameter value
■ The sum of the Max synchronous job runtime
parameter value and the Max synchronous
job queue wait time parameter value
Max synchronous job Maximum time, in seconds, that Actuate iServer
runtime can take to complete a synchronous report
generation job. The default value is 300 seconds.
Actuate recommends that you use a time of less
than 900 seconds (15 minutes).

Chapter 7, Working with an Actuate iServer System ser ver 269

 Parameter Description
Max synchronous job Maximum number of synchronous or temporary
queue size jobs that can be in the queue. The default value is
100 jobs.
Max synchronous job Maximum time, in seconds, that a synchronous
queue wait time job can remain in the queue. The default value is
600 seconds.
Synchronous job weight Relative weight assigned to the Actuate iServer.
for this server Actuate iServer System uses the Actuate iServer
node’s weight numbers when distributing
synchronous jobs to nodes in an Actuate iServer
cluster.
Enable executable Is selected, the Factory process caches ROX files
caching that it runs.
Maximum executable Maximum size, in kilobytes (KB), of the Factory
cache size per factory process executable program cache. If you select
process Enable executable caching, specify a value for
this parameter.

How to set Factory service parameter values

1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for the server for which you want to
set parameter values and choose Properties.
Servers—Properties—Factory Service appears.
3 Choose Factory Service.
Servers—Properties—Factory Service appears.
4 Specify values for the parameters that appear on System—Properties—
Factory Service.
Choose OK.

270 Administering Actuate iSer ver System

Specifying Caching service parameter values
On Servers—Properties—Caching Service, an Actuate iServer System
administrator specifies Actuate iServer property values for the Caching
service.

On Servers—Properties—Caching Service, an Actuate iServer System

administrator can specify values for the following property groups:
■ Caching Service Port Information
■ Caching Service Load Information
The following table describes the parameters that appear on Server—
Properties—Caching Service.

Parameter Description
Soap port for caching Port that Actuate iServer uses to communicate
service with the data source that it uses for caching.
Max soap request Maximum number of SOAP requests that
Actuate iServer System permits for the Caching
service.
Max soap request Maximum number of threads that Actuate
threads iServer System permits for SOAP requests for the
Caching service.

Chapter 7, Working with an Actuate iServer System ser ver 271

Specifying Integration service parameter values
On Servers—Properties—Integration Service, an Actuate iServer System
administrator specifies Actuate iServer property values for the Integration
service.

On Servers—Properties—Integration Service, an Actuate iServer System

administrator can specify values for the following property groups:
■ Integration Service Port Information
■ Integration Service Load Information
■ Integration Service Query Settings

272 Administering Actuate iSer ver System

 The following table describes the parameters that appear on Server—
Properties—Integration Service.

Parameter Description
Soap port for Integration Port that Actuate iServer uses to communicate
Server with the information object server.
Soap port for Integration Port that Actuate iServer uses to communicate
Server Queries with the information object server to pass queries
and data between Actuate iServer and the
information object server.
Max soap request Maximum number of SOAP requests that
Actuate iServer System permits for the
Integration Server.
Max soap request Maximum number of threads that Actuate
threads iServer System permits for SOAP requests for the
Integration Server.
Max Query run time Timeout period for running a query using an
information object.
Max Query size in rows Maximum number of rows that an information
object can return.
Max memory per query Maximum amount of memory to use for an
information object query.

Setting server parameter values for an Actuate

iServer System resource group
On Servers—Properties—Resource Groups, you can modify the Actuate
iServer System resource group parameters for an Actuate iServer node. For
more information about Actuate iServer System resource groups, see “About
resource groups” in Chapter 10, “Adding and configuring an Actuate iServer
System resource group.”

Chapter 7, Working with an Actuate iServer System ser ver 273

 For each resource group, an Actuate iServer System administrator can specify:
■ Whether the Actuate iServer node is a member of the resource group
■ The maximum number of Factory processes that Actuate iServer can run
on the Actuate iServer machine
■ The Encyclopedia volume file types that the resource group’s Factory
processes can run.
You can enable or disable resource group membership or change the number
of Factory processes in a resource group without restarting the cluster or the
Actuate iServer node. For information about working with resource groups,
see Chapter 10, “Adding and configuring an Actuate iServer System resource
group.”
Actuate iServer uses Encyclopedia volume file type classifications for report
generation and server-side printing. For example, a user can run an Actuate
report object executable (.rox) file that resides in an Encyclopedia volume.
Also, an Actuate iServer System printer can print an Actuate report object
instance (.roi) file. To support a file type in an Encyclopedia volume, you must
ensure that the file type appears in two locations. Servers—Properties—
Resource Groups is one location. The other location is File Types in the Volume
Administration console. For information about File Types, see “Specifying
open server file types” in Chapter 21, “Understanding Actuate iServer
options.”

274 Administering Actuate iSer ver System

The following table describes the resource group parameters that appear on
Servers—Properties—Resource Groups.

Parameter Description
Activate Resource group membership status. If selected,
the Actuate iServer node is a member of the
resource group. The default status is that the
Actuate iServer node is a member of the default
resource groups and not a member of additional
resource groups.
Max Factories Maximum number of factories available for the
resource group on the Actuate iServer node. The
default value is 2 for the default resource groups
and 0 for additional resource groups.
Resource Group Resource group name.
Supported file types for Comma-separated list of the Encyclopedia
generation and printing volume file types that Actuate iServer can
generate and print. Factories assigned to the
specified resource group can run and print the
file types that appear in this list.
An Encyclopedia volume stores Encyclopedia
volume file-type definitions. If you define an
executable file type for an Encyclopedia volume,
you must also specify the file type as a value of
this parameter.For more information about
Encyclopedia volume file types, see “Specifying
open server file types” in Chapter 21,
“Understanding Actuate iServer options.”
When you add an Actuate iServer node, the
default file types appear in this list.
Type Type of jobs the resource group runs. If the type
value is Async, the resource group runs
asynchronous jobs. If the type value is Sync, the
resource group runs synchronous jobs.

For information about viewing and setting resource group parameter values
for all Actuate iServer nodes, see Chapter 10, “Adding and configuring an
Actuate iServer System resource group.”

How to change resource group parameter values on Servers—

Properties—Resource Groups
1 From the side menu of the System Administration console, choose Servers.

Chapter 7, Working with an Actuate iServer System ser ver 275

 Servers appears.
2 Hover the pointer over the arrow icon for a server and choose Properties.
Servers—Properties—General appears.
3 Choose Resource Groups.
Servers—Properties—Resource Groups appears.
4 Change the resource group’s parameter values, as necessary. Choose OK.

Specifying the buffer pool size for an Encyclopedia

volume
On Servers—Properties—Volumes, you can view the list of Encyclopedia
volumes that Actuate iServer manages. You can also change the buffer pool
size for the Encyclopedia volumes. Using multiple Encyclopedia volumes
requires an Actuate iServer license file that enables the Actuate Additional
Volume Option. In a cluster, Servers—Properties—Volumes lists the
Encyclopedia volumes that a particular Actuate iServer node manages.

276 Administering Actuate iSer ver System

The following table describes the parameter that appears on Servers—
Properties—Volumes.

Parameter Description
Buffer pool size Buffer pool size, in megabytes (MB). The default
value is 10MB.

In a cluster, you must add an Encyclopedia volume to the cluster before you
can assign the volume to Actuate iServer. For information about adding a
volume to a cluster, see “Adding and configuring an Encyclopedia volume” in
Chapter 9, “Working with an Actuate iServer System volume.”
To be available to users, an Encyclopedia volume must be online. For
information about taking a volume online, see “Taking an Encyclopedia
volume online or putting an Encyclopedia volume offline” in Chapter 9,
“Working with an Actuate iServer System volume.”

How to specify the buffer pool size for an Encyclopedia volume

1 From the side menu of the System Administration console, choose Servers.

Chapter 7, Working with an Actuate iServer System ser ver 277

 Servers appears.
2 Hover the pointer over the arrow icon for a server and choose Properties.
Servers—Properties—General appears.
3 Choose Volumes.
Servers—Properties—Volumes appears.
4 In Available volumes, select the volume for which you want to change the
value. In Buffer pool size, type a new value. Choose OK.

Assigning backup responsibility for an

Encyclopedia volume to an Actuate iServer node
Before you can assign an Encyclopedia volume to an Actuate iServer node,
you must add the volume to Actuate iServer System. For information about
adding an Encyclopedia volume to Actuate iServer System, see “Adding and
configuring an Encyclopedia volume” in Chapter 9, “Working with an Actuate
iServer System volume.”
A backup Actuate iServer node manages an Encyclopedia volume if the
Encyclopedia volume’s primary Actuate iServer node fails. You can specify
backup responsibilities for Actuate iServer nodes in an Actuate iServer cluster
on Servers—Properties—Failover Volumes.

278 Administering Actuate iSer ver System

On Servers—Properties—Failover Volumes, an Actuate iServer System
administrator can use the left and right arrows to move Actuate iServer
System Encyclopedia volume names between Available volumes and Volumes
this server is a backup for. The volumes that appear in Volumes this server is a
backup for are the Encyclopedia volumes for which the Actuate iServer node
is a backup server.
The following table describes the parameter that appears on Servers—
Properties—Failover Volumes.

Parameter Description
Buffer pool size Buffer pool size, in megabytes (MB). The default
value is 10MB.

For more information about Encyclopedia volume failover, see “Failing over
an Encyclopedia volume” in Chapter 9, “Working with an Actuate iServer
System volume.”
Using multiple Encyclopedia volumes requires the Additional Volume Option
for Actuate iServer System. For more information about the Additional
Volume Option, see “Understanding the Actuate iServer System options” in
Chapter 1, “Actuate iServer architecture overview.”

Chapter 7, Working with an Actuate iServer System ser ver 279

 How to assign backup responsibility for an Encyclopedia volume
to an Actuate iServer node
1 From the side menu in the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for the Actuate iServer node and
choose Properties.
Servers—Properties appears.
3 Choose Failover Volumes.
Volumes—Properties—Failover Volumes appears.
4 Assign backup responsibility for one or more Encyclopedia volumes to the
Actuate iServer node. Choose OK.

Designating partition space for Actuate iServer

On Servers—Properties—Partitions, you can specify the locations of partitions
that are available to Actuate iServer System. For more information about
working with Actuate iServer partitions, see Chapter 8, “Working with an
Actuate iServer System partition.”

On Servers—Properties—Partitions, an Actuate iServer System administrator

can access the following functionality:
■ Choose Change to modify a value. The Partition Path value is the path from
an Actuate iServer machine to a partition.
■ Choose Test to test the accessibility of a partition from an Actuate iServer
machine. When you choose Test, Actuate iServer confirms the validity of

280 Administering Actuate iSer ver System

 the path and verifies that Actuate iServer can read and write to the location.
At the completion of the test, a result message appears.
The following table describes the partition space parameters that appear on
Servers—Properties—Partitions.

Parameter Description
Partition Name List of the names of Actuate iServer partitions.
Partition Path Fully qualified paths to the Actuate iServer
partitions that appear in the Partition Name list.
In an Actuate iServer cluster, all nodes in the
cluster must be able to access an Actuate iServer
System partition.

How to designate partition space for Actuate iServer

1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for a server and choose Properties.
Servers—Properties—General appears.
3 Choose Partitions.
Servers—Properties—Partitions appears.
4 In Partition Path, specify the path to the Actuate iServer System partition to
use for each Encyclopedia volume, choose Change to update the path.
To test the path to the partition for an Encyclopedia volume, choose Test for
that Encyclopedia volume.
Choose OK.

Specifying parameter values for an Actuate iServer

System printer
On Servers—Properties—Printers, you can specify server parameter values for
an Actuate iServer System printer. For more information about Actuate iServer

Chapter 7, Working with an Actuate iServer System ser ver 281

 System printer parameters, see Chapter 11, “Adding and configuring an
Actuate iServer System printer.”

The following table describes the printer parameters that appear on Servers—
Properties—Printers.

Parameter Description
PPD File Name PPD file name. This parameter appears for
printers on a UNIX operating system only.
Printer name The name of the printer. This parameter value
precedes the list of parameter values for each
individual printer.
Printer path Path to the printer from the Actuate iServer
machine. This parameter appears for all printers.
Spool command Spool command for UNIX operating systems.
Actuate recommends using the copy before
printing option. For example, on an AIX system,
use the following command:
lp -c -d

This parameter appears for printers on a UNIX

operating system only.

282 Administering Actuate iSer ver System

 In a cluster, Actuate iServer System maintains printer information about the
printers that each Actuate iServer node uses.

How to specify Actuate iServer parameter values for a printer

1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for a server and choose Properties.
Servers—Properties—General appears.
3 Choose Printers.
Servers—Properties—Printers appears.
4 For each available printer, specify parameter values. Choose OK.

Working with advanced Actuate iServer parameter

values
You can use Servers—Properties— Advanced to specify diagnostic logging
settings and change or supply values for many Actuate iServer System
parameters. For more information about specifying advanced parameter
values, see “Changing advanced Actuate iServer System settings” in Chapter
5, “Actuate iServer System administration overview.”

Chapter 7, Working with an Actuate iServer System ser ver 283

 On Servers—Properties—Advanced, an Actuate iServer System administrator
can access the following functionality:
■ Choose Change to view and change the diagnostic logging options for
Actuate iServer System. For information about diagnostic logging settings,
see “Configuring and using diagnostic logging,” later in this chapter.
■ Choose Printable summary to view a printable list of Actuate iServer
parameters and their values.
■ Choose a subset of parameters from the Properties settings list. For
information about changing server parameter values, see “Changing
advanced Actuate iServer parameter values,” later in this chapter.

Configuring and using diagnostic logging

An Actuate iServer System administrator uses the information in diagnostic
log files to solve Actuate iServer problems, if they occur. To monitor system
performance, use Actuate iServer System usage logging and error logging. For
information about Actuate iServer usage logging, see “Configuring and using
system usage logging” in Chapter 6, “Working with system-wide Actuate
iServer parameters.” For information about Actuate iServer error logging, see

284 Administering Actuate iSer ver System

“Configuring and using error logging” in Chapter 6, “Working with system-
wide Actuate iServer parameters.”
Actuate iServer generates the file name for a diagnostic log file using the
process name, an Actuate iServer-generated integer, and the date and time.
The following example is a view server diagnostic log name:
viewsrv7.exe.1824.2002FEB08_09_35_02_Pacific_Standard_Time.1.log
In the System Administration console, on Servers—Properties—Advanced,
choose Change to display or modify diagnostic logging settings for Actuate
iServer. You can use the options and parameters on the diagnostic logging
setup page to change diagnostic log settings. You can also enable and disable
logging. When you choose Change on System—Properties—Advanced, the
following page appears.

Chapter 7, Working with an Actuate iServer System ser ver 285

 An Actuate iServer System administrator can configure the following
diagnostic logs:
■ General log records Encyclopedia volume messages.
■ Factory log records Factory process messages.
■ Viewing log records View process messages.
■ Caching Service log records Caching service messages.
■ Integration Service log records Integration service messages.
The following table describes the parameters that appear on the diagnostic
logging setup page.

Parameter Description
Directory Location of log file.
Level Amount and type of information that Actuate
iServer records in a log file. The default log level
is 8000. At the default log level, Actuate iServer
logs warnings and errors. A higher number logs
only errors. A lower number logs additional
information, including diagnostic trace
information.
Number of log files Maximum number of log files to store.
Size Maximum size of a log file, in kilobytes (KB).

How to change diagnostic logging settings for Actuate iServer

System
1 From the side menu of the System Administration console, choose Servers.
Servers appears.
2 Hover the pointer over the arrow icon for a server and choose Properties.
Servers—Properties—General appears.
3 Choose Advanced.
Servers—Properties—Advanced appears.
4 For Diagnostic logging settings, choose Change.
Servers—Properties appears.
5 For each type of diagnostic log, select or deselect Enable. Specify parameter
values for each of the parameters for the diagnostic logs that you enable.
Choose OK.
6 On Servers—Properties—Advanced, choose OK.

286 Administering Actuate iSer ver System

Changing advanced Actuate iServer parameter
values
On Servers—Properties—Advanced, an Actuate iServer System Administrator
can access and modify advanced server parameter values.

The following advanced server property categories appear on Servers—

Properties—Advanced:
■ Factory Service. For more information, see “Setting Factory service
property values for Actuate iServer,” later in this chapter.
■ View Service. For more information, see “Setting View service property
values for Actuate iServer,” later in this chapter.
■ Caching Service. For more information, see “Setting Caching service
property values for Actuate iServer,” later in this chapter.
■ NetOSI File Types (Add). For more information, see “Adding a NetOSI file
type,” later in this chapter.
■ Filetype driver information (Add). For more information, see “Adding a
filetype driver,” later in this chapter.
■ Chart Server. For more information, see “Setting chart server property
values for Actuate iServer,” later in this chapter.

Chapter 7, Working with an Actuate iServer System ser ver 287

 ■ Database Connection Configuration. For more information, see “Specifying
runtime settings for Actuate iServer,” later in this chapter.
■ Dates. For more information, see “Setting date property values for Actuate
iServer,” later in this chapter.
■ Specifying the Java Object Interface property values for Actuate iServer.
For more information, see “Specifying the Java Object Interface property
values for Actuate iServer,” later in this chapter.
■ Specifying Requester API property values for Actuate iServer. For more
information, see “Specifying Requester API property values for Actuate
iServer,” later in this chapter.
■ Specifying RSAPI process communication parameters for Actuate iServer.
For more information, see “Specifying RSAPI process communication
parameters for Actuate iServer,” later in this chapter.
For more information about Actuate iServer parameters, see Chapter 14,
“Setting Actuate iServer parameters.”

Setting Factory service property values for

Actuate iServer
The following sections describe Factory service property categories.

Specifying the directory to use for Excel output

On Servers—Properties—Advanced—Factory Service—Excel Generation, an
Actuate iServer System administrator can specify the directory to use for Excel
output.
The following table describes the parameter that appears on Servers—
Properties—Advanced—Factory Service—Excel Generation.

Parameter Description
Output directory for Full path name of the directory to which Actuate
Factory-generated Excel iServer sends Excel-format report output.
Files using ExcelAPI Takes effect at server restart.

Specifying the size and location of an image that appears

on an Actuate Query output page
On Servers—Properties—Advanced—Factory Service—Actuate Query
Generation—Actuate Query Image, an Actuate iServer System administrator
can specify property values that Actuate iServer uses when it generates
Actuate Query output that includes an image.

288 Administering Actuate iSer ver System

The following table describe the parameters that appear on Servers—
Properties—Advanced—Factory Service—Actuate Query Generation—
Actuate Query Image. You can specify a value for each of the following
parameters for an image that appears in the top-left corner of the page and for
an image that appears in the top-right corner of the page.

Parameter Description
Height for the image Height, in inches, of the image that appears on an
Actuate Query output page.
Takes effect immediately.
Path to the image Path to the image that appears on an Actuate
Query output page.
Takes effect immediately.
Width for the image Width, in inches, of the image that appears on an
Actuate Query output page.
Takes effect immediately.

Specifying asynchronous job retry settings

On Servers—Properties—Advanced—Factory Service—Asynchronous
Reports—Asynchronous Job Retries, an Actuate iServer System administrator
can specify the retry settings to use for asynchronous report generation jobs.

Chapter 7, Working with an Actuate iServer System ser ver 289

 The following table describes the parameters that appear on Servers—
Properties—Advanced—Factory Service—Asynchronous Reports—
Asynchronous Job Retries.

Parameter Description
Number of times to retry Number of times to retry a failed generation or
failed requests print request. The value is a number between 0
and 30. The default value is 0.
Takes effect immediately.
Time after which to retry Time, in seconds, after which to retry a failed
failed request generation or print request. The value is a
number between 0 and 32767. The default value
is 0.
Takes effect immediately.

Setting the log level for SAP native connector

On Servers—Properties—Advanced—Factory Service—Execution Logging—
SAP Native Connector, an Actuate iServer System Administrator specify the
amount of logging done when generating a report using the SAP native
connector.

290 Administering Actuate iSer ver System

The following table describes the parameter that appears on Servers—
Properties—Advanced—Factory Service—Execution Logging— SAP Native
Connector.

Parameter Description
SAP Native Connector Logging level for the SAP native connector. Value
Trace Logging Level is an integer between 1 to log all information, and
10000 to disable logging. Default value is 10000.
Turn on logging to diagnose runtime problems
with the SAP native connector when running a
report from an Encyclopedia volume.
6000 logs detailed trace information, 7000 logs
configuration messages, 8000 logs warnings, and
9000 logs serious errors.
Takes effect at immediately.

Specifying ports for Factory service communication

The following topics describe how to specify port numbers for Factory service
communication with other processes.

Specifying a port for Factory service communication with

e.Spreadsheet Engine
On Servers—Properties—Advanced—Factory Service—Process
Communication—eSpreadSheet, an Actuate iServer System Administrator can
specify the port that the Factory service uses for communication with
e.Spreadcheet Engine.
The following table describes the parameter that appears on Servers—
Properties—Advanced—Factory Service—Process Communication—
eSpreadSheet.

Parameter Description
e.SpreadSheet server Port that Actuate iServer uses for communication
port number with e.Spreadsheet Engine. The default value is
1569.
Takes effect at server restart.

Specifying Requester API process communication settings

On Servers—Properties—Advanced—Factory Service—Process
Communication—Requester API, an Actuate iServer System administrator
can specify whether Requester API calls use the value of the server parameter.

Chapter 7, Working with an Actuate iServer System ser ver 291

 The following table describes the parameter that appears on Servers—
Properties—Advanced—Factory Service—Process Communication—
Requester API.

Parameter Description
Report use originating Indicator of whether the Factory service uses the
encyclopedia for value of the server parameter in Requester API
requester API calls calls. The default value is true.
With the default value, Actuate iServer uses the
name or IP address of the Encyclopedia volume
that manages the report. Actuate iServer ignores
the parameters that appear in AcReqConnect or
the <server> portion of the following syntax:
rotp://<server>/<path>/<filename>

To use the server parameter value that the report

executable code specifies, set the value to false.
For example, a report executable file in one
Encyclopedia volume contains Requester API
code to run reports in another Encyclopedia
volume. To use the value that the report
executable file’s code specifies, set the value of
this parameter to false.
Takes effect immediately.

Specifying process management settings for the Factory

service
On Servers—Properties—Advanced—Factory Service—Process
Management—Factory Service, an Actuate iServer administrator can specify
values for the properties that determine how Actuate iServer System manages
Factory processes.

292 Administering Actuate iSer ver System

The following table describes the parameters that appear on Servers—
Properties—Advanced—Factory Service—Process Management—Factory
Service.

Parameter Description
Time after which Interval of time to wait before Actuate iServer
inactive factories are shuts down an idle Factory processes. The
shutdown default value is 0. The default value disables
Factory process shutdown. Using the default
value, a Factory process runs until you stop
Actuate iServer.
Set the value to an interval that avoids a high
turnover of Factory processes to manage system
resources.
If the value is 1 second, a Factory process shuts
down after running a job if it does not receive
another job within one second.
Takes effect immediately.
Number of requests Limits the total number of requests a Factory
before recycling process runs. After a process runs the specified
processes number of requests, Actuate iServer shuts down
the process. The default value is 0. The default
value disables Factory process recycling.
Enable Factory process recycling if you notice
that the Factory process resource usage increases
over time. For example, if Factory process
memory and handle usage increases over time.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 293

 Specifying transient report generation settings
The following table describes the parameter that appears on Servers—
Properties—Advanced—Factory Service—Transient Reports—Transient
Report Execution Storage.

Parameter Description
Max cache entries for Maximum number of transient synchronous
transient reports reports that Actuate iServer can manage in the
transient report cache. The default value is 10000.
If users generate a large number of transient
reports in a short period of time, and Actuate
iServer displays a message about failure to
register a temporary report, increase the value for
this parameter. In this situation, you might also
need to increase the transient report cache size.
Specify a value larger than maximum number of
reports you expect users to generate within the
period of time specified by Disk cache timeout
for transient reports parameter.
Increasing the values for both this parameter and
the Disk cache timeout for transient reports
parameter can increase Actuate iServer memory
usage.
Setting the value to 0 prevents the generation of
persistent and transient synchronous reports.
Takes effect immediately.

Setting View service property values for Actuate

iServer
The following sections describe the View service property categories.

Specifying caching property values for Actuate iServer

The following sections describe the caching properties for Actuate iServer.

294 Administering Actuate iSer ver System

Specifying Actuate iServer file caching property values
On Servers—Properties—Advanced—View Service—Caching—File Caching,
an Actuate iServer System administrator can specify values that determine
how Actuate iServer System caches files.

The following table describes the parameters that appear on Servers—

Properties—Advanced—View Service—Caching—File Caching.

Parameter Description
Timeout for process file Time, in seconds, before the View process purges
cache an object from its file cache. For an Actuate Basic
report, a View process puts objects such as
images, audio, video, and applets into the file
cache. The default value is 86400 (1 day). Actuate
recommends a value between 3600 (1 hour) and
259200 (3 days).
Because the View process cache is a disk cache,
increasing the timeout period can increase disk
space usage. Change the value based on the
objects a View process stores in the file cache and
user viewing habits. For example, if you decrease
the timeout value to 300 seconds (5 minutes), the
View process can purge cache objects too
frequently and degrade viewing performance. If
you increase the value to much, a user can see
outdated images in a report.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 295

 Parameter Description
Maximum file cache Maximum number of entries in a View process
entries per process cache. The value can be a number between 5 and
20000. The default value is 3000. Actuate
recommends a value between the values of 500
and 10000.
If a View process requires more file cache entries,
increase the value. For example, when generating
a PDF, the View process stores all images in the
file cache and writes them to PDF when it
generates the PDF. If a report contains more than
3000 images, increase the value of this parameter
to generate a PDF from the report.
If the file cache reaches the maximum allowed
size, the View process replaces old objects with
new ones, even if the number of objects is less
than the maximum number allowed by this
parameter value.
Takes affect at server restart.
Maximum file cache size Maximum file cache size, in megabytes (MB) for
per process each View process. The value can be any positive
integer. The default value is 50MB.
The cache size limit is for each View process. An
Actuate iServer node with the View service
enabled can run several View processes
simultaneously. The maximum cache size for all
View processes allowed on the Actuate iServer
machine must be less than the amount of free
disk space available on the system.
If the value of this parameter is too small, the
View process clears the cache frequently, which
degrades viewing performance. If the value is too
large, it can increase temporary disk space usage.
If the number of the objects in the file cache
reaches the maximum allowed by the Maximum
file cache entries per process parameter, the View
process replaces old objects with new ones, even
if the total size of the objects is less than the
maximum allowed.
Takes effect at server restart.

296 Administering Actuate iSer ver System

Specifying Actuate iServer session caching property values
On Servers—Properties—Advanced—View Service—Caching—Session cache,
an Actuate iServer System administrator can specify values that determine
how Actuate iServer System handles system caching.

The following table describes the parameters that appear on Servers—

Properties—Advanced—View Service—Caching—Session cache.

Parameter Description
ACL cache timeout Maximum time, in seconds, that a View process
waits to check an Encyclopedia volume
document’s ACL and access permissions while a
user is viewing the document. A View process
purges a user’s View session cache if there is a
change in the ACL or the access permissions. A
View process does not purge the cache if there is
no change. The default value is 3600.
Change the value based on the expected amount
of changes to a document’s ACL and
permissions.
A small value causes the View process to perform
checks and cache purges frequently. These
frequent checks and purges can degrade viewing
performance.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 297

 Parameter Description
Maximum cached Maximum number of user and report object
sessions per process instance (.roi) file View sessions to retain in the
View session cache. The default value is 4096.
Takes effect at server restart.
Session cache timeout Time, in seconds, that a View process waits
before invalidating the contents of a user’s View
session cache. The default value is 3600.
After the session cache times out, the View
process purges the cache when:
■ A user accesses the cache data.
■ The View process adds a new session to the
cache.
A small value can cause the View process to
purge cache frequently. The frequent purging can
degrade viewing performance.
Takes effect at server restart.

Specifying DHTML output viewing and generation settings

The following sections describe the DHTML viewing and generation
properties for Actuate iServer.

Specifying the location of the stylesheet to use for DHTML output

On Servers—Properties—Advanced—View Service—DHTML Generation—
CSS, an Actuate iServer System administrator can specify which cascading
stylesheet (CSS) to use for DHTML output.

298 Administering Actuate iSer ver System

The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—DHTML Generation—CSS.

Parameter Description
CSS file location Location of the CSS to use when a user views a
required for viewing report in DHTML format using Actuate Active
through Active Portal/ Portal or Management Console. The default
Management Console value is ../css/.
Takes effect at server restart.
CSS file location Location of the CSS to use when a user views a
required for ReportCast report using Actuate ReportCast. The default
value is /actuate/default/standard/.
Takes effect at server restart.

Specifying the DHTML generator

On Servers—Properties—Advanced—View Service—DHTML Generation—
DHTML Generator Information, an Actuate iServer System administrator can
specify the name of the DHTML generator that appears in the META tag of the
DHTML output that the View process generates.
The following table describes the parameter that appears on Servers—View
Service—DHTML Generation—DHTML Generator Information.

Parameter Description
DHTML Generator DHTML Generator Information. The default
Information value is Actuate. The value of the NAME
attribute in the META tag of the DHTML output
that the View process generates. If the value is an
empty string, the DHTML output does not
include the META tag.
Takes effect at server restart.

Specifying the Javascript to use in DHTML generation

On Servers—Properties—Advanced—View Service—DHTML Generation—
Javascript, an Actuate iServer System administrator can specify the location of
the Javascript file to use for viewing DHTML output.

Chapter 7, Working with an Actuate iServer System ser ver 299

 The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—DHTML Generation—Javascript.

Parameter Description
JavaScript file location Location of JavaScript files to use when a user
required for viewing views a DHTML format report using Actuate
through Active Portal/ Active Portal or Management Console. The
Management Console default value is ../js/.
Takes effect at server restart.
JavaScript file location Location of JavaScript files to use when a user
required for ReportCast views a DHTML format report using Actuate
ReportCast. The default value is
/actuate/default/standard/.
Takes effect at server restart.

Specifying e.Analysis display settings for Actuate iServer

The following sections describe how to set Actuate iServer property values for
viewing e.Analysis.

Branding Actuate e.Analysis output

On Servers—Properties—Advanced—View Service—e.Analysis—Branding,
an Actuate iServer System administrator can specify values for properties to
determine how output from Actuate e.Analysis appears.

300 Administering Actuate iSer ver System

The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—e.Analysis—Branding.

Parameter Description
Main Title The default main title text for e.Analysis.
Takes effect at server restart.
Watermark Watermark to use for e.Analysis. The default
value is daedclejcpafef.
Takes effect at server restart.
Window Title Window title for e.Analysis. The default value is
Actuate e.Analysis.
Takes effect at server restart.

Specifying general e.Analysis viewing property values

On Servers—Properties—Advanced—View Service—e.Analysis—General, an
Actuate iServer System administrator can specify values for properties that
control e.Analysis output generation for viewing.

The following table describes the parameters that appear on Servers—

Properties—Advanced—View Service—e.Analysis—General.

Parameter Description
Data cube size Maximum size, in megabytes (MB) of an
e.Analysis data cube size. The default value is 6.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 301

 Parameter Description
Decimal points Decimal precision to use for e.Analysis output.
Parameter: The default value is 3.
eAnalysisDecimalPoint Takes effect at server restart.
Codebase Path used by The e.Analysis application codebase path to use
Active Portal and when a user views a report using Actuate Active
Management Console. Portal or Management Console. The default
value is ../eanalysis.
Takes effect at server restart.

Specifying e.Analysis histogram settings

On Servers—Properties—Advanced—View Service—e.Analysis—Histogram,
an Actuate iServer System administrator can specify how to display
histograms in e.Analysis output.

The following table describes the parameters that appear on Servers—

Properties—Advanced—View Service—e.Analysis—Histogram.

Parameter Description
Show 3D histograms Indicator of whether to show e.Analysis
histograms with a three-dimensional visual
appearance. The default value is true.
Takes effect at server restart.

302 Administering Actuate iSer ver System

Parameter Description
Show Histogram data Indicator of whether to show e.Analysis
values as percent Histogram data values as percentages. The
default value is false.
Takes effect at server restart.
Show histogram data Indicator of whether to show e.Analysis
values as numeric histogram data values as numeric data. The
default value is true.
Takes effect at server restart.

Specifying e.Analysis label settings

On Servers—Properties—Advanced—View Service—e.Analysis—Labels, an
Actuate iServer System administrator can specify how e.Analysis displays
labels.

The following table describes the parameters that appear on Servers—

Properties—Advanced—View Service—e.Analysis—Labels.

Parameter Description
Show Line graph Indicator of whether to show e.Analysis line
subcategory labels graph subcategory labels. The default value is
false.
Show Line graph data Indicator of whether to show e.Analysis line
values as percent graph data values as percent. The default value is
false.
Show Line graph data Indicator of whether to show e.Analysis line
values as numeric graph data values as numeric data. The default
value is false.

Chapter 7, Working with an Actuate iServer System ser ver 303

 Specifying e.Analysis pie chart settings
On Servers—Properties—Advanced—View Service—e.Analysis—Pie Chart,
an Actuate iServer System administrator can specify how pie charts appear in
e.Analysis output.

The following table describes the parameters available on Servers—

Properties—Advanced—View Service—e.Analysis—Pie Chart

Parameter Description
Combine pie chart Actuate iServer combines pie chart subcategories
subcategories that are that are less than this percentage of the total. The
less than this % of total value can be any percentage from 0 to 99. The
default value is 3.
Takes effect at server restart.
Show 3D pie chart Indicator of whether to show e.Analysis pie chart
graphs graphs with a three-dimensional visual effect.
Parameter: The default value is true.
eAnalysisShowPieChart Takes effect at server restart.
In3D
Show pie chart sub Indicator of whether to show e.Analysis pie chart
category label subcategory labels. The default value is true.
Takes effect at server restart.

304 Administering Actuate iSer ver System

Parameter Description
Show pie chart data Indicator of whether to show e.Analysis pie chart
values as percent data values as percentages. The default value is
Parameter: true.
eAnalysisShowPieChart Takes effect at server restart.
Percent
Show pie chart data Indicator of whether to show e.Analysis pie chart
values as numeric data values as numeric data. The default value is
true.
Takes effect at server restart.

Specifying e.Analysis table settings

On Servers—Properties—Advanced—View Service—e.Analysis—Table View,
an Actuate iServer System administrator can specify how tables appear in
e.Analysis output.

Chapter 7, Working with an Actuate iServer System ser ver 305

 The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—e.Analysis—Table View.

Parameter Description
Auto-resize vertical axis Indicator of whether to automatically expand
rows to fill the height of the data display area.
The default value is true.
Takes effect at server restart.
Disable measures total Indicator of whether to disable total measures in
e.Analysis. The default value is false.
Takes effect at server restart.
Horizontal axis color e.Analysis horizontal axis color. The default
value is 158, 158, 207.
Takes effect at server restart.
Show hierarchy of Indicator of whether to show the hierarchy of
column sub categories column subcategories in e.Analysis. The default
value is true.
Takes effect at server restart.
Show column totals Indicator of whether to show e.Analysis column
totals. The default value is false.
Takes effect at server restart.
Show leading column Indicator of whether to show e.Analysis leading
totals column totals. The default value is true.
Takes effect at server restart.
Show hierarchy of row Indicator of whether to show hierarchy of row
sub categories subcategories in e.Analysis. The default value is
true.
Takes effect at server restart.
Show row totals Indicator of whether to show row totals in
e.Analysis. The default value is false.
Takes effect at server restart.
Show leading column Indicator of whether to show leading column
totals totals in e.Analysis. The default value is true.
Takes effect at server restart.
Show drill controls Indicator of whether to show e.Analysis drill-
down controls. The default value is true.
Takes effect at server restart.

306 Administering Actuate iSer ver System

Parameter Description
Show columns with no Indicator of whether to show columns that
data contain no data in e.Analysis output. The default
value is true.
Takes effect at server restart.
Show rows with no data Indicator of whether to show rows that no data in
e.Analysis output. The default value is true.
Takes effect at server restart.
Show grid lines Indicator of whether to show e.Analysis grid
lines. The default value is true.
Takes effect at server restart.
Show columns with all Indicator of whether to show e.Analysis columns
zeros with all zeros. The default value is true.
Takes effect at server restart.
Show rows with all Indicator of whether to show e.Analysis rows
zeros with all zeros. The default value is true.
Takes effect at server restart.
Show Zero Variables Indicator of whether to show e.Analysis zero
rows. The default value is false.
Takes effect at server restart.
Sort dimension Indicator of whether to sort e.Analysis dimension
data. Values are ascending, descending, and
false. The default value is ascending. A value of
descending sorts data in descending order. False
disables sorting. If you disable sorting,
dimension data is unsorted.
Takes effect at server restart.
Vertical axis color e.Analysis vertical axis color The default value is
158, 207, 178.
Takes effect at server restart.

Specifying e.Analysis toolbar settings

On Servers—Properties—Advanced—View Service—e.Analysis—Toolbar, an
Actuate iServer System administrator can specify how to display the
e.Analysis toolbar when a user views e.Analysis output.

Chapter 7, Working with an Actuate iServer System ser ver 307

 The following table describes the parameters in Toolbar.

Parameter Description
Hide calculate item Indicator of whether to hide the toolbar button to
display calculated function columns in
e.Analysis graphs. The default value is false.
Takes effect at server restart.
Hide help button Indicator of whether to hide the e.Analysis online
help toolbar button. The default value is false.
Takes effect at server restart.
Hide home button Indicator of whether to hide the e.Analysis home
button. The default value is false.
Takes effect at server restart.
Hide horizontal bar Indicator of whether to hide the e.Analysis
chart button horizontal bar chart toolbar button. The default
value is false.
Takes effect at server restart.

308 Administering Actuate iSer ver System

Parameter Description
Hide horizontal fit to Indicator of whether to hide the e.Analysis
page button horizontal fit-to-page toolbar button. The default
value is false.
Takes effect at server restart.
Hide line graph button Indicator of whether to hide the e.Analysis line
graph toolbar button. The default value is false.
Takes effect at server restart.
Hide pie chart button Indicator of whether to hide the e.Analysis pie
chart toolbar button. The default value is false.
Takes effect at server restart.
Hide preferences button Indicator of whether to hide the e.Analysis
preferences toolbar button. The default value is
false.
Takes effect at server restart.
Hide print button Indicator of whether to hide the e.Analysis print
button. The default value is false.
Takes effect at server restart.
Hide save button Indicator of whether to hide the e.Analysis Save
button. The default value is false.
Takes effect at server restart.
Hide save as Microsoft Indicator of whether to hide the e.Analysis Save
Excel button as Microsoft Excel toolbar button. The default
value is false.
Takes effect at server restart.
Hide save as Microsoft Indicator of whether to hide the e.Analysis Save
Word button as Microsoft Word toolbar button. The default
value is false.
Takes effect at server restart.
Hide table view button Indicator of whether to hide the e.Analysis table
view toolbar button. The default value is false.
Takes effect at server restart.
Hide vertical bar chart Indicator of whether to hide the e.Analysis
button vertical bar chart toolbar button. The default
value is false.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 309

 Parameter Description
Hide vertical fit to page Indicator of whether to hide the e.Analysis fit-
button vertical-to-page toolbar button. The default value
is false.
Takes effect at server restart.
Hide work offline Indicator of whether to hide the e.Analysis work
button offline button. The default value is false.
Takes effect at server restart.

Specifying Excel generation settings

On Servers—Properties—Advanced—View Service—Excel Generation—
Display, an Actuate iServer System Administrator can specify whether to
generate an Excel file for display in Excel 97.
The following table describes the parameter that appears on Servers—
Properties—Advanced—View Service—Excel Generation—Display.

Parameter Description
View Excel files with Indicator of whether to use Microsoft Excel 97 to
Excel97 view Excel files that the View process generates.
The default value is false.
If users view Excel files using Excel 97, set the
value of this parameter to true. If the value of this
parameter is true, the View process limits the
number of characters to 2000 in an Actuate Basic
report control that it converts to an Excel
spreadsheet. The 2000-character limit is an Excel
97 limitation. If the value of this parameter is
false, the limit is 4000 characters.
Takes effect at server restart.

Specifying PDF generation settings

On Servers—Properties—Advanced—View Service—PDF Generation—PDF
Generator Information, an Actuate iServer System administrator can indicate
how to identify the generator of the PDF.

310 Administering Actuate iSer ver System

The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—PDF Generation—PDF Generator
Information.

Parameter Description
The creator of the Value for the PDF creator property in a PDF file
original document (the that a View process generates. The default value
report) is Actuate.
Takes effect at server restart.
The application that Value for the PDF producer property in a PDF file
produced the PDF that a View process generates. The default value
is Actuate XML to PDF Converter 1.0.
Takes effect at server restart.

Specifying process communication settings

On Servers—Properties—Advanced—View Service—Process
Communication—RSAPI, an Actuate iServer System administrator can specify
RSAPI communication parameters for View processes.

Chapter 7, Working with an Actuate iSer ver System ser ver 311
 The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—Process Communication—RSAPI.

Parameter Description
Socket base for processes Starting number for the View process socket port
to receive ReportCast or client viewing requests.
Required for RSAPI. The value must be between
1025 and 65535. The default value is 18500.
Takes effect at server restart.
Socket count for Maximum socket port number up to which the
processes View server socket can go. Required for RSAPI.
The value must be between 0 and 64510. The
default value is 200. The sum of Socket Base For
Processes parameter and Socket Count for
Processes parameter must be less than 65535.
Takes effect at server restart.

Specifying performance-specific process management

setting
On Servers—Properties—Advanced—View Service—Process Management—
Performance, an Actuate iServer System administrator can specify a value for
a performance-specific parameter.
The following table describes the parameter that appears on Servers—
Properties—Advanced—View Service—Process Management—Performance.

Parameter Description
Maximum number of Maximum number of active threads processing
worker threads per requests. The default value is 4. The number of
process short view requests plus the number of long view
requests being processed.
Takes effect at server restart.

Specifying search result display settings for Actuate

iServer
The following topics describe the parameters that an Actuate iServer System
administrator can use to determine how Actuate iServer displays search
results for users.

312 Administering Actuate iSer ver System

Specifying display setting for search results
On Servers—Properties—Advanced—View service—Search—Display, an
Actuate iServer System administrator can specify how to display search
results.
The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—Search—Display.

Parameter Description
Font used for search Font used when saving search results as a
results exported to Excel Microsoft Excel file. The default value is Arial.
If needed, change the value to a font installed on
the users’ systems.
Takes effect at server restart.

Specifying search generation settings

The following table describes the parameters that appear on Servers—
Properties—Advanced—View Service—Search—Generation.

Parameter Description
Search timeout Maximum time Actuate iServer allows to
perform a search in an Actuate Basic report. The
default value is 180 seconds. Minimum value is 0,
Actuate iServer does not stop a search. Actuate
recommends a value between 60 seconds and 600
seconds.
If a search takes longer than the timeout value,
Actuate iServer stops the search and issues a
warning.
Change the value to a longer time, if users
require longer times to perform searches.
Actuate recommends upgrading the Actuate
iServer machine If user searches require a long
timeout.
Takes effect at server restart.

Setting Caching service property values for

Actuate iServer
On Servers—Properties—Advanced—Caching Service—Process
Communication, an Actuate iServer System administrator can specify
communication settings for the Caching service.

Chapter 7, Working with an Actuate iServer System ser ver 313

 The following table describes the parameter that appears on Servers—
Properties—Advanced—Caching Service—Process Communication.

Parameter Description
NWPPort Port for Caching process communication with
Integration process. The default value is 0.
Takes effect at server restart.

Working with NetOSI file types

The following sections describe how to add and work with a NetOSI file type.

Adding a NetOSI file type

On Servers—Properties—Advanced, choose Add for NetOSI File Types to
access Servers—Properties—Advanced—NetOSI File Types—Add. On
Servers—Properties—Advanced—NetOSI File Types—Add, an Actuate
iServer System administrator can specify parameters to add a new NetOSI file
type.

314 Administering Actuate iSer ver System

The following table describes the parameters that appear on Servers—
Properties—Advanced—NetOSI File Types—Add.

Parameter Description
Name Name of the Actuate iServer NetOSI file type.
Actuate iServer displays the name in the list of
NetOSI file types.
Takes effect immediately.
Version of third-party Open server interface version. Change the value
service to specify a different version open server
interface. Actuate recommends contacting
Actuate Customer Support before you change
this value. The value can be 2 or 3. The default
value is 2.
Takes effect at server restart.
Command line Command line for the open server driver.
arguments Actuate iServer System uses this command line
when the Version of third-party service
parameter value is 3 and a Factory process needs
to start the open server service.
Takes effect immediately.
Use attachment Indicator of the type of file transfers between
Factory process and open server service. Actuate
iServer System uses this parameter value when
the Version of third-party service parameter
value is 3. The default value is false. With the
default value, use a file path to specify an open
server files. If the value is true, Actuate iServer
System sends open server files as attachments.
If the Factory process and open server service are
on different machines, and file access using a file
path is impossible, use attachment mode.
Takes effect immediately.
SOAP port number Port number to use to connect with the open
server service that is running on an application
server.
Takes effect immediately.
Application context String used as the application context used when
sending a SOAP message the open server service
deployed on application server.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 315

 Parameter Description
Target hostname IP address or name of the host machine that hosts
the open server service. The default value is
localhost.
Takes effect at server restart.
SOAP message timeout Time, in seconds, to wait for SOAP messages
between Factory process and open server service.
If the value is larger than report request timeout,
Factory process aborts the request. If timeout
value is too small, Factory process breaks the
connection before open server service is able to
respond.
Takes effect immediately.

Viewing and modifying NetOSI file type settings

On Servers—Properties—Advanced, choose an existing NetOSI file type to
access Servers—Properties—Advanced—NetOSI File Types. On Servers—
Properties—Advanced—NetOSI File Types, an Actuate iServer System
administrator can view and modify the parameters of that NetOSI file type.

For descriptions of the parameters that appear on Servers—Properties—

Advanced—NetOSI File Types, see “Adding a NetOSI file type,” earlier in this
chapter.

316 Administering Actuate iSer ver System

Working with filetype drivers
The following sections describe how to add and work with a file type driver.

Adding a filetype driver

On Servers—Properties—Advanced, choose Add for Filetype driver to access
Servers—Properties—Advanced—Filetype driver information—Add. On
Servers—Properties—Advanced—Filetype driver information—Add, an
Actuate iServer System administrator can specify parameters to add a new
filetype driver.

The following table describes the parameters that appear on Servers—

Properties—Advanced— Filetype driver information—Add.

Parameter Description
Name Name of an Actuate iServer OSI filetype driver.
Actuate iServer displays this name in the list of
OSI filetype drivers.

Chapter 7, Working with an Actuate iServer System ser ver 317

 Parameter Description
OSI driver path Full path to an open server driver. Actuate
iServer runs the open server driver when Actuate
iServer starts and stops. Actuate iServer appends
the value of the OSI parameter file parameter as
an argument when Actuate iServer runs the open
server driver.
Takes effect at server restart.
OSI parameter file Optional parameter file to use with the open
server driver that you specify as the value of the
OSI driver path parameter. Actuate iServer
appends the value of this parameter as an
argument when Actuate iServer runs the open
server driver. Actuate iServer runs the driver
when it starts and stops.
Takes effect at server restart.

Viewing and modifying filetype driver settings

On Servers—Properties—Advanced, choose an existing filetype driver to
access Servers—Properties—Advanced—Filetype driver information. On
Servers—Properties—Advanced—Filetype driver information, an Actuate
iServer System administrator can view and modify the parameters of that
filetype driver.

For descriptions of the parameters that appear on Servers—Properties—

Advanced—Filetype driver information, see “Adding a filetype driver,”
earlier in this chapter.

318 Administering Actuate iSer ver System

Setting chart server property values for Actuate
iServer
On Servers—Properties—Advanced—Chart Server, an Actuate iServer System
administrator can specify values for chart server properties.

The following table describes the parameters in Chart Server.

Parameter Description
Chart JVM parameter JVM parameter string Actuate iServer uses when
string creating charts in a report object executable (.rox).
The default value is an empty string.
Takes effect at server restart.
Category: Chart Server
Chart server IP address IP address Actuate iServer uses to communicate
with the Java chart software to create charts for a
report object executable (.rox) file. The default
value is 127.0.0.1.
Do not change the default value.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 319

 Parameter Description
Chart server max heap Maximum JVM heap size, in megabytes (MB),
size that Actuate iServer uses when it uses the Java
chart software to create charts for a report object
executable (.rox) file. The default value is 128.
If your reports contain a large number of large
charts and you print or generate PDF, or if
Actuate iServer generates an OutOfMemory Java
exception when generating a chart, increase the
value of this parameter.
If the value is very large, the Java process to
generate charts can compete for memory with
Actuate iServer. Ensure that the Actuate iServer
machine has enough free memory to
accommodate the maximum heap size. Actuate
recommends not setting it to more than 256MB.
Takes effect at server restart.
Chart server port Port number Actuate iServer uses when it
number communicates with the Java chart software to
create a chart for a report object executable (.rox)
file. The default value is 9032.
If another application is using the default port
number, change the value of this parameter.
Actuate recommends not using common port
numbers, such as 80, or 8080.
Takes effect at server restart.

Specifying runtime settings for Actuate iServer

On Servers—Properties—Advanced—Runtime, an Actuate iServer System
administrator can specify runtime parameter values for Actuate iServer.

320 Administering Actuate iSer ver System

The following table describes the parameters that appear on Servers—
Properties—Advanced—Runtime.

Parameter Description
Configuration file for Configuration file that provides database
connections connection and data source information that
report object executable (.rox) files use.
An ROX uses database connection information
and data source information from either the
report’s connection component or from the
configuration file.
Takes effect at server restart.
Global search path for Search paths for external resources than an ROX
files used in report can use. For example, Actuate iServer retrieves
design graphics files or external libraries that an ROX
uses when a user views a report or during report
generation. Each path can be either a relative or a
full path.
Actuate iServer also uses path information that
appears in the SearchPath section of the
configuration file.
Takes effect at server restart.

Chapter 7, Working with an Actuate iServer System ser ver 321

 Setting date property values for Actuate iServer
On Servers—Properties—Advanced—Dates, an Actuate iServer System
administrator can specify how Actuate iServer handles dates.

The following table describes the parameter that appears on Servers—

Properties—Advanced—Dates.

Parameter Description
Century break Indicator of how Actuate iServer converts two-
digit year values into four-digit years. The
default value is 30.
Takes effect at server restart.
Let DateDiff() perform Controls the DateDiff( ) function in Actuate Basic
the same behavior as VB reports. Use the functionality based on Microsoft
6.0 DateDiff() Visual Basic .Net, or on Microsoft Visual Basic
6.0. Default value is false, use the Visual Basic
.Net functionality.
Set the value to true if you view or run Actuate
Basic reports built with Actuate Release 7 or
earlier software that use DateDiff( ) with a ww or
www date part indicator.
Takes effect immediately.

Specifying the Java Object Interface property

values for Actuate iServer
On Servers—Properties—Advanced—Java Object Interface, an Actuate
iServer System administrator can specify parameter values for the Java Virtual
Machine (JVM) that Actuate iServer System uses.

322 Administering Actuate iSer ver System

The following table describes the parameter that appears on Servers—
Properties—Advanced—Java Object Interface.

Parameter Description
Maximum heap size for Maximum heap size, in megabytes (MB) of the
java virtual machine JVM that the Factory and View processes use for
Actuate Basic reports. The default value is 0. With
the default value, Actuate iServer uses the
default size of the JVM.
Ensure that the Actuate iServer machine has
enough free memory to accommodate the
maximum heap size. Actuate recommends not
setting it to more than 256MB.
Takes effect at server restart.

Specifying Requester API property values for

Actuate iServer
On Servers—Properties—Advanced—Requester API, an Actuate iServer
System administrator can specify parameter values that Actuate iServer uses
when working with Requester and Requester API.
The following table describes the parameter that appears on Servers—
Properties—Advanced—Requester API.

Parameter Description
Volume used by the Encyclopedia volume that Actuate iServer uses
Requester and Report for Requester and Report Server API.
Server APIs Takes effect at system restart.

Specifying RSAPI process communication

parameters for Actuate iServer
On Servers—Properties—Advanced—Process Communication—RSAPI—
Sockets, an Actuate iServer System administrator can specify socket
information for use with RSAPI.

Chapter 7, Working with an Actuate iServer System ser ver 323

 The following table describes the parameters that appear on Servers—
Properties—Advanced—Process Communication—RSAPI—Sockets.

Parameter Description
Base socket number for Beginning of a range of port numbers that
RPC Actuate iServer attempts to use for the request
server RPC ports. Required for RSAPI. The
default value is 0. The maximum value is 32767.
Actuate iServer starts at the BASE port and
attempts to use up to BASE + COUNT - 1 port to
find a single port.
Takes effect at server restart.
Number of RPC sockets Range of port numbers that Actuate iServer
attempts to use for the request server RPC ports.
Required for RSAPI. The default value is 1. The
maximum value is 32767.
If you do not specify the beginning of the range
in the Base socket number for RPC parameter
value, Actuate iServer ignores the range setting.
If you specify the beginning of the range, but you
do not specify the range, Actuate iServer uses the
default range of 1.
Takes effect at server restart.

324 Administering Actuate iSer ver System

 Parameter Description
Base socket number for Beginning of a range of port numbers for
reply to client communication between Actuate iServer and
clients or Actuate ReportCast. The default value
is 0. The maximum value is 32767.
Takes effect at server restart.
Number of sockets for Specify the range of port numbers for ports used
reply to client for communication between Actuate iServer and
clients or Actuate ReportCast. The default is 1.
Maximum value is 32767.
If you do not specify the beginning of the range
in the Base socket number for reply to client
parameter value, Actuate iServer ignores the
range setting. If you specify the beginning of the
range, but you do not specify the range, Actuate
iServer uses the default range of 1.
Takes effect at server restart.

Changing the cluster master

As Actuate iServer System administrator, you can change which Actuate
iServer node is the cluster master. Before you change the cluster master, ensure
that:
■ Actuate iServer System has at least two assigned backup cluster masters on
Servers—Properties—Backup Master Assignment. For information about
specifying an Actuate iServer node as a backup cluster master, see “Setting
up cluster master failover” in Chapter 6, “Working with system-wide
Actuate iServer parameters.”
■ The backup cluster master that will become the cluster master is online and
can access the Actuate iServer cluster configuration file.
The default home partition for the cluster configuration is not shared. To
support changing the cluster master, the configuration home must be in a
shared partition. For information about changing the location of the
configuration file, see “About the Actuate iServer cluster configuration
file” in Chapter 5, “Actuate iServer System administration overview.”

How to change the Actuate iServer cluster master

1 From the side menu of the System Administration console, choose Servers.
Servers appears.

Chapter 7, Working with an Actuate iServer System ser ver 325

 2 In the list of servers, hover the pointer over the arrow icon for the cluster
master and choose Master fail over, as shown in the following illustration.

Servers—Master administrative fail over appears.

3 Select an Actuate iServer node to which to fail over and choose Fail over.
Actuate iServer System changes which Actuate iServer node is the cluster
master. When the failover process completes, Servers appears. The status of
the Actuate iServer nodes on Servers reflects the change in cluster master,
as shown in the following illustration.

326 Administering Actuate iSer ver System

Chapter 7, Working with an Actuate iServer System ser ver 327
328 Administering Actuate iSer ver System
 Chapter

Working with an Actuate

Chapter8
8
iServer System partition
This chapter contains the following topics:
■ Configuring an Actuate iServer System partition
■ Adding a partition
■ Specifying the path to an Actuate iServer System partition
■ Removing an Actuate iServer System partition

Chapter 8, Working with an Actuate iServer System par tition 329

Configuring an Actuate iServer System partition
Administrators use partitions to configure disk space for use with an
Encyclopedia volume. An Encyclopedia volume uses one or more partitions to
store data. Encyclopedia volumes cannot share a partition. For more
information about Encyclopedia volumes and partitions, see “Understanding
Encyclopedia volume configuration” in Chapter 1, “Actuate iServer
architecture overview.”
In the System Administration console, choose System Partitions to display
Partitions. Partitions lists the partitions that are available to Actuate iServer, as
shown in the following illustration. For information about changing the
partition list, see “Changing the list of Actuate iServer System partitions” in
Chapter 5, “Actuate iServer System administration overview.”

When assigned to an Encyclopedia volume, a partition has one of the states

described in the following table.

Status Definition
Active An Encyclopedia volume uses the partition.
Phaseout An Encyclopedia volume is moving data out of
the partition.
Unused The partition is assigned to an Encyclopedia
volume, but the Encyclopedia volume is not
using the partition.

On Partitions, an administrator can access the following functionality:

■ Choose Add Partition to add a partition to Actuate iServer System. For
information, see “Adding a partition,” later in this chapter.
■ Hover the pointer over the arrow icon for a partition and choose one of the
following actions:
■ Choose Server settings to modify the partition’s parameter values. For
information, see “Specifying the path to an Actuate iServer System
partition,” later in this chapter.

330 Administering Actuate iSer ver System

 ■ Choose Delete to delete the partition from Actuate iServer System. For
information, see “Removing an Actuate iServer System partition,” later
in this chapter.
Some Encyclopedia volume parameters affect partitions and partition usage.
For information about Encyclopedia volume parameters, see “Modifying
Actuate iServer parameter values for an Encyclopedia volume” in Chapter 9,
“Working with an Actuate iServer System volume.” For information about the
partition parameters for an Encyclopedia volume, see “Assigning a partition
to an Encyclopedia volume” in Chapter 9, “Working with an Actuate iServer
System volume.” For information about specifying values for the server
parameters for partitions, see “Designating partition space for Actuate
iServer” in Chapter 7, “Working with an Actuate iServer System server.”

Adding a partition
To add an Encyclopedia volume or assign a new partition to an Encyclopedia
volume, you must first create a new partition using Partitions—Add Partition.

Chapter 8, Working with an Actuate iServer System par tition 331

 The following table describes the parameters that appear on Partitions—Add
Partition.

Partition Description
Partition name Name by which Actuate Management Console
and Actuate iServer refer to the partition.
Partition Path Fully qualified path to the root directory of the
partition from the specified Actuate iServer
machine. The path indicates a directory in a
storage device. You must specify a Partition Path
value for each Actuate iServer node in a cluster.
All Actuate iServer nodes must have access to the
partition.
For information about the syntax that Actuate
iServer supports, see “Specifying the path to an
Actuate iServer System partition,” later in this
chapter.
Server name List of names of Actuate iServer machines

After adding a partition, an administrator can configure an Encyclopedia

volume to use the partition as secondary storage. An administrator can also
use the partition to add a new Encyclopedia volume. For information about
specifying a volume’s partitions, see “Assigning a partition to an Encyclopedia
volume” in Chapter 9, “Working with an Actuate iServer System volume.” For
information about adding an Encyclopedia volume, see “Adding and
configuring an Encyclopedia volume” in Chapter 9, “Working with an Actuate
iServer System volume.”

How to add a partition to Actuate iServer System

1 From the side menu of the System Administration console, choose System
Partitions.
Partitions appears.
2 Choose Add partition.
Partitions—Add Partition appears.
3 Supply the necessary information to add the partition. Choose OK.

332 Administering Actuate iSer ver System

Specifying the path to an Actuate iServer System
partition
In an Actuate iServer cluster, every node must have read and write access to
every partition in the cluster. As Actuate iServer System administrator, you
must specify a path from each Actuate iServer node to the partition. After you
create the partition, you can view or change the path to the partition on
Partitions—Server Settings.
For an existing partition, an administrator can display the partition
information on Partition—Server Settings by choosing the partition name on
Partitions. Alternatively, hovering the pointer over the arrow icon for a
partition and choosing Server settings also displays Partition—Server Settings.
The following illustration shows Partitions—Server Settings for an Actuate
iServer System cluster with two Actuate iServer nodes.

On Partitions—Server Settings, an administrator can access the following

functionality:
■ Choose Change to modify a value. The Partition Path value is the path from
an Actuate iServer machine to a partition.
■ Choose Test to test the accessibility of a partition from an Actuate iServer
machine. When you choose Test, Actuate iServer confirms the validity of
the path and verifies that Actuate iServer can read and write to the location.
At the completion of the test, a result message appears.

Chapter 8, Working with an Actuate iServer System par tition 333

 The following table describes the parameters that appear on Partitions—
Server Settings.

Parameter Description
Server name List of names of Actuate iServer machines
Partition Path Fully qualified path to the root directory of the
partition from the specified Actuate iServer
machine. You must specify a Partition Path value
for each Actuate iServer node in a cluster. All
Actuate iServer nodes must have access to the
partition.
Actuate iServer supports connecting to remote
drives using only Universal Naming Convention
(UNC) syntax. For example, on a Microsoft
Windows server operating system, to specify a
partition in the
\files\master-encyc directory on a machine
named foxtrot, use the following UNC syntax:
\\foxtrot\files\master-encyc

How to change the path to a partition for an Actuate iServer

machine
1 From the side menu of the System Administration console, choose System
Partitions.
Partitions appears.
2 Hover the pointer over the arrow icon for a partition to display that drop-
down list.
3 Choose Server settings.

334 Administering Actuate iSer ver System

 Partitions—Server Settings appears.

4 Modify the Partition Path values as necessary. To update a value, choose

Change.
After you change partition path values, choose Test to test the accessibility
of the specified partition from the Actuate iServer machine.
5 When the test succeeds, choose OK.

Removing an Actuate iServer System partition

As Actuate system administrator, you can remove a partition from an Actuate
iServer machine. Before you remove an Actuate iServer System partition, you
must remove the partition from Actuate iServer System’s Encyclopedia
volume assignments. For information about removing a partition from
Actuate iServer System’s Encyclopedia volume assignments, see “Assigning a
partition to an Encyclopedia volume” in Chapter 9, “Working with an Actuate
iServer System volume.” The list of partitions that appears on Partitions in the
System Administration console must also indicate that the partition is not
assigned to an Encyclopedia volume and that the partition is unused.
If the partition is an Encyclopedia volume’s primary partition, you must
ensure that you migrate or back up the Encyclopedia volume’s information
before you delete the partition, unless Actuate iServer System users no longer
need that information.

How to remove an Actuate iServer System partition

1 From the side menu of the System Administration console, choose System
Volumes.
Volumes appears.
2 From the drop-down list for the Encyclopedia volume that uses the
partition, choose Properties.

Chapter 8, Working with an Actuate iServer System par tition 335

 Volumes—Properties—General appears.
3 Choose Partitions.
Volumes—Properties—Partitions appears.
4 In Selected Partitions, select the partition to remove. Select Stop. Choose
OK.
Actuate iServer System stops the partition. To stop the partition, the
Encyclopedia service moves data from the partition to other available
volume partitions. When Actuate iServer finishes phasing out the partition,
Actuate iServer System changes the partition’s status to unused. If there is
not enough room to store the data from the partition being deleted, a
failure message appears. For descriptions of the partition states, see
“Configuring an Actuate iServer System partition,” earlier in this chapter.
When Actuate iServer finishes phasing out the partition, Volumes appears.
5 Repeat steps 2 and 3.
6 On Volumes—Properties—Partitions, in Selected partitions, select the
partition to remove. Choose the left arrow to move the partition from
Selected partitions to Available partitions.
7 Choose System Partitions.
Partitions appears.
8 Confirm that the partition is not assigned to an Encyclopedia volume and
that it is unused. Then, hover the pointer over the arrow icon for the
partition to display the drop-down list for the partition.
9 Choose Delete.
A confirmation dialog box appears.

10 To delete the partition, choose OK.

336 Administering Actuate iSer ver System

 Chapter

Working with an Actuate

Chapter9
9
iServer System volume
This chapter contains the following topics:
■ About Encyclopedia volume tasks
■ About the default RSAPI setup for Actuate iServer in a stand-alone
configuration
■ Adding and configuring an Encyclopedia volume
■ Taking an Encyclopedia volume online or putting an Encyclopedia volume
offline
■ Modifying Actuate iServer parameter values for an Encyclopedia volume
■ Changing which Actuate iServer machine owns an Encyclopedia volume
■ Failing over an Encyclopedia volume
■ Working with Actuate Open Security
■ Assigning a partition to an Encyclopedia volume
■ Working with advanced Encyclopedia volume parameters
■ Restoring an Encyclopedia volume snapshot
■ Moving an Encyclopedia volume
■ Removing an Encyclopedia volume from Actuate iServer System

Chapter 9, Working with an Actuate iSer ver System volume 337

About Encyclopedia volume tasks
In the System Administration console, you can set an Encyclopedia volume’s
parameter values. In an Actuate iServer System cluster, the values you can set
include which Actuate iServer node manages the volume, backup and failover
settings for the volume, and the location of the e-mail notice template that the
cluster nodes share.
In the System Administration console, from the side menu, choose System
Volumes to display volume information for Actuate iServer System. For an
Actuate iServer cluster, Volumes displays volume information for the entire
cluster.
When you install Actuate iServer, the default Encyclopedia volume setup
depends on how you install Actuate iServer:
■ For Actuate iServer in a stand-alone configuration, the default installation
configures an Encyclopedia volume on the Actuate iServer machine.
■ For an Actuate iServer cluster, the default installation configures an
Encyclopedia volume on the cluster master.
When upgrading from a previous release, the Actuate iServer installation
migrates the existing Encyclopedia volume settings such as partition and
archive application information as part of the upgrade.
As an Actuate iServer System administrator, you can configure and add
Encyclopedia volumes to Actuate iServer System. Adding a second volume
requires an Actuate iServer license file that enables the Actuate Additional
Volume Option. For information about Actuate iServer System options, see
“Understanding the Actuate iServer System options” in Chapter 1, “Actuate
iServer architecture overview.”
You can also change the default Encyclopedia volume for the login page of
Actuate Management Console. You change this setting on System—
Properties—General. For information about System—Properties—General, see
“Setting general Actuate iServer parameter values for an Actuate iServer
machine” in Chapter 7, “Working with an Actuate iServer System server.”
You can also update the resource group properties associated with an
Encyclopedia volume. For example, changing which Actuate iServer node
manages a volume can require that you change resource groups to reflect the
change. For information resource groups, see Chapter 10, “Adding and
configuring an Actuate iServer System resource group.”

338 Administering Actuate iSer ver System

About the default RSAPI setup for Actuate iServer in
a stand-alone configuration
If a single Actuate iServer machine manages multiple Encyclopedia 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 Actuate IServer
machine. For example, if Actuate iServer manages an Encyclopedia volume
named sales, and you add an Encyclopedia volume named production, RSAPI
applications can access only the volume named sales. RSAPI applications
cannot access the volume named production.
To enable RSAPI on a different Encyclopedia volume, set the Volume used by
the Requester and Report Server APIs parameter for Actuate iServer. For
information about setting advanced Actuate iServer parameters, see
“Changing advanced Actuate iServer parameter values” in Chapter 7,
“Working with an Actuate iServer System server.”
For more information about RSAPI, see Using Actuate Report Server API and
Actuate Report Server API Reference.

Adding and configuring an Encyclopedia volume

To add an Encyclopedia volume and assign an Actuate iServer machine to
manage it, you must log in to the System Administration console. Before you
add the Encyclopedia volume, ensure that Actuate iServer System can access
an unused Actuate iServer System partition. Only one volume uses each
partition, but a single volume can use multiple partitions. An Actuate iServer
System partition is not the same as a disk drive partition. For information
about adding an Actuate iServer System partition, see “Adding a partition” in
Chapter 8, “Working with an Actuate iServer System partition.” After you
create a new partition, if necessary, complete the following tasks to add and
configure an Encyclopedia volume:
■ Specify the volume’s primary Actuate iServer System partition parameters.
For information about specifying an Encyclopedia volume’s primary
partition parameters, see “Assigning a partition to an Encyclopedia
volume,” later in this chapter.
■ Start at least one of the volume’s partitions. For information about starting
an Actuate iServer System partition, see “Configuring an Actuate iServer
System partition” in Chapter 8, “Working with an Actuate iServer System
partition.”
■ Assign an Actuate iServer machine to manage the volume. For more
information about specifying which Actuate iServer node manages an

Chapter 9, Working with an Actuate iSer ver System volume 339

 Encyclopedia volume, see “Assigning a backup server to an Encyclopedia
volume,” later in this chapter.
A new Encyclopedia volume requires some additional configuration. After an
administrator sets up an Encyclopedia volume, configuring the volume can
require the following Actuate iServer modifications:
■ Create or specify additional partitions. For information about these tasks,
see “Adding a partition” in Chapter 8, “Working with an Actuate iServer
System partition,” or “Assigning a partition to an Encyclopedia volume,”
later in this chapter.
■ Specify a list of secondary backup servers. For information about this task,
see “Assigning a backup server to an Encyclopedia volume,” later in this
chapter.
■ Specify an Actuate RSSE open security application. For information about
Actuate Open Security, see “Working with Actuate Open Security,” later in
this chapter, and “About Actuate Open Security” in Chapter 16, “Managing
Encyclopedia volume security.”
■ Specify an archive library to use with the volume’s autoarchiving function.
For more information about autoarchiving, see “Archiving files and
removing empty folders” in Chapter 20, “Archiving files and backing up an
Encyclopedia volume.”
As an administrator, you specify volume location information on Volumes—
New Volume—General.

340 Administering Actuate iSer ver System

The following table describes the parameters that appear on Volumes—New
Volume—General.

Parameter Description
Volume name Name of the Encyclopedia volume.
Description Optional description of the Encyclopedia
volume.
Interval before purging Minimum time to wait before Actuate iServer
dead requests purges scheduled jobs that pass their end dates.

Chapter 9, Working with an Actuate iSer ver System volume 341

 Parameter Description
Schedule for purging Time at which Actuate iServer deletes notices.
notices The value format is a semicolon-separated list of
times, in ascending order. Use a 24-hour format.
For example:
03:15;16:15

Primary partition Name of the Encyclopedia volume’s primary

partition.
Min Free Space for the Minimum amount of free disk space that the
primary partition Encyclopedia volume’s primary partition
requires. If the partition’s free space is below the
specified minimum, Actuate iServer takes the
Encyclopedia volume offline. The default value is
128MB.
Transaction log path Path to the partition that contains the transaction
log files for the Encyclopedia volume. The
default setting is the Encyclopedia volume’s
primary partition.
Min Free Space for the Minimum amount of free disk space that the
transaction log path Encyclopedia volume’s transaction log file
partition requires. If the partition’s free space is
below the specified minimum, Actuate iServer
takes the Encyclopedia volume offline. The
default value is 128MB.
Use command line If selected, Actuate iServer uses the SOAP-based
Archive IDAPI archiving application for
Encyclopedia volume archiving. Specify the
command line string Actuate iServer runs to start
the archiving application.
Archive library name If selected, Actuate iServer uses the C-based
autoarchive application. Specify the location and
name of the Encyclopedia volume archive library.
The default location for the library is the Actuate
iServer bin directory, $AC_SERVER_HOME/bin.

342 Administering Actuate iSer ver System

Parameter Description
E-mail notification Name of the partition that contains the e-mail
template partition notification template file, acnotification.xml. The
default location is the etc directory for Actuate
iServer. If you specify a different partition, you
must copy acnotification.xml to the partition.
When Actuate iServer System sends an e-mail
notice, it uses an e-mail notification template to
create the e-mail. If Actuate iServer System sends
e-mail notices from multiple Actuate iServer
nodes, the nodes can use a single template if the
template is in a partition that all Actuate iServer
nodes can access.
For information about the Actuate e-mail notice
template, see “Customizing the e-mail notice” in
Chapter 2, “Setting up Actuate iServer System
hardware.”
Use Active Portal for If selected, hypertext links in report-completion
JSP for e-mail messages from Actuate iServer use Actuate
notifications Active Portal for JSP.
Active Portal for JSP URL prefix to add to the hypertext link in an e-
URL prefix mail when using Actuate Active Portal for JSP.
For information about the URL prefix, see
“Setting the URL prefix for e-mail notification” in
Chapter 2, “Setting up Actuate iServer System
hardware.”
Use Active Portal for If selected, hypertext links in report-completion
.NET for e-mail messages from Actuate iServer use Actuate
notifications Active Portal for .NET.
Active Portal for .NET URL prefix to add to the hypertext link in an e-
URL prefix mail when using Actuate Active Portal for JSP.
For information about the URL prefix, see
“Setting the URL prefix for e-mail notification” in
Chapter 2, “Setting up Actuate iServer System
hardware.”
Use ReportCast for e- If selected, hypertext links in report-completion
mail notifications messages from Actuate iServer use Actuate
ReportCast.

Chapter 9, Working with an Actuate iSer ver System volume 343

 Parameter Description
ReportCast URL prefix URL prefix to add to the hypertext link in an e-
mail when using Actuate ReportCast. For
information about the URL prefix, see “Setting
the URL prefix for e-mail notification” in Chapter
2, “Setting up Actuate iServer System hardware.”
Is Sample App. Volume If selected, the Encyclopedia volume is an
Actuate sample application volume.

After adding a volume and taking the volume online, the Encyclopedia
volume administrator must configure the Encyclopedia volume’s contents. For
information about volume administration, see Chapter 15, “Understanding
Encyclopedia volume administration.”
After adding an Encyclopedia volume to an Actuate iServer cluster, an Actuate
iServer System administrator can change which Actuate iServer node manages
the volume. For information about changing which server manages a volume,
see “Changing which Actuate iServer machine owns an Encyclopedia
volume,” later in this chapter.
An Actuate iServer System administrator can also assign an Actuate iServer
node as a volume’s backup server. For information about Actuate iServer
volume backup, see “About Encyclopedia volume failover,” later in this
chapter.
For information about modifying the Actuate iServer parameter values for an
existing Encyclopedia volume, see “Modifying Actuate iServer parameter
values for an Encyclopedia volume,” later in this chapter.

How to add and configure an Encyclopedia volume

1 From the side menu of the System Administration console, choose System
Volumes.
Volumes appears. In an Actuate iServer cluster, Volumes displays the
volume information for the cluster.

2 Choose Add Volume.

Volumes—New Volume—General appears.

344 Administering Actuate iSer ver System

 3 Specify the information about the new volume on the Volumes—New
Volume pages. The following configuration information is required:
■ On Volumes—New Volume—General, specify values for the following
parameters:
- Volume name
- Primary partition
- Transaction log path
- Is Sample App. Volume
■ On Volumes—New Volume—Server Assignments, assign a primary
server. For information about the parameters that appear on Volumes—
New Volume—Server Assignments, see “Assigning a backup server to
an Encyclopedia volume,” later in this chapter.
■ On Volumes—New Volume—Partitions, assign and start a partition.
This partition becomes the Encyclopedia volume’s primary partition.
For information about the parameters that appear on Volumes—New
Volume—Partitions, see “Assigning a partition to an Encyclopedia
volume,” later in this chapter.
■ On Volumes—New Volume—Open Security, specify values for any
Open Security settings for Actuate iServer System. For information
about the parameters that appear on Volumes—New Volume—Open
Security, see “Working with Actuate Open Security,” later in this
chapter.
Choose OK.
Volumes displays the updated list of volumes.

Taking an Encyclopedia volume online or putting an

Encyclopedia volume offline
Taking an Encyclopedia volume online enables the Encyclopedia service for
the Actuate iServer node that manages the volume. When an Encyclopedia
volume comes online:
■ The primary server for the Encyclopedia volume takes the volume online.
■ Actuate iServer or the Actuate iServer cluster accepts requests to access
volume content.
■ Encyclopedia volume users can log in, generate and view reports, and
access volume information.
When an Encyclopedia volume goes offline:
■ The primary server puts the volume offline.

Chapter 9, Working with an Actuate iSer ver System volume 345

 ■ Actuate iServer or the Actuate iServer cluster rejects requests to access
volume content.
■ Encyclopedia volume users cannot log in to the volume.

How to take an Encyclopedia volume online or put an

Encyclopedia volume offline
1 From the side menu in the System Administration console, choose
System Volumes.
Volumes appears.
2 Hover the pointer over the arrow icon for a volume to use the drop-down
menu to take the volume online or put the volume offline.

Modifying Actuate iServer parameter values for an

Encyclopedia volume
As an Actuate iServer System administrator, you can view or modify the
general Actuate iServer parameter values for an Encyclopedia volume on
Volumes—Properties—General in the System Administration console.

346 Administering Actuate iSer ver System

The following table describes the parameters that appear on Volumes—
Properties—General.

Parameter Description
Volume name Name of the Encyclopedia volume.
Description Optional description of the Encyclopedia
volume.

Chapter 9, Working with an Actuate iSer ver System volume 347

 Parameter Description
Interval before purging Minimum time to wait before Actuate iServer
dead requests purges scheduled jobs that pass their end dates.
Schedule for purging Time at which Actuate iServer deletes notices.
notices The value format is a semicolon-separated list of
times, in ascending order. Use a 24-hour format.
For example:
03:15;16:15

Primary partition Name of the Encyclopedia volume’s primary

partition.
Min Free Space for the Minimum amount of free disk space that the
primary partition Encyclopedia volume’s primary partition
requires. If the partition’s free space is below the
specified minimum, Actuate iServer takes the
Encyclopedia volume offline. The default value is
128MB.
Transaction log path Path to the partition that contains the transaction
log files for the Encyclopedia volume. The
default setting is the Encyclopedia volume’s
primary partition.
Min Free Space for the Minimum amount of free disk space that the
transaction log path Encyclopedia volume’s transaction log file
partition requires. If the partition’s free space is
below the specified minimum, Actuate iServer
takes the Encyclopedia volume offline. The
default value is 128MB.
Use command line If selected, Actuate iServer uses the SOAP-based
Archive IDAPI application for Encyclopedia
volume archiving. When using Actuate
autoarchive, select either Use command line or
Use archive library and specify the archiving
application.
Type a string that specifies the archive
application and any command-line options
required to run the application. Actuate iServer
runs an operating shell command using the
string and appends the following run-time
parameters, in the order specified, to the
command line when it starts the application.

348 Administering Actuate iSer ver System

Parameter Description
SOAP port Port number on the local
server that the archive driver
should connect to for making
the VAS API calls. For security
reasons, this SOAP port
differs from the IDAPI SOAP
port.
Session key A token that Actuate iServer
generates. The autoarchive
application uses this token
when it makes an autoarchive
API call. The token is valid for
the archive session.
Volume name Name of the Encyclopedia
volume being archived.
Server home Local Actuate iServer
installation directory.
If the string does not specify an absolute path, for
example / on UNIX or C:\ or \\ServerName on
Microsoft Windows operating systems, Actuate
iServer runs the application from the bin
directory of the Actuate iServer home directory
and prepends the path of that directory to the
command line string.
For example, if you type the following string to
use an autoarchive application on Microsoft
Windows:
mydriver.exe -doarchive

Actuate iServer runs an operating system shell

command similar to the following command to
run the archive driver:
C:\Program Files\Actuate8\Server\bin\
mydriver.exe -doarchive 9400
A5BB563400923457 "DefaultVolume" "C:\
Program Files\Actuate8\Server"

Chapter 9, Working with an Actuate iSer ver System volume 349

 Parameter Description
Use archive library If selected, Actuate iServer System uses the C-
based Auto Archive API for Encyclopedia
volume archiving. When using Actuate
autoarchive, select either Use command line or
Use archive library and specify the autoarchive
library.
Location and name of the Encyclopedia volume
archive driver. The default location for the library
is the Actuate iServer bin directory:
$AC_SERVER_HOME/bin

E-mail notification Name of the partition that contains the e-mail

template partition message template file, acnotification.xml. The
default location is the etc directory for Actuate
iServer. If you specify a different partition, you
must copy acnotification.xml to the partition.
When Actuate iServer System sends an e-mail
notice, it uses an e-mail message template to
create the e-mail. If Actuate iServer System sends
e-mail notices from multiple Actuate iServer
nodes, the nodes can use a single template if the
template is in a partition that all Actuate iServer
nodes can access.
For information about the Actuate e-mail notice
template, see “Customizing the e-mail notice” in
Chapter 2, “Setting up Actuate iServer System
hardware.”
Use Active Portal for If selected, hypertext links in report-completion
JSP for e-mail messages from Actuate iServer use Actuate
notifications Active Portal for JSP.
Active Portal for JSP URL prefix to add to the hypertext link in an e-
URL prefix mail when using Actuate Active Portal for JSP.
For information about the URL prefix, see
“Setting the URL prefix for e-mail notification” in
Chapter 2, “Setting up Actuate iServer System
hardware.”
Use Active Portal for If selected, hypertext links in report-completion
.NET for e-mail messages from Actuate iServer use Actuate
notifications Active Portal for .NET.

350 Administering Actuate iSer ver System

 Parameter Description
Active Portal for .NET URL prefix to add to the hypertext link in an e-
URL prefix mail when using Actuate Active Portal for JSP.
For information about the URL prefix, see
“Setting the URL prefix for e-mail notification” in
Chapter 2, “Setting up Actuate iServer System
hardware.”
Use ReportCast for e- If selected, hypertext links in report-completion
mail notifications messages from Actuate iServer use Actuate
ReportCast.
ReportCast URL prefix URL prefix to add to the hypertext link in an e-
mail when using Actuate ReportCast. For
information about the URL prefix, see “Setting
the URL prefix for e-mail notification” in Chapter
2, “Setting up Actuate iServer System hardware.”
Is Sample App. Volume If the value for this parameter is true, the
Encyclopedia volume is an Actuate sample
application volume. For more information, see
“Adding and configuring an Encyclopedia
volume,” earlier in this chapter.

How to modify Actuate iServer’s general parameter values for an

Encyclopedia volume
1 From the side menu in the System Administration console, choose
System Volumes.
Volumes appears.
2 Hover the pointer over the arrow icon for a volume and choose Properties.
Volumes—Properties—General appears.
3 Modify the parameters as necessary. Choose OK.

Changing which Actuate iServer machine owns an

Encyclopedia volume
Before you complete the following procedure, you must put the Encyclopedia
volume offline. After you complete the procedure, take the Encyclopedia
volume online again. For information about putting an Encyclopedia volume
offline or taking an Encyclopedia online, see “Taking an Encyclopedia volume
online or putting an Encyclopedia volume offline,” earlier in this chapter.

Chapter 9, Working with an Actuate iSer ver System volume 351

 How to change the owner of an Encyclopedia volume
1 From the side menu in the System Administration console, choose
System Volumes.
Volumes appears.
2 Put the Encyclopedia volume offline. For information about putting an
Encyclopedia volume offline, see “Taking an Encyclopedia volume online
or putting an Encyclopedia volume offline,” earlier in this chapter.
3 Hover the pointer over the arrow icon for the volume and choose
Properties.
Volumes—Properties—General appears.
4 Choose Server Assignments.
Volumes—Properties—Server Assignments appears.
5 In Primary owner, select an Actuate iServer node to be the volume’s owner.

Choose OK.
Volumes appears, displaying the new volume owner.

352 Administering Actuate iSer ver System

 6 Take the Encyclopedia volume online. For information about taking an
Encyclopedia volume online, see “Taking an Encyclopedia volume online
or putting an Encyclopedia volume offline,” earlier in this chapter.

Failing over an Encyclopedia volume

In an Actuate iServer cluster, you can specify an Actuate iServer node to
manage an Encyclopedia volume if the primary Actuate iServer node that
manages the volume becomes unavailable.
The Actuate iServer System cluster master performs an Encyclopedia volume
failover under the following conditions:
■ An encycsrvr7 process fails for an Actuate iServer node that manages an
Encyclopedia volume.
■ An encycsrvr7 process cannot send heartbeat messages for an Actuate
iServer node that manages a volume.
■ An encycsrvr7 process for an Actuate iServer node that manages a volume
loses its connection to the file system that contains the volume files. For
example, the Actuate iServer node cannot access the network or a network
failure occurs between the Actuate iServer node that manages a volume
and a remote disk that contains the volume files.
When the Actuate iServer cluster master detects missing heartbeat messages
from an encycsrvr7 process for an Actuate iServer node that manages an
Encyclopedia volume, the cluster master assumes that the process failed. If the
Encyclopedia volume has a backup server, the cluster master starts
Encyclopedia volume failover.
If the encycsrvr7 process that manages an Encyclopedia volume loses its
connection to a file system that contains the volume’s files, the encycsrvr7
process shuts down. Then, the Actuate iServer cluster master starts an
Encyclopedia volume failover.
During an Encyclopedia volume failover, the encycsrvr7 process does not have
to be running on the backup Actuate iServer node. If the backup Actuate
iServer node’s Process Management Daemon (PMD) is running, the cluster
master node can start the encycsrvr7 process on the backup Actuate iServer
node.
After an Encyclopedia volume failover occurs, jobs currently running in an
Encyclopedia volume continue to run. If a job completes before the
Encyclopedia volume is online, Actuate iServer registers job completion
information after the volume is online. If a job completes after failover, Actuate
iServer process job completion information in the normal manner.

Chapter 9, Working with an Actuate iSer ver System volume 353

 The following sections provide information about setting up Encyclopedia
volume failover.
For information about other types of failover that Actuate iServer System
supports, see “About the Actuate iServer cluster configuration file” in Chapter
5, “Actuate iServer System administration overview.”

About Encyclopedia volume failover

From the System Administration console, you can use either of the following
methods to set up a backup server for an Encyclopedia volume:
■ To specify which Actuate iServer node an Encyclopedia volume uses if its
primary Actuate iServer node fails, use Volumes—Properties—Server
Assignments. For information about using Volumes—Properties—Server
Assignments, see “Assigning a backup server to an Encyclopedia volume,”
later in this chapter.
■ To specify the Encyclopedia volume or volumes for which an Actuate
iServer node is a backup server, use Server—Properties—Failover Volumes.
For information about Server—Properties—Failover Volumes, see
“Assigning backup responsibility for an Encyclopedia volume to an
Actuate iServer node” in Chapter 7, “Working with an Actuate iServer
System server.”
Changes that you make in one of the locations in the preceding list affect the
parameter values that appear in both locations.
After you assign one or more backup servers to an Encyclopedia volume, you
can perform an administrative failover of the volume. For information about
performing an administrative failover, see “Performing an administrative
failover of an Encyclopedia volume,” later in this chapter.

Assigning a backup server to an Encyclopedia

volume
After you add an Encyclopedia volume to an Actuate iServer cluster, you can
assign one or more Actuate iServer nodes as backup servers for the volume. In
an Actuate iServer System cluster, a backup server assumes control of an
Encyclopedia volume if the volume’s primary Actuate iServer node fails. You
assign backup servers to an Encyclopedia volume on Volumes—Properties—
Server Assignments.

354 Administering Actuate iSer ver System

On Volumes—Properties—Server Assignments, an Actuate iServer System
administrator can access the following functionality:
■ Use the left and right arrows to move Actuate iServer nodes between
Available servers and Assigned backup servers. The servers that appear in
Assigned backup servers are the Actuate iServer nodes that have backup
responsibilities for the Encyclopedia volume.
■ Use the up and down arrows to change the order of the Actuate iServer
nodes in the Assigned backup servers list.
The following table describes the parameter values that appear on Volumes—
Properties—Server Assignments.

Parameter Description
Primary owner Actuate iServer machine that is the primary
server for the Encyclopedia volume.
Buffer pool size Buffer pool size, in megabytes (MB). The default
value is 10MB.

Chapter 9, Working with an Actuate iSer ver System volume 355

 An assigned Actuate iServer node is either primary or backup. The primary
node is the node that runs the Encyclopedia service for the volume. A backup
node runs the Encyclopedia service for the volume if the primary node fails.
For information about primary and backup Encyclopedia volume parameters
for Actuate iServer, see “Specifying the buffer pool size for an Encyclopedia
volume” in Chapter 7, “Working with an Actuate iServer System server,” and
“Assigning backup responsibility for an Encyclopedia volume to an Actuate
iServer node” in Chapter 7, “Working with an Actuate iServer System server.”

How to assign a backup server to an Encyclopedia volume

1 From the side menu in the System Administration console, choose
System Volumes.
Volumes appears.
2 Hover the pointer over the arrow icon for the Encyclopedia volume and
choose Properties.
Volumes—Properties—General appears.
3 Choose Server Assignments.
Volumes—Properties—Server Assignments appears.
4 Assign one or more backup servers for the Encyclopedia volume. Choose
OK.

Performing an administrative failover of an

Encyclopedia volume
After you configure one or more backup Actuate iServer nodes for an
Encyclopedia volume, you can force an administrative failover of the volume.
An Actuate iServer node that you specify takes over management of the
Encyclopedia volume when you perform an administrative failover. Before
you perform an administrative failover, you must assign a backup server to
the Encyclopedia volume.

356 Administering Actuate iSer ver System

The following table describes the parameters that appear on Volumes—
Administrative fail over.

Parameter Description
Server to fail over to List of Actuate iServer nodes that are backup
servers for the Encyclopedia volume. For
information about specifying a backup server for
an Encyclopedia volume, see “Assigning a
backup server to an Encyclopedia volume,”
earlier in this chapter.
Grace period Time, in seconds, before control of the
Encyclopedia volume changes to the
Encyclopedia service on the specified failover
Actuate iServer node.

How to perform an administrative failover of an Encyclopedia

volume
1 From the side menu of the System Administration console, choose System
Volumes.
Volumes appears.
2 Hover the pointer over the arrow icon for an Encyclopedia volume and
choose Administrative fail over.

Volumes—Administrative fail over appears.

Chapter 9, Working with an Actuate iSer ver System volume 357

 3 Perform the administrative failover:
■ In Select server to fail over to, select which backup Actuate iServer node
to use.
■ If necessary, specify a grace period.
Choose Fail Over.

Working with Actuate Open Security

As an administrator, you can enable or disable open security functionality and
specify open security parameter values on Volumes—Properties—Open
Security.

358 Administering Actuate iSer ver System

On Volumes—Properties—Open Security, an Actuate iServer System
administrator can access the following functionality:
■ Enable or disable open security functionality for an Encyclopedia volume.
A volume can use an RSSE application uses either the SOAP-based
interface or the C- based interface.
■ Change open security parameter values for an Encyclopedia volume that
uses open security.
For information about the Open Security application that ships with Actuate
iServer, see “Working with the Actuate iServer security applications,” in
Chapter 4, “Configuring Actuate iServer security.”

Chapter 9, Working with an Actuate iSer ver System volume 359

 The following table describes the general and RSSE parameters that appear on
Volumes—Properties—Open Security.

Parameter Description
Do not enable If selected, open security and the RSSE
application are disabled.
Enable as web service If selected, the RSSE application runs as a web
service on a web server. The application uses the
SOAP-based RSSE interface.
Enable as library If selected, the RSSE application is a C-callable
shared library on a UNIX server or a C-callable
library DLL on a Windows server. The
application uses the C- based RSSE interface.
RSSE cache timeout Maximum time, in minutes, before Actuate
iServer deletes cached open security data. The
minimum cache time-out period is 1 minute.
Used with either the SOAP-based or C-based
RSSE application.

The following table describes the parameters that become available when you
choose Enable as web service.

Property Description
Open security IP IP address or machine name of the server that
address runs the RSSE web service.
Open security port Port number to use to communicate with the
RSSE web service, if required.
Context string Context string that specifies the location of the
RSSE web service.

The following table describes the parameters that become available when you
choose Enable as library.

Parameter Description
RSSE library name Path and name of the open security library. The
default location is Actuate iServer’s bin directory,
$AC_SERVER_HOME/bin.

360 Administering Actuate iSer ver System

Parameter Description
RSSE max ACL buffer Maximum length of an access control list (ACL)
size that passes between the open security library and
the Encyclopedia service.
RSSE multithread safe If selected, the open security library is
multithread-safe. By default, the application is
not multithread-safe. The application serializes
all calls to get a user’s ACL. To turn off
serialization, enable this parameter.

How to enable open security functionality for Actuate iServer

1 From the side menu of the System Administration console, choose System
Volumes.
Volumes appears.
2 Hover the pointer over the arrow icon for an Encyclopedia volume and
choose Properties.
Volumes—Properties—General appears.
3 Choose Open Security.
Volumes—Properties—Open Security appears.
4 Enable the RSSE application as either a web service or library.
5 Specify parameter values for open security. Choose OK.

Chapter 9, Working with an Actuate iSer ver System volume 361

Assigning a partition to an Encyclopedia volume
As an administrator, you can view and modify the partition assignment of an
Encyclopedia volume on Volumes—Properties—Partitions.

On Volumes—Properties—Partitions, an Actuate iServer System administrator

can access the following functionality:
■ Use the left and right arrows to move Actuate iServer partition names
between Available partitions and Selected partitions. Available partitions
lists the partitions that are available for use by an Encyclopedia volume.
Selected partitions lists the partitions the Encyclopedia volume uses.
■ Use the up and down arrows to change the order of the Actuate iServer
partitions in Selected partitions. The word Primary indicates which of the
selected partitions is the Encyclopedia volume’s primary partition. The
word Active indicates which of the selected partitions are actively in use.
■ Select a partition in Selected partitions and choose Start or Stop to change
the status of a partition:

362 Administering Actuate iSer ver System

 ■ Choosing Start activates an inactive partition. You must activate a
partition before Actuate iServer System can use the partition for an
Encyclopedia volume.
■ Choosing Stop changes the status of a partition to Phasing out or Not in
use. When a partition is stopped, Actuate iServer cannot use the
partition.
■ Select a partition in Selected partitions and specify free disk space
parameters.
The following table describes the parameter values that appear on Volumes—
Properties—Partitions.

Parameter Description
Low Free Space Amount of free space, in megabytes (MB), below
which Actuate iServer displays a warning
message. If a user tries to create a file in a
partition with less than the specified low amount
of free disk space, file creation succeeds, and
Actuate iServer displays a warning message. The
default value is 512MB.
Min Free Space Minimum amount, in megabytes (MB), of free
space that the Encyclopedia volume partition
must maintain. If a user tries to create a file that
would put the partition under its minimum free
space limit, Actuate iServer does not create the
file. The default value is 128MB.

For information about setting up a partition, see Chapter 8, “Working with an

Actuate iServer System partition.” For information about resource groups, see
Chapter 10, “Adding and configuring an Actuate iServer System resource
group.”

Working with advanced Encyclopedia volume

parameters
You can use Volumes—Properties—Advanced to change or supply values for
many Actuate iServer System parameters. or more information about
specifying advanced parameter values, see “Changing advanced Actuate

Chapter 9, Working with an Actuate iSer ver System volume 363

 iServer System settings” in Chapter 5, “Actuate iServer System administration
overview.”

On Volumes—Properties—Advanced, an Actuate iServer System

administrator can access the following functionality:
■ Choose Printable summary to view a printable list of Encyclopedia volume
parameters and their values.
■ Choose a subset of parameters from the Properties settings list. The
following advanced Encyclopedia volume property categories appear on
Volumes—Properties—Advanced:
■ Archiving and purging. For more information, see “Setting expiration
times for Encyclopedia volume items,” later in this chapter.
■ Notification. For more information, see “Specifying the server URL
parameter value for e-mail notices,” later in this chapter.
■ Security Extension. For more information, see “Specifying RSSE service
startup and failover,” later in this chapter.
■ Actuate Report Server API (RSAPI). For more information, see
“Specifying how many items an RSAPI request returns,” later in this
chapter.
■ Asynchronous Reports. For more information, see “Retrying failed
asynchronous jobs,” later in this chapter.
■ Actuate Query Generation. For more information, see “Specifying the
default Actuate Query template file,” later in this chapter.

364 Administering Actuate iSer ver System

For more information about Actuate iServer parameters, see Chapter 14,
“Setting Actuate iServer parameters.”

Setting expiration times for Encyclopedia volume

items
On Volumes—Properties—Advanced—Archiving and Purging, an Actuate
iServer System administrator can specify expiration times for Encyclopedia
volume items.

The following table describes the parameters that appear on Volumes—

Properties—Advanced—Archiving and Purging.

Parameter Description
Default expiration time Default time, in minutes, to keep notices of failed
of failure notices jobs. Users can set their Job property to use this
value. The default value is 0. With the default
value, the notices never expire.
If a user specifies 0 for failure notice expiration,
Actuate iServer uses the value of this parameter.
Takes effect immediately.
Default expiration time Default time, in minutes, to keep notices about
of success notices jobs that complete successfully. Users can set
their Job property to use this value. The default
value is 0. With the default value, the notices
never expire.
If a user specifies 0 for success notice expiration,
Actuate iServer uses the value from the value of
this parameter.
Takes effect immediately.

Chapter 9, Working with an Actuate iSer ver System volume 365

 Parameter Description
Expiration time of failed Time, in minutes, to save a failed job entry on
jobs Jobs—Completed for an Encyclopedia volume.
Actuate iServer purges failed job entries during
the job purge time when Actuate iServer does not
find an associated notice in an Encyclopedia
volume channel and the age of the job entry
exceeds the value of this parameter. A notified
user's purge settings for notices also affect a job
entry’s lifetime. The default value is 43200
minutes (30 days). The minimum value is 0.
Purging notices reduces the size of the
Encyclopedia volume and contributes to better
Actuate iServer performance. Choose the
smallest value that satisfies job retention policies.
Takes effect immediately.
Expiration time of Time, in minutes, to save a success job entry on
Success Job Jobs—Completed for an Encyclopedia volume.
Actuate iServer purges entries about successful
jobs during the job purge time when Actuate
iServer does not find an associated notice in an
Encyclopedia volume channel and the age of the
job entry exceeds the value of this parameter. The
default value is 43200 minutes (30 days). The
minimum value is 0.
Purging notices reduces the size of the
Encyclopedia volume and contributes to better
Actuate iServer performance.
Purging notices reduces the size of the
Encyclopedia volume and contributes to better
Actuate iServer performance. Choose the
smallest value that satisfies job retention policies.
Takes effect immediately.

Specifying the server URL parameter value for e-

mail notices
On Volumes—Properties—Advanced—Notification, an Actuate iServer
System administrator can specify the value of the server URL parameter for
notices that Actuate iServer sends to users and channels.

366 Administering Actuate iSer ver System

The following table describes the parameter that appears on Volumes—
Properties—Advanced—Notification.

Parameter Description
MDS URL in e-mail Value to use for the serverURL parameter in a
hyperlink to report hyperlink in an e-mail notification message that
Actuate iServer sends. The default value is no
value. With the default value, Actuate iServer
uses any Actuate iServer node in the cluster that
is online and on which the Message Distribution
service is enabled.
An Actuate iServer e-mail notification can
contain a hyperlink to a document in an
Encyclopedia volume, for example:
http://machine1:8700/acweb/newrequest/
index.aspx?__requestType=scheduled&__execu
tableName=/
forecast.rox%3B1&serverURL=http://
end2243:8000&volume=volume1

This parameter value determines the value of the

serverURL parameter in the URL. In the
example, the serverURL parameter and value
are:
serverURL=http://end2243:8000

Include the http:// prefix when you specify a

value for this parameter, such as
http://new-server:8400.
Takes effect immediately.

Specifying RSSE service startup and failover

On Volumes—Properties—Advanced—Security Extension—Service, an
Actuate iServer System administrator can enable volume failover when an
RSSE application fails and supply the operating system shell command that
Actuate iServer System uses to start the RSSE service.

Chapter 9, Working with an Actuate iSer ver System volume 367

 The following table describes the parameter that appears on Volumes—
Properties—Advanced—Security Extension—Service.

Parameter Description
Enable volume failover Enables Actuate iServer Encyclopedia volume
when RSSE fails failover when the volume is using an RSSE
application. Default is true.
If set to true and Actuate iServer managing the
volume cannot connect to the web service for the
RSSE service, Actuate iServer starts the
Encyclopedia volume failover process. Volume
must be configured for failover.
Takes effect at volume restart.Related
parameters:
EnableRSSEService
Command line to Command that Actuate iServer issues to start the
control initiation for web service for RSSE, if the RSSE service is not
RSSE service running. If Actuate iServer cannot connect to the
web service for the RSSE service, Actuate iServer
starts an operating system shell and runs the
value of this parameter as a command line
request.
Takes effect at volume restart.

Specifying how many items an RSAPI request

returns
On Volumes—Properties—Advanced—RSAPI—Fetch Limits, an Actuate
iServer System administrator can supply limits for the number of items that an
Actuate Report Server API request returns.

368 Administering Actuate iSer ver System

The following table describes the parameter that appears on Volumes—
Properties—Advanced—RSAPI—Fetch Limits.

Parameter Description
Maximum number of Maximum number of items that Actuate iServer
elements that can be returns in a list. Specify a value for this parameter
returned in one RSAPI if you use RSAPI applications. Actuate iServer
request truncates the list if a RSAPI call returns a list that
contains more elements than the value of this
parameter. The default value is 5000. Actuate
recommends that you use the default value. The
minimum value is 0.
Actuate recommends using incremental fetch
features to retrieve large lists. Increase the value
to the size of the longest list that Actuate iServer
sends, if you cannot use incremental fetch
features.
When Actuate iServer encounters performance
problems, such as excessive memory usage by a
RSAPI application that frequently retrieves large
lists, decrease the value of this parameter to
improve performance. Decreasing the value of
this parameter can cause the RSAPI application
to function incorrectly.
Takes effect at volume restart.

Retrying failed asynchronous jobs

On Volumes—Properties—Advanced—Asynchronous Reports—
Asynchronous Job Retries, an Actuate iServer System administrator can
specify how to retry a failed asynchronous job.

Chapter 9, Working with an Actuate iSer ver System volume 369

 The following table describes the parameter that appears on Volumes—
Properties—Advanced—Asynchronous Reports—Asynchronous Job Retries.

Parameter Description
Number of times to retry Number of times to retry failed generation or
failed requests print requests. Range is from 0 to 30. Default
value is 0.
Takes effect immediately.
Time after which to retry Time after which to retry failed asynchronous
failed request requests (Seconds). Range is from 0 32767.
Default value is 0.
Takes effect immediately.

Specifying the default Actuate Query template file

On Volumes—Properties—Advanced—Actuate Query Generation, an Actuate
iServer System administrator can specify the path to the default Actuate
Query template to apply to Actuate Query output.
The following table describes the parameter that appears on Volumes—
Properties—Advanced—Actuate Query.

Parameter Description
Volume default Actuate Full path and name of an existing Actuate Query
Query template file Template in the Encyclopedia volume. Actuate
iServer uses an Actuate Query Template file to
format Actuate Query output. Actuate iServer
uses the default template file to format output
when a user runs an Actuate Query using an
information object that does not specify a
template file.
If you do not specify a version number for the
template, and multiple versions exist, Actuate
iServer uses the latest version of the file. The
following example specifies version 2 of a file
called Aqtemplate1.dox:
/myAQTemplate/Aqtemplate1.dox;2

If the value of this parameter is missing, empty,

or invalid, Actuate iServer uses the template file
that installs with the Encyclopedia volume.
Takes effect immediately.

370 Administering Actuate iSer ver System

Restoring an Encyclopedia volume snapshot
Use an Encyclopedia volume snapshot to restore a consistent, usable version
of an Encyclopedia volume. For information about backing up a Report
Encyclopedia volume and creating a snapshot, see “Backing up the
Encyclopedia volume” in Chapter 20, “Archiving files and backing up an
Encyclopedia volume.”
Before you restore the Encyclopedia volume, you must complete the following
tasks:
■ Recover the Encyclopedia volume snapshot from the backup media. For
more information, see the documentation for your backup device.
■ Back up the current Encyclopedia volume before restoring the snapshot, if
needed. For more information, see “Backing up the Encyclopedia volume”
in Chapter 20, “Archiving files and backing up an Encyclopedia volume.”
■ Set up the environment to match the environment as it is in the snapshot.
For example, create secondary partitions for the Encyclopedia volume
snapshot, if the original volume uses multiple partitions. The partition
names for the volume must match the names of the original volume‘s
partitions.
When you restore a snapshot of an Encyclopedia volume:
■ Use the same release level of Actuate iServer and the Encyclopedia volume
snapshot. For example, if the Actuate iServer System Release 7 Service
Pack 1 creates the snapshot, you must use Actuate iServer System Release 7
Service Pack 1 to restore Encyclopedia volume using the snapshot.
■ Restore the Encyclopedia volume. You cannot restore a portion of the
snapshot.
■ Remove the Encyclopedia volume’s translog directory before you take the
volume online.
For information about the Encyclopedia volume directory structure, see
“About Encyclopedia volume directory structure” in Chapter 5, “Actuate
iServer System administration overview.”
To check the consistency of a restored Encyclopedia volume, Actuate
recommends using Actuate’s acverify utility with the –check restore option.
For information about acverify, see “Using acverify” in Chapter 13, “Working
with Actuate iServer utilities.”

Chapter 9, Working with an Actuate iSer ver System volume 371

 How to restore an Encyclopedia volume
To restore an encyclopedia, complete the following tasks in this order:
■ Put the volume offline. For more information, see “Taking an Encyclopedia
volume online or putting an Encyclopedia volume offline,” earlier in this
chapter.
■ Back up the existing Encyclopedia volume, if needed. For more
information, see “Backing up the Encyclopedia volume” in Chapter 20,
“Archiving files and backing up an Encyclopedia volume.”
■ Delete the existing Encyclopedia volume’s directories and files.
■ Copy the Encyclopedia volume snapshot data to the Encyclopedia
volume’s primary partition. If applicable, also copy the data to the
Encyclopedia volume’s secondary partitions.
■ Delete the Encyclopedia volume’s translog directory, if it exists.
■ Take the volume online. For information, see “Taking an Encyclopedia
volume online or putting an Encyclopedia volume offline,” earlier in this
chapter.

Moving an Encyclopedia volume

To move an Encyclopedia volume, you must move the partitions that the
volume uses. The partitions that an Encyclopedia volume uses contain the
volume’s files. Volumes—Properties—Partitions lists the partitions that an
Encyclopedia volume uses.

372 Administering Actuate iSer ver System

For information about the Encyclopedia volume directory structure, see
“About Encyclopedia volume directory structure” in Chapter 5, “Actuate
iServer System administration overview.”
As an Actuate iServer System administrator, you can also use the acexport and
acimport utilities to move data between Encyclopedia volumes. For
information about acexport, see “Using acexport” in Chapter 13, “Working
with Actuate iServer utilities.” For information about acimport, see “Using
acimport” in Chapter 13, “Working with Actuate iServer utilities.”

How to move an Encyclopedia volume

1 Set up one or more partitions, if necessary. For information, see “Adding a
partition” in Chapter 8, “Working with an Actuate iServer System
partition.”
2 Put the volume offline. For information, see “Taking an Encyclopedia
volume online or putting an Encyclopedia volume offline,” earlier in this
chapter.
3 For each partition the volume uses, copy the Encyclopedia volume files
from the old partition to the new partition. In a cluster, all Actuate iServer
machines in the cluster must be able to access the partition locations. For

Chapter 9, Working with an Actuate iSer ver System volume 373

 more information about specifying a path from Actuate iServer to a
partition, see “Designating partition space for Actuate iServer” in Chapter
7, “Working with an Actuate iServer System server.”
4 For each partition, change the partition location on Partitions—Server
Settings to ensure the proper mapping of the locations. For example,
Actuate iServer uses two partitions, partition_1 in \old\dir1 and
partition_2 in \old\dir2. If you move \old\dir1 to \new\dir1 and \old
\dir2 to \new\dir2, you must specify the following partition locations:
■ partition_1 in \new\dir1
■ partition_2 in \new\dir2
5 Change other Actuate iServer properties, if necessary. For more
information, see Chapter 7, “Working with an Actuate iServer System
server.”
6 Take the volume online. For information, see “Taking an Encyclopedia
volume online or putting an Encyclopedia volume offline,” earlier in this
chapter.

Removing an Encyclopedia volume from Actuate

iServer System
When you remove an Encyclopedia volume from Actuate iServer System:
■ Encyclopedia volume users no longer see the volume in the list of volumes
available to Actuate iServer or an Actuate iServer cluster.
■ Encyclopedia volume users cannot log in to the Encyclopedia volume.
■ Actuate iServer rejects requests to access the content of the Encyclopedia
volume.
■ The volume no longer appears in Actuate iServer System’s configuration
file.
■ Actuate iServer changes an Encyclopedia volume’s resource group volume
assignment to All volumes and disables the resource group.
Deleting an Encyclopedia volume does not delete the partitions assigned to
the volume. For information about deleting the associated partitions, see
“Removing an Actuate iServer System partition” in Chapter 8, “Working with
an Actuate iServer System partition.” You can also manually delete the
partition from the Actuate iServer machine’s file system.

374 Administering Actuate iSer ver System

How to remove an Encyclopedia volume from Actuate iServer
System
To completely remove an Encyclopedia volume from Actuate iServer System,
complete the following tasks:
1 Before removing an Encyclopedia volume from Actuate iServer System,
record which partitions the volume uses:
1 From the side menu in the System Administration console, choose
System Volumes.
Volumes appears.
2 From the drop-down list for the volume to remove, choose Properties.
Volumes—Properties—General appears.
3 Choose Partitions.
Volume—Properties—Partitions appears.
4 Record the list of partitions that appears in Selected partitions.
From the side menu, choose System Volumes.
2 From the drop-down list for the volume to remove, choose Put offline.
The volume’s status changes to Offline.
3 On Volumes, hover the pointer over the arrow icon for an Encyclopedia
volume to display the volume’s drop-down list.
4 Choose Remove from system.

A confirmation dialog box appears.

5 To delete the Encyclopedia volume from the Actuate iServer machine,
choose OK.

Chapter 9, Working with an Actuate iSer ver System volume 375

376 Administering Actuate iSer ver System
 Chapter

Adding and configuring

Chapter 10
10
an Actuate iServer System
resource group
This chapter contains the following topics:
■ About resource groups
■ Using the resource group list
■ Adding a resource group
■ Viewing or modifying general resource group parameters
■ Viewing or modifying resource group server assignments
■ Stopping a resource group from running jobs

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 377
About resource groups
In an Actuate iServer cluster, any Actuate iServer node with the Factory
service enabled can start a Factory process and run a job. An Actuate iServer
cluster distributes job requests within the cluster to Actuate iServer nodes that
have the Factory service enabled. When an Actuate iServer node receives a job
request, it runs the job using a Factory process.
To control how an Actuate iServer uses Factory processes, you can create and
manage resource groups. A resource group controls the Factory processes that
Actuate iServer System uses to run a synchronous or asynchronous job that
creates or prints report output. A resource group reserves a set of Actuate
iServer Factory processes for executing only a particular group’s jobs.
A Factory process assigned to a resource group stays idle until Actuate iServer
System routes a job to the resource group. Actuate iServer starts a new Factory
process for a resource group when Actuate iServer System routes a job to the
resource group and no idle Factory processes are available to the resource
group.
In a cluster, Actuate iServer System uses load-balancing mechanisms to
distribute report jobs among the Actuate iServer nodes. The load-balancing
mechanisms attempt to maximize Actuate iServer System performance.
Creating custom resource groups restricts the ability of Actuate iServer to
maximize performance and can adversely affect the report-generation
performance for a cluster.
If an Actuate iServer node is a member of a resource group and is not
configured to run all the report executable types that Actuate iServer sends to
that group, reports can fail. For example, if a report executable file requires
access to a database, and the database driver is not installed on a resource
group node, the report fails if a Factory process on that node runs the report.
If you submit a report job using a resource group, and there is no Actuate
iServer node in the resource group that can run that report executable file type,
Actuate iServer places the job in the Encyclopedia volume’s pending job
queue. The job is listed in the volume’s Jobs—Pending. Actuate iServer runs
the job when a Factory that can run the job becomes available. For example, if
you use a resource group to run a third-party report executable file, but you
have not configured an Actuate iServer node in the resource group to run that
report executable file type, the report stays in the Encyclopedia volume
pending job queue until you configure the Actuate iServer node to run the
executable file.
Using Actuate Information Delivery API (IDAPI) to direct jobs to a specific
resource group bypasses the Actuate iServer cluster’s load-balancing
mechanisms. As a result, applications that use IDAPI to run reports can
adversely affect the performance of the cluster. For more information about

378 Administering Actuate iSer ver System

 using Actuate IDAPI with resource groups, see “About resource groups and
IDAPI,” later in this chapter.

About the types of resource groups

You can create a resource group to run reports synchronously or
asynchronously. You cannot change the type of a resource group after you
create it. For information about the default resource groups that Actuate
iServer creates, see “About the default resource groups,” later in this chapter.
For information about creating a resource group, see “Adding a resource
group,” later in this chapter.

About asynchronous resource groups

You can assign an asynchronous resource group to a specific Encyclopedia
volume or to all Encyclopedia volumes in an Actuate iServer cluster. When
you assign an asynchronous resource group to an Encyclopedia volume, you
allocate the number of Factory processes a volume’s users can access and
specify the Actuate iServer nodes running the Factory processes.
An asynchronous resource group has a priority range setting. The resource
group handles jobs within its priority range unless an Encyclopedia volume
administrator specifies the resource group when submitting the job.
When a user runs an asynchronous job in an Encyclopedia volume with
multiple asynchronous resource groups:
■ If no resource group matches the priority of the job, the job’s status is
pending until you change a resource group’s priority range to run the job.
■ If the only available resource group is disabled, Actuate iServer sets the
job’s status to pending until you enable an asynchronous resource group
for the Encyclopedia volume. When you make a resource group available,
Actuate iServer sends the job to the resource group.
■ If multiple resource groups match the priority of a job, Actuate iServer
chooses a resource group with an available Factory process.
If you specify a resource group to run a scheduled job and delete the resource
group before the job runs, the job is in a pending state when Actuate iServer
attempts to run it. You can delete the job on Jobs—Pending.

About synchronous resource groups

You can assign a synchronous resource group to an Encyclopedia volume or
all the Encyclopedia volumes in an Actuate iServer cluster. When you assign a
synchronous resource group to an Encyclopedia volume, you allocate the
number of Factory processes an Encyclopedia volume’s users can access and
specify the Actuate iServer nodes running the Factory processes.

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 379
 If you assign multiple resource groups to an Encyclopedia volume and run a
synchronous job without specifying a resource group, Actuate iServer selects a
synchronous resource group based on the job’s file type and the Actuate
iServer cluster load-balancing considerations. If Actuate iServer cannot find an
available synchronous resource group, the job fails and Actuate iServer returns
an error.
Two uses of synchronous resource groups are:
■ Creating a synchronous resource group for information objects
■ Sharing resources between business units
If you run a job and specify a synchronous resource group and the
synchronous resource group is disabled, the job fails and Actuate iServer
returns an error.

About the default resource groups

Actuate iServer System creates three default resource groups. You cannot
remove the default resource groups. You also cannot change their
Encyclopedia volume settings. The following list describes the default
resource groups:
■ Default Async is the default resource group for asynchronous jobs. This
resource group does not run synchronous jobs, not even when there is no
pending asynchronous job assigned to the resource group. For more
information about asynchronous resource groups, see “About
asynchronous resource groups,” later in this chapter.
■ Default Sync is the default resource group for synchronous jobs. For
information about synchronous resource groups, see “About synchronous
resource groups,” later in this chapter.
■ Information Object Web Services is a special resource group for
synchronous jobs to view information object (.dox) files. Actuate iServer
System uses the Information Object Web Services resource group when
Actuate iServer uses web services to access an information object as the
data source for a report. The report that uses the information object as a
data source sends a request to Actuate iServer to run a DOX and specifies
this resource group.
When you submit a request that uses data from a DOX, Actuate iServer uses
the same Actuate iServer node to run the DOX and use the data from the DOX.
A Factory process from either an asynchronous resource group or an
Information Object Web Services resource group can use data from an
information object. You must enable the View service on any Actuate iServer
node where a Factory process uses data from an information object.

380 Administering Actuate iSer ver System

 By default, Actuate iServer assigns two Factory processes to each default
resource group during Actuate iServer installation. Actuate iServer uses the
existing Factory information when upgrading an Actuate iServer. For
information about how Actuate iServer System manages resource groups
when you upgrade Actuate iServer, see “About upgrading Actuate iServer
and resource groups,” later in this chapter.

About resource groups and IDAPI

Actuate iServer System supports working with resource groups using Actuate
Information Delivery API (IDAPI). Using IDAPI, you can:
■ Send a job directly to a resource group, bypassing the priority settings for
asynchronous jobs and the Encyclopedia volume settings for synchronous
jobs.
■ Change the resource group configuration. For example, you can enable or
disable resource group membership or change the number of Factory
processes in a resource group.
For information about Actuate IDAPI, see Programming with Actuate iServer
APIs, which comes with the Actuate iServer Integration Technology product.

About Actuate iServer failover when using a

resource group
Actuate iServer does not reassign resource groups when it performs a failover.
You must configure resource groups to handle jobs if the Actuate iServer
configuration changes as a result of a failover.
For example, for a resource group to continue to work after an Actuate iServer
failover, you must configure at least two Actuate iServer nodes as active
members of the resource group. If a node that runs Factory processes for a
resource group fails, the remaining nodes continue receiving jobs for that
resource group. When the Actuate iServer node comes back online, Actuate
iServer System sends the jobs to that node.
If an Actuate iServer node that manages an Encyclopedia volume fails, and
Actuate iServer System assigns the Encyclopedia volume to a resource group,
the failure affects the resource group only if the Actuate iServer node that
manages the volume also supports Factory processes for that resource group.
If you create a resource group to serialize jobs, which is a resource group that
you configure to run one Factory process on one Actuate iServer node, the jobs
cannot run if the node fails. When the Actuate iServer node is back online or
you change the resource group settings to use another node, the jobs run. The
same thing happens if all Actuate iServer nodes that run Factory processes for
a particular resource group go down.

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 381
 About upgrading Actuate iServer and resource
groups
When you upgrade Actuate iServer System, Actuate iServer creates a resource
group on an Actuate iServer node that has the Factory service and the View
service enabled. If no node has the Factory service and the View Service
enabled, Actuate iServer creates resource groups with zero Factory processes.

Migrating from Actuate iServer System Release 6 or

Release 7
When you upgrade an Encyclopedia volume from Actuate iServer Release 6 or
Release 7, Actuate iServer adds resource group information to the Actuate
iServer node that manages the Encyclopedia volume. In a stand-alone
configuration, upgrading Actuate iServer adds the default resource groups.
After migration, Actuate iServer uses the following Factory settings:
■ The Number of Reserved Factories for Synchronous Jobs value becomes the
Max Factories value for the default synchronous resource group.
■ The difference between the Max Factory Processes value and the Number
of Reserved Factories for Synchronous Jobs value becomes the Max
Factories value for the default asynchronous resource group.
■ The Max Factories value for the Information Object Web Services resource
group is the default value, 2.
The default setting for an asynchronous resource group does not enable an
asynchronous Factory process to run a synchronous job. In previous releases,
the default asynchronous Factory process setting supported an available
asynchronous Factory process running a synchronous job.

Migrating from process groups to resource groups

To upgrade a Release 5 Encyclopedia volume that uses process groups, create
the same number of Actuate iServer resource groups as you have process
groups. Give the resource groups the same Factory process allocation as the
process groups.
To implement a resource group schedule similar to an Actuate Release 5
process group schedule, you can create an Actuate IDAPI application that
manages and schedules a resource group, including changing the number
Factory processes at scheduled times.

382 Administering Actuate iSer ver System

Using the resource group list
To view and set resource group properties for all Actuate iServer nodes in
Actuate iServer System, choose System Resource Groups from the System
Administration side menu. When you choose System Resource Groups,
Resource Groups appears.

From Resource Groups, an Actuate iServer System administrator can access

the following functionality:
■ Choose Add resource group to add a resource group. For information, see
“Adding a resource group,” later in this chapter.
■ Hover the pointer over the arrow icon for a resource group and choose one
of the following options:
■ Choose Properties to view or change parameter values for the resource
group. For information, see “Viewing or modifying general resource
group parameters” and “Viewing or modifying resource group server
assignments,” later in this chapter.
■ Choose Enable or Disable to enable or disable the resource group.
■ Choose Delete to delete the resource group. If a scheduled job is
assigned to the deleted resource group, the job fails when Actuate
iServer runs the job. If a job is running on a Factory assigned to a
resource group that you delete, the job completes.
The following table describes the resource group parameters that appear on
Resource Groups.

Parameter Description
Description Description of the resource group.
Name Resource group name.

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 383
 Parameter Description
Priority Job priority range for asynchronous resource
group jobs. This parameter is available only for
an asynchronous resource group. The resource
group’s Factory processes run jobs that fall
within the priority range.
The minimum value is 0. The maximum value is
1000. The minimum value must be lower than the
maximum value.
Status Status of the resource group. The status is either
Enabled or Disabled.
Type Type of Factory jobs the resource group runs. The
type is Sync for synchronous jobs. The type is
Async for asynchronous jobs.
Volume Name of the Encyclopedia volume that uses the
resource group’s Factory processes. The value is
either All for all Encyclopedia volumes or a
specific volume name.

Adding a resource group

To use a resource group, you must add and configure it.
When you create a resource group, you specify:
■ The Actuate iServer nodes that belong to the resource group. Member
nodes run the Factory processes for the resource group.
■ The job priority range for an asynchronous resource group.
■ The maximum number of Factory processes that an Actuate iServer node
can run simultaneously for members of the resource group.
■ The type of job that a resource group supports, either asynchronous or
synchronous.
■ The types of executable files that the resource group’s Factory processes
can run.
■ The Encyclopedia volumes that can use the resource group’s Factory
processes. When a report job runs in an Encyclopedia volume, the
Encyclopedia service runs the job using a Factory process that belongs to a
resource group that is assigned to the volume. When using a resource
group to run a report:

384 Administering Actuate iSer ver System

 ■ A user can use a job’s priority to determine which resource group the
Encyclopedia volume uses to run a report.
■ An Encyclopedia volume administrator can choose a resource group
from the resource groups that are assigned to the Encyclopedia volume.
■ An Actuate iServer System administrator can define a synchronous
resource group to reserve resources for a specific task.
The following table describes the resource group parameters that appear on
Resource Groups—Properties—General.

Parameter Description
Description Description of the resource group.
Disabled Resource group status. If selected, the resource
group is disabled. Deselect this option to enable
the resource group.
The default status of a new resource group is
Disabled.
Name Resource group name. Name is a required
parameter when you create a new resource
group.
Priority Job priority range for asynchronous resource
group jobs. This parameter is available only for
an asynchronous resource group. The resource
group’s Factory processes run jobs that fall
within the priority range.
The minimum value is 0. The maximum value is
1000. The minimum value must be lower than the
maximum value.
If you set the Type to Sync for a synchronous
resource group, Actuate iServer disables the
Priority’s Min and Max fields.
Type Type of Factory jobs the resource group runs. The
type is Sync for synchronous jobs. The type is
Async for asynchronous jobs.
You cannot change this parameter after you
create a resource group.
Volume Name of the Encyclopedia volume that uses the
resource group’s Factory processes. The value is
either All for all Encyclopedia volumes or a
specific volume name.

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 385
 How to add a resource group
1 From the side menu of the System Administration console, choose System
Resource Groups.
Resource Groups appears.
2 Choose Add resource group.
Resource Groups—New Resource Group—General appears. The following
illustration shows Resource Groups—New Resource Groups—General for
an asynchronous resource group.

3 Supply parameter values to set up the resource group. When you finish
setting the parameter values, choose OK.
Resource Groups appears.

Viewing or modifying general resource group

parameters
On Resource Groups—Properties—General, you can modify the general
parameter values for an existing resource group. For information about
adding a resource group, see “Adding a resource group,” earlier in this
chapter.
The following illustration shows Resource Groups—Properties—General for
an asynchronous resource group.

386 Administering Actuate iSer ver System

 The following table describes the resource group parameters that appear on
Resource Groups—Properties—General.

Parameter Description
Description Description of the resource group.
Disabled Resource group status. If selected, the resource
group is disabled. Deselect this option to enable
the resource group.
Name Resource group name.
Priority Job priority range for asynchronous resource
group jobs. This parameter is available only for
an asynchronous resource group. The resource
group’s Factory processes run jobs that fall
within the priority range.
The minimum value is 0. The maximum value is
1000. The minimum value must be lower than the
maximum value.

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 387
 Parameter Description
Type Type of Factory jobs the resource group runs. The
type is Sync for synchronous jobs. The type is
Async for asynchronous jobs.
You cannot change this parameter after you
create a resource group.
Volume Name of the Encyclopedia volume that uses the
resource group’s Factory processes. The value is
either All for all Encyclopedia volumes or a
specific volume name.

How to view or modify the general parameter values for a resource

group
1 From the side menu of the System Administration console, choose System
Resource Groups.
Resource Groups appears.
2 Hover the pointer over the arrow icon for a resource group to display the
drop-down list for the resource group.
3 Choose Properties.
Resource Groups—Properties—General appears.
4 Change the general parameter values as necessary. When you finish
changing parameter values, choose OK.
Resource Groups appears.

Viewing or modifying resource group server

assignments
On Resource Groups—Properties—Server Assignments, you can view or
modify the Actuate iServer machine assignments of a resource group. You can
enable or disable resource groups, change Actuate iServer node membership,
or change the number of Factory processes in a resource group without
restarting the Actuate iServer System cluster, node, or stand-alone server.
Resource Groups—Properties—Server Assignments lists the Actuate iServer
System cluster nodes and the resource group’s parameter values for each
node.

388 Administering Actuate iSer ver System

 The following table describes resource group parameters that appear on
Resource Groups—Properties—Server Assignments.

Parameter Description
Activate Actuate iServer node membership status. If
selected, the Actuate iServer node is a member of
the resource group. When you create a new
resource group, Activate is deselected for all
Actuate iServer nodes.
File Types Comma-separated list of Encyclopedia volume
file types that the Factory processes assigned to
the resource group can run.
Max Factories Maximum number of Factory processes that the
Actuate iServer node or stand-alone Actuate
iServer machine can run for the resource group.
The default Max Factories parameter value is 0
(zero) for each Actuate iServer node.
Server Name Name of the Actuate iServer node on which the
Factory service is enabled.

For information about setting resource group information as part of Actuate

iServer node configuration, see “Setting server parameter values for an
Actuate iServer System resource group” in Chapter 7, “Working with an
Actuate iServer System server.”

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 389
 How to view or modify Actuate iServer assignments for a resource
group
1 From the side menu of the System Administration console, choose System
Resource Groups.
Resource Groups appears.
2 Hover the pointer over the arrow icon for a resource group to display the
drop-down list for the resource group.
3 Choose Properties.
Resource Groups—Properties—General appears.
4 Choose Server Assignments.
Resource Groups—Properties—Server Assignments appears.
5 Change the settings as necessary. When you finish modifying the
parameter values, choose OK.

Stopping a resource group from running jobs

You can stop a resource group from running jobs by performing the following
actions:
■ Disabling the resource group
■ Setting the resource group’s maximum number of Factory processes to zero
for all Actuate iServer nodes that belong to the resource group
■ Removing active membership of Actuate iServer nodes
If you perform either of the first two actions, Actuate iServer no longer sends
job requests the resource group. The maximum number of Factory processes is
unaffected.
For an asynchronous resource group, disabling a resource group is the same as
setting the maximum number of Factory processes to zero. If Actuate iServer
has only disabled resource groups, Actuate iServer sends a job to a resource
group and puts the job in a pending state until a resource group becomes
available.
If you disable a synchronous resource group, Actuate iServer does not send
new jobs to the Actuate iServer nodes that are configured to use the resource
group. The resource group processes jobs that are currently being executed
and that are waiting. If you set the maximum number of Factory processes to
zero on any of the nodes, jobs that are waiting to be executed do not execute.
The jobs that do not execute time out.

390 Administering Actuate iSer ver System

 Removing all active memberships from a resource group is the same as setting
the maximum number of Factory processes to zero on all Actuate iServer
nodes in a cluster.
If you remove a resource group from an Encyclopedia volume, you must
assign a resource group with available Factory processes to the Encyclopedia
volume. Otherwise, you cannot run a job. For example, if you change a
resource group Encyclopedia volume assignment from volume1 to volume2,
you must ensure another resource group can handle the jobs volume users
create in volume1. If you remove an Encyclopedia volume assigned to a
resource group, Actuate iServer changes the Encyclopedia volume’s resource
group assignment to All volumes and disables the resource group.

Chapter 10, Adding and configuring an Actuate iSer ver System resource group 391
392 Administering Actuate iSer ver System
 Chapter

Adding and configuring

Chapter 11
11
an Actuate iServer System
printer
This chapter contains the following topics:
■ Working with the printer list
■ Adding a printer
■ Viewing or modifying printer properties
■ Removing a printer

Chapter 11, Adding and configuring an Actuate iSer ver System printer 393
Working with the printer list
As an administrator, you can add and remove printers from Actuate iServer
System. In an Actuate iServer System cluster, each Actuate iServer machine
maintains printer property information. For information about Actuate iServer
properties, see “About server parameters for Actuate iServer System” in
Chapter 7, “Working with an Actuate iServer System server.” When you add a
printer to a cluster, you must specify the printer parameter values for each
Actuate iServer node in the cluster.
Choose System Printers from the side menu of the System Administration
console to work with Actuate iServer System printer information. When you
choose System Printers from the side menu in the System Administration
console, Printers appears. Printers lists printers that are available to Actuate
iServer System.

On Printers, an administrator can access the following functionality:

■ Choose Add Printer to add a printer. For more information, see “Adding a
printer,” later in this chapter.
■ Hover the pointer over the arrow icon for a printer and choose one of the
following options:
■ Choose Properties to change the parameter values for a printer. For
more information, see “Viewing or modifying printer properties,” later
in this chapter.
■ Choose Delete to remove a printer from Actuate iServer System. For
more information, see “Removing a printer,” later in this chapter.
For Actuate iServer in a stand-alone configuration on a machine running a
Microsoft Windows server operating system, Actuate iServer System uses the
Actuate iServer machine’s printers. Actuate iServer updates the list of
available printers when the Actuate iServer machine restarts.

394 Administering Actuate iSer ver System

Adding a printer
The Actuate iServer installation process adds printers that are configured on
an Actuate iServer machine as Actuate iServer System printers. To add a
printer to Actuate iServer System after installation, complete the following
tasks in this order:
■ Add and configure the printer on the Actuate iServer machine.
■ Add the printer as an Actuate iServer System printer.
■ Restart Actuate iServer.
To add a printer to Actuate iServer System, you must add the printer to
Actuate iServer System on Printers—Add Printer.

The following table describes the parameters that appear on Printers—Add

Printer.

Parameter Description
PPD File Name PPD file name for UNIX operating systems. Do
not specify a path.
Printer name Name of the printer.

Chapter 11, Adding and configuring an Actuate iSer ver System printer 395
 Parameter Description
Printer path Path to the printer from the Actuate iServer
machine.
Spool command Spool command for UNIX operating systems. For
printers on UNIX operating systems, Actuate
iServer supports the standard UNIX commands,
such as lp and lpr. Actuate recommends using
the copy before printing option. For example, on
an AIX system, use the following command:
lp -c -d

On a UNIX system, the printer PPD file must be in the Actuate iServer home
operation/print/ppds directory and must be listed in the uses the file
operation/print/ppds/driver_mapping.
For example, to use a the PPD file hp9000.ps with the Actuate iServer printer
HP LaserJet 9000, the PPD file must be in /AcServer/operation/print/ppds/
and in the same directory, the driver_mapping file must contain an entry
similar to the following:
hp9000.ps: "HP LaserJet 9000"
After updating the UNIX system, restart Actuate iServer node for the changes
to take effect.

How to add a printer to Actuate iServer System

1 From the side menu of the System Administration console, choose System
Printers.
Printers appears.
2 On Printers, choose Add Printer.
Printers—Add Printer appears.
3 For each Actuate iServer machine, supply the necessary information. When
you finish setting up the printer, choose OK.
4 Restart Actuate iServer. For information, see “Working with offline Actuate
iServer” in Chapter 5, “Actuate iServer System administration overview.”

Viewing or modifying printer properties

On Printers—Properties, you can view or modify Actuate iServer System
printer properties.

396 Administering Actuate iSer ver System

 For each Actuate iServer node in an Actuate iServer System cluster, the
following printer parameters appear on Printers—Properties.

Parameter 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.
Server name Name of server in the system.
Spool command The spool command for UNIX operating
systems. Actuate recommends using the copy
before printing option. For example, on an AIX
system, use the following command:
lp -c -d

How to view or modify Actuate iServer System printer properties

1 From the side menu of the System Administration console, choose System
Printers.
Printers appears.
2 Hover the pointer over the arrow icon for a printer in the list to display that
printer’s drop-down list.

Chapter 11, Adding and configuring an Actuate iSer ver System printer 397
 3 Choose Server settings.
Printers—Properties appears.
4 Modify the printer parameter values. When you finish modifying the
parameter values, choose OK.
Printers appears.

Removing a printer
To remove a printer from Actuate iServer System, complete the following tasks
in this order:
■ If the printer is the default printer for an Encyclopedia volume, assign a
new default printer. For information, see
■ Remove the printer from Actuate iServer System.

398 Administering Actuate iSer ver System

 Chapter

Working with database

Chapter 12
12
connections
This chapter contains the following topics:
■ About database connections
■ About stored procedures
■ Defining an environment variable
■ Connecting to a DB2 database
■ Connecting to an Informix database
■ Connecting to a MS/SQL database
■ Connecting to a database through ODBC
■ Connecting to an Oracle database
■ Connecting to a Progress 9.1 database
■ Connecting to an SAP data source
■ Connecting to a Sybase database
■ Using an Open Data Access driver
■ About UNIX factsrvr database compatibility

Chapter 12, Working with database connections 399

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 Actuate
iServer to connect to a database, it must have access to the appropriate
database client software.
Actuate iServer on a Linux system supports connecting to databases using
only ODBC.
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 Accessing
Data.
In most cases, Actuate iServer and the database run on different computers for
load-balancing purposes. This division is not required, however. You can run
Actuate iServer on the database host if you want to use that computer’s
resources to improve performance of some Actuate iServer 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 about database and operating
system requirements. The Actuate document is on the Actuate web site at
http://www.actuate.com and is updated frequently.
When configuring a database client, you must configure the client’s locale
setting to match the Actuate iServer machine’s locale. For information about
the Actuate system locale and how Actuate iServer uses the locale, see
“Changing locale and time zone settings for Actuate iServer System” in
Chapter 5, “Actuate iServer System administration overview.”
For an Actuate report object executable (.rox) file that accesses a database with
data in one or more languages, the Actuate iServer System administrator must
configure the database clients to support retrieving and viewing of data in
those languages.
Most databases support the UTF-8 code page 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.

400 Administering Actuate iSer ver System

 Actuate iServer uses the database client’s locale settings when establishing a
connection with the database server. If the database client locale settings
including a particular code page are configured, Actuate iServer
communicates using those settings. The following describes how Actuate
iServer finds the database client locale information:
■ The database client provides an API to access the locale information.
Actuate iServer 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.
■ 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.
■ The database client does not specify locale information.
Actuate iServer assumes the database client uses the operating system's
locale setting. Actuate iServer 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

Actuate supports stored procedures with the stored procedure data source
component when you use the following Actuate connections:
■ DB2
■ ODBC connection on Microsoft Windows server operating systems
■ Oracle 8 or later client and server
■ Progress 9.1
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 Accessing Data.
Using the Stored Procedure Data Source Builder, 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 3, “Accessing databases using stored procedures,” in Accessing
Data.

Chapter 12, Working with database connections 401

Defining an environment variable
Many of the database connections described here require you to define
environment variables. Two important considerations apply when you create
these definitions.
If Actuate iServer runs on UNIX, insert the definitions in the file pmd7.sh,
which is in the directory $AC_SERVER_HOME/bin. For example, add the
following lines to your pmd7.sh file if you use a Sybase database:
export SYBASE
SYBASE=/usr/local/sybase
UNIX environments use a library path environment variable. The library path
variable name is different on each UNIX platform:
■ LD_LIBRARY_PATH variable for Sun Solaris
■ LIBPATH variable for IBM AIX
■ SHLIB_PATH variable for HP-UX
Microsoft Windows server operating systems use the PATH environment
variable to search for libraries and executable files. If Actuate iServer runs on a
Windows system, you must define system environment variables rather than
user environment variables. Defining a user environment variable is not
equivalent; Actuate iServer 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 a DB2 database

Actuate iServer works with DB2 (IBM Database 2) on UNIX and Microsoft
Windows. To connect with DB2 databases, you must:
■ Define appropriate environment variables
■ Specify the database environment
■ Supply an account name and password
■ Specify the protocol your site uses
■ 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.

402 Administering Actuate iSer ver System

When configuring the DB2 client, you must configure the client’s locale setting
to match the Actuate iServer machine’s locale. For information about the
system locale and how Actuate iServer uses the locale, see “About database
connections,” earlier in this chapter.
Actuate iServer works with DB2 databases using run-time client versions 7.2,
and 8.1
The Actuate interface to DB2 clients supports DB2 stored procedures. From the
Stored Procedure Data Source Builder in e.Report Designer Professional, or
e.Report Designer, developers can use DB2 stored procedures to retrieve data
to generate reports. For more information about stored procedures, see “About
stored procedures,” earlier in this chapter.
Due to a limitation of the DB2 CLI API, the Stored Procedure Data Source
Builder does not support DB2 overloaded stored procedures.
The Actuate Stored Procedure Browser does not list DB2 user-defined
functions. DB2 user-defined functions do not return result sets and are not a
data source.
DB2 does not support large object (LOB) data types between versions. For
example, the DB2 7.2 client cannot access a character large object (CLOB) data
type from a DB2 8.1 server. See the DB2 documentation for information about
DB2 support for LOB data types.
To use DB2 8.1 client software with DB2 7.2 server, you must apply the DB2 7.2
Fix Pak 8 to the DB2 7.2 server. See the DB2 documentation for information
about DB2 Fix Paks.
You must bind the DB2 CLI packages from the client system to the DB2 server
using db2cli.lst in some situations. For example, after you apply a Fix Pak to a
client or server, or on a system where an Actuate report uses DB2 8.1 client
software with a DB2 8.1 server. For information about binding DB2 packages,
see the IBM DB2 documentation or IBM technical support.

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 Microsoft Windows, 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

Chapter 12, Working with database connections 403

 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 about UNIX library
environment variables, see “Defining an environment variable,” 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.

Using DB2 libraries on SunOS and HP-UX

On SunOS and HP-UX, if you did not specify DB2 database information
during Actuate iServer installation, and want to use DB2 database connections
from the Actuate iServer machine, you must create a symbolic link to the DB2
library libdb2.so in the DB2 client installation directory.
On Solaris, create a symbolic link DB2CLI.so in AC_SERVER_HOME/lib to
the DB2 library libdb2.so.
On HP-UX, create a symbolic link DB2CLI.sl in AC_SERVER_HOME/lib to
the DB2 library libdb2.sl.

404 Administering Actuate iSer ver System

 About Actuate support for XML Extender
XML Extender, available with DB2 version 7.2, 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.

Checking a connection to a DB2 instance

To check that a connection exists between the Actuate iServer 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.

Connecting to an Informix database

Actuate iServer 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:
■ Define appropriate environment variables
■ Specify the database environment
■ Supply an account name and password
■ Specify the protocol your site uses
■ Specify the proper client connection

Chapter 12, Working with database connections 405

 On UNIX systems, the installation script asks for the Informix information
during Actuate iServer installation and uses this information to create Actuate
iServer startup scripts in the $AC_SERVER_HOME/bin directory and to
update the system’s startup file. On Solaris systems, this file is the Rc.local file.
When configuring the Informix client, you must configure the client’s locale
setting to match the Actuate iServer machine’s locale. For information about
the system locale and how Actuate iServer uses the locale, see “About
database connections,” earlier in this chapter.

Defining Informix environment variables

If Actuate iServer runs on Microsoft Windows, 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; Actuate
iServer processes are system processes, and cannot access your user
environment.
If Actuate iServer runs on UNIX, you must define two environment variables,
INFORMIXDIR and INFORMIXSERVER. As on Microsoft Windows,
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:
■ CLIENT_LOCALE specifies the client application locale. The default is US
English.
■ 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.
■ 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.

406 Administering Actuate iSer ver System

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 Actuate iServer uses to connect to the database by
supplying its user name and password.

Using UNIX Factory server software with Informix

If Actuate iServer runs on Solaris, AIX, or HP-UX, you might need to change
the Informix client version specified in the Actuate report’s 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 Actuate iServer 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.

Chapter 12, Working with database connections 407

 Overriding Informix DLLPath
To override the Informix DLLPath property when running a report on Actuate
iServer 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 2, “Setting up Actuate iServer System
hardware.”

Determining Informix version on a server running

Windows
To find the client version information on a server running 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 Microsoft Windows or an environment variable on
UNIX to set a smaller maximum column length used by Actuate.
To change the maximum character length:
■ On Microsoft Windows, change the value of the string value name
MaxVarLen. The value name is in the registry key:
HKEY_CURRENT_USER\Software\Actuate\DBMS\Informix
■ On UNIX, set the environment variable
AC_DBMS_INFORMIX_MAXVARLEN.

408 Administering Actuate iSer ver System

Connecting to a MS/SQL database
Actuate iServer works with MS/SQL databases on Microsoft Windows.
Actuate Release 9 supports Microsoft SQL Server 7.0.
To connect with MS/SQL databases, you must:
■ Identify the database server
■ Supply an account name and password
■ Indicate the dynamic link library (DLL) the Actuate iServer machine uses
to establish the connection
When configuring the MS/SQL client, you must configure the client’s locale
setting to match the Actuate iServer machine’s locale. For information about
the Actuate system locale and how Actuate iServer uses the locale, see “About
database connections,” earlier in this chapter.

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.
MS/SQL DB2 handles data in the following ways:
■ 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.

Chapter 12, Working with database connections 409

 ■ DB-Library is a 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

Indicate the account Actuate iServer uses to connect to the database by
supplying its user name and password.

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.

Accessing data from a database using Microsoft

Analytics Services
With an Actuate iServer license file that enables the Actuate Analytics Option,
Actuate iServer supports accessing data from a multidimensional cube stored
in a Microsoft SQL database using Microsoft Analytics Services. Actuate
iServer accessing the Microsoft SQL cube data and the MS SQL server must
run on machines that use the same locale. Access to data cubes stored in a
Microsoft SQL database with Microsoft Analytics Services is available only
with Actuate iServer running on Windows. For information about Microsoft
Analytics Services, see the Microsoft documentation.

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 on Component Editor.
This test uses the same information and connection mechanism employed by
Actuate iServer. A positive connection test indicates that the problem lies
elsewhere.

410 Administering Actuate iSer ver System

 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 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 data types 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 the
following 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.

Connecting to a database through ODBC

Actuate iServer works with the DataDirect Connect ODBC 4.2 drivers for
UNIX, Linux, and Microsoft Windows, and the Microsoft ODBC 32-bit drivers
on Windows. For information about capabilities and limitations of the
DataDirect Connect for ODBC drivers, see the DataDirect Connect for ODBC
documentation and read.me file supplied with the DataDirect Connect for
ODBC products and the DataDirect web site at www.datadirect.com.
When configuring the ODBC client, you must configure the client’s locale
setting to match the Actuate iServer machine’s locale. For information about
the system locale and how Actuate iServer uses the locale, see “About
database connections,” earlier in this chapter.
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

Chapter 12, Working with database connections 411

 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:
■ You must have installed ODBC on the host running Actuate iServer.
■ 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 Microsoft Windows, a Sybase client is not required. On
Solaris, AIX, and HP-UX DBLIB is not required for MS SQL server 7.0.
■ The Actuate iServer 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 Actuate iServer. To modify
.odbc.ini, use your favorite text editor. On Microsoft Windows, the file is
named odbc.ini. The file should be in the Windows directory. To modify
odbc.ini, use the ODBC Administrator.
■ To access ODBC data sources, Actuate iServer on Microsoft Windows must
be configured to run as a user account, not as the system account.
■ The proper version of the Actuate iServer Factory executable file is
required for an ODBC connection. For example on UNIX platforms, using
the ODBC Informix driver requires the proper version of the Informix
Actuate iServer Factory executable file. For information about Factory
server executable files, see “About UNIX factsrvr database compatibility,”
later in this chapter.
■ For UNIX systems, make sure the report and the Actuate iServer machine
are configured properly. For example, for a DataDirect ODBC connection:
■ Set DLLPath to ODBC32 in the Component Editor for report design.
■ 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 connecting to a Microsoft SQL Server database, set the UNIX
environment variable LC_MESSAGES to en_US to control message
formatting between the database and Actuate iServer.
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:

412 Administering Actuate iSer ver System

 [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.

Setting the maximum column length

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, or an environment variable on
UNIX to set a smaller maximum column length used by Actuate.
To change the maximum character length:
■ On Microsoft Windows, change the value of the string value name
MaxVarLen. The value name is in the registry key:
HKEY_CURRENT_USER\Software\Actuate\DBMS\Odbc
■ 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.

Chapter 12, Working with database connections 413

 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 Microsoft Windows. 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:
■ Install the Microsoft ODBC 3.0 Administrator.
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.
■ Set up the machine as a PeopleSoft client machine using the PeopleSoft
Configuration Manager.
■ Install the PeopleSoft ODBC driver using the PeopleSoft Configuration
Manager dialog box Client Setup tab.
■ Set up an ODBC data source for the PeopleSoft ODBC driver using the
ODBC Administrator Odbcad32.exe.

414 Administering Actuate iSer ver System

■ 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

Actuate iServer uses ODBC to connect to Red Brick database version 5.1.5. To
connect with Red Brick databases:
■ On Microsoft Windows:
■ Install the Red Brick ODBC dynamic load libraries (DLL).
■ Configure the ODBC DSN.
■ On UNIX:
■ Define appropriate environment variables.
■ Specify the database environment.
■ Install the proper Factory server software.

Setting up a Microsoft Windows Red Brick configuration

If Actuate iServer runs on Microsoft Windows, 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 Actuate iServer 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 Actuate iServer 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 Actuate
iServer.

Chapter 12, Working with database connections 415

 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 fctsrvr8 file. Then, move or copy the Red Brick
fctsrvr8. For AIX, HP-UX, and Solaris platforms, rename factsrvr.redbrick to
fctsrvr8.

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 logging in to the database you can enter a simple SQL query to check the
connection between the client and the database.
On Microsoft Windows, use the Red Brick utilities Risql.exe or Rbwping.exe to
test connectivity to the database server.

Accessing an ODBC data source on UNIX when

using Actuate Analytics
Actuate Analytics Option supports running Actuate cube profiles to generate
multidimensional data cubes in an Actuate Encyclopedia volume. Generating
a cube requires an Actuate iServer license with the Actuate Analytics Option
enabled. In order to a access a data source using ODBC for cube generation on
a UNIX system, you must configure Actuate iServer to use the proper
software:
■ Use the Actuate Analytics open server driver that supports ODBC.

416 Administering Actuate iSer ver System

 ■ Set the OBDC manager library in the Actuate iServer library path.
The default Actuate Analytics open server driver named acdbdrv is in
$AC_SERVER_HOME/drivers. The Actuate Analytics open server driver that
supports ODBC is named acdbdrv.odbc. The ODBC driver supports all
Actuate Analytics supported data source access including ODBC.
To use the ODBC driver save and move or rename the original acdbdrv file,
and rename the file acdbdrv.odbc to acdbdrv. These changes must be done
while the Actuate iServer is not generating a cube.
Ensure the ODBC manager library is named libodbc.so on Solaris, libodbc.sl
on HP-UX, and libodbc.a on AIX, and ensure that this file is the Actuate
iServer library path.
For information about setting the ODBC library manager name on a UNIX
system, see the UNIX configuration information in “Connecting to a database
through ODBC,” earlier in this chapter.
For information about setting the library path, see “Defining an environment
variable,” earlier in this chapter.

Connecting to an Oracle database

Actuate iServer works with Oracle databases of version 8.1.7 and later. The
Actuate interface to Oracle 8 version 8.1.7 and later 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
version 8.1.7 and later and later 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:
■ Install the proper software to connect to the Oracle client
■ Supply a connection string
■ Define the appropriate environment variables
■ Ensure that a listener process is running on the database host
When configuring the Oracle client, you must configure the client’s locale
setting to match the Actuate iServer machine’s locale. For information about
the system locale and how Actuate iServer uses the locale, see “About
database connections,” earlier in this chapter.
In an Actuate report object executable (.rox) file, 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.

Chapter 12, Working with database connections 417

 To run Actuate reports connecting to Oracle 8.1.7 from an Actuate iServer
running on a UNIX system, add the paths to ORACLE JRE libraries,
$ORACLE_HOME/JRE/lib and $ORACLE_HOME/JRE/lib/aix/1.1.8/
native_threads, and $ORACLE_HOME/lib to the library path environment
variable. For information about setting UNIX environment variables, see
“Defining an environment variable,” earlier in this chapter.

About Actuate support for Oracle 9i

When using the AcOracleConnection component, Actuate can use the acorcl81
library built with Oracle8.1.7 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 and later stored procedures and retrieval of
Oracle8 version 8.1.7 and later 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
version 8.1.7 and later 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.
■ An appropriate error message is raised if the DBInterface value is not
compatible with the installed Oracle client software.
For a previous version report object executable (.rox) file, if the connection
property DBInterface does not exist, Actuate uses acorcl90 as the default.
■ If you run the previous version report object executable (.rox) file that
connects to an Oracle database and the DBInterface value is not supported
in the current release, Actuate generates an error message. 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.
■ The MaximumStringLength property specifies the maximum possible
length for a VARCHAR2 or NVARCHAR2 data type. The default value of
this property is 4000. Developers can change this property value when
designing an Actuate report.

418 Administering Actuate iSer ver System

 Users can specify a value in the configuration file. The
MaximumStringLength value in the Oracle Connection property found in
the configuration file overrides the value specified in the report design. For
configuration file information, see “Specifying a database configuration
file” in Chapter 2, “Setting up Actuate iServer System hardware.”
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 the MaximumStringLength property value is other than the default
value. If the MaximumStringLength value is the default value, Actuate
iServer checks to see if the registry key exists or not. If it does not exist,
Actuate uses the value specified for MaximumStringLength. If the registry
key value is other than the default value, and MaximumStringLength
property value is set to default value, Actuate iServer uses the value
specified by the registry entry. The MaximumStringLength property value
overrides any other setting if it is not the default value. Actuate iServer
does not create a registry entry.
■ The Oracle failover feature is not supported.

Using Actuate iServer and Oracle clients

Actuate iServer Oracle DLLs are different from the one used in the client
products. You cannot mix the Microsoft Windows client and server DLLs.

About Oracle connection strings

Actuate iServer 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 Microsoft Window, network-prefix can be t or p (for named
Pipe).
The host field identifies the network node running the database you want to
reach.

Chapter 12, Working with database connections 419

 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 Actuate iServer
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 Actuate
iServer processes. For more information about the Actuate iServer scripts, see
“Understanding Actuate iServer status” in Chapter 5, “Actuate iServer System
administration overview.”
For Oracle databases on Microsoft Windows, 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 database version
8.1.7 or later, 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 about NLS_LANG, see the Oracle documentation.
On UNIX systems, an administrator must add the NLS_LANG environment
variable to the pmd7.sh script, the Actuate iServer 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.

420 Administering Actuate iSer ver System

For information about the NLS_LANG values, see the Oracle documentation.

About the Oracle listener processes

Actuate iServer 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
Actuate iServer 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 on Component Editor. Use the appropriate
connection string based on your version of SQL*Net.
This test uses the same information and connection mechanism employed by
Actuate iServer. A positive connection test indicates that the problem lies
elsewhere.

About Oracle 8 data type support

The following table lists Oracle 8 version 8.1.7 and later 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.
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.

Chapter 12, Working with database connections 421

 Setting the maximum column length
The default maximum column length Actuate uses with Oracle databases is
4000 characters. Problems can occur when generating an Actuate report if the
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.
To change the maximum character length:
■ 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
■ On UNIX, set the environment variable
AC_DBMS_ORACLE_MAXVARLEN.

Connecting to a Progress 9.1 database

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:
■ Use of Embedded SQL and SQL-92
■ Support for new datatypes
■ 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
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 about HP-UX patches.

422 Administering Actuate iSer ver System

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. Actuate iServer supports an
Actuate report object executable (.rox) file that connects to a Progress database.

Installing Progress software

You must install the following Progress software to connect to Progress
databases:
■ SQL Client Access to connect to a Progress 9.1 database
■ Java Development Kit (JDK) for stored procedures and triggers
When configuring the Progress client, you must configure the client’s locale
setting to match the Actuate iServer machine’s locale. For information about
the system locale and how Actuate iServer uses the locale, see “About
database connections,” earlier in this chapter.

Defining Windows environment variables

The following environment variables must be set to connect from Actuate to a
Progress 9.1 database.

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.

Ensure that the following registry key is set to the JDK installation directory:
HKEY_LOCAL_MACHINE\Software\PSC\PROGRESS\9.0X\JAVA\JDKHOME
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:
■ IBM866 for the Russian language

Chapter 12, Working with database connections 423

 ■ SHIFT-JIS for Japanese language
■ 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.

Property Format Description

Database string Progress database name.
Dllpath string Acprg9.dll.
FetchRowBufferCount string Number of rows to fetch. Value must
be less than 65000.
Host string Database host computer name.
Password string Progress database user’s 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

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.

Working with a Progress 9.1 SQL92 connection

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.

424 Administering Actuate iSer ver System

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:
■ Tables not owned by PUB
■ 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 Actuate
iServer machine.
For more information about connecting to a Progress 9.x database using a
Progress 8 connection, see the Progress documentation.

Chapter 12, Working with database connections 425

 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.

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

Set the environment variable SQL_CLIENT_CHARSET to use an SQL-92 client

code page that is different from the client operating system. The value must be
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:
■ IBM866 for the Russian language
■ SHIFT-JIS for Japanese language
■ 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 iServer 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.

Platform Library
AIX libacprg9_share.a
HP-UX libacprg9.sl
SunOS libacprg9.so

For example, on SunOS a symbolic link is created between Acprg9.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.

426 Administering Actuate iSer ver System

 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
environment variable:
%DLC/lib;%JDKHOME/lib
The Progress 9 shared library libacprg9.sl is found in $AC_SERVER_HOME
\lib.

About AIX setup

The following Progress directories must be added to the LIBPATH
environment variable:
%DLC/lib;%JDKHOME/lib
The Progress 9 shared library libacprg9_share.a is found in
$AC_SERVER_HOME\lib.

Connecting to an SAP data source

Actuate support the following types of connections to SAP data sources:
■ Actuate supports SAP Business Warehouse (BW) 3.0B, 3.3 and SAP R/3
release 4.x using versions 2.0.7 up to 2.1.2 of the SAP Java Connector (SAP
JCO) for the following SAP data sources:
■ SAP BW BEx query
■ SAP BW Operational Data Store
■ SAP R/3
Actuate supports SAP R/3 as a data source. For information about using SAP
JCO and SAP R/3 as a data source and using Actuate reports that contain a
SAP R/3 connection, see Accessing Data.
For information about the SAP R/3 and SAP JCO versions Actuate supports,
see the Actuate Supported Products and Obsolescence Policy.
Actuate iServer uses the JRE 1.4.1.

Chapter 12, Working with database connections 427

 The Actuate iServer installation process configures the Actuate iServer
machine environment to work with SAP data sources. The installation process
installs the Actuate BW connector jar file and configures the system’s library
path to include the SAP JCO libraries and JVM libraries.
Actuate iServer requires additional SAP libraries and configuration to connect
to an SAP data source.

About required SAP JCO libraries

Actuate iServer requires SAP JCO libraries, the JAR file sapjco.jar and two
libraries. The sapjco.jar file is operating system platform dependent. The
following table lists the supported SAP JCO shared library names.

Operating system SAPJCO libraries

Microsoft Windows librfc32.dll*, sapjcorfc.dll
SunOS librfccm.so, libsapjcorfc.so
AIX librfccm.o, libsapjcorfc.o
HP-UX librfccm.sl, libsapjcorfc.sl

* Place the Microsoft Windows library file librfc32.dll in the Microsoft

Windows System32 directory. For example, the default location is
\WINNT\System32.
The version of librfc32.dll must be compatible with sapjcorfc.dll. For example,
use the librfc32.dll that ships with SAP JCO 2.1.2 when using that version’s
sapjcorfc.dll.

Configuring Actuate iServer to use SAP JCO files

You must configure Actuate iServer to use the sapjco.jar file and the SAP JCO
libraries. Copy sapjco.jar into the Actuate iServer \oda\AcOdaSapDriver\
MyClasses directory. For example, on a computer running Windows, the
default location of the MyClasses directory is \Program Files\Actuate8\oda\
AcOdaSapDriver\MyClasses.
Any classes in the MyClasses directory take precedence over those in the
CLASSPATH environment variable.
If you do not specify the directory of the SAP JCO libraries during the UNIX
Actuate iServer installation, update the library path environment variable in
the Actuate iServer startup script to include the SAP JCO shared libraries
directory. The table in “About required SAP JCO libraries,” earlier in this
chapter, lists the SAP JCO libraries.

428 Administering Actuate iSer ver System

On a computer running Windows, do not change the PATH environment
variable if the SAP JCO libraries are in the same directory as sapjco.jar.
For information about setting an environment variable, see “Defining an
environment variable,” earlier in this chapter.

About updating SAP JCO software

Actuate recommends installing the most recent SAP libraries before installing
Actuate iServer, a SAP partner product.
SAP partners and vendors who have a Developer Package Agreement
download the most recent SAP JCO software from the SAP Service
Marketplace at http://service.sap.com/connectors. The archive is located in
the SAP Java Connector—Tools & Services directory. For information about
installation, see the SAP installation guide provided with the software.
For information about downloading SAP libraries, see Note 19466 on the SAP
Service Marketplace at http://service.sap.com/notes.

About SAP R/3 required libraries

The Actuate database connection to SAP R/3 requires the SAP JCO libraries
and the SAP MetaData Interface (SAP MDI) file SAPmdi.jar.
For information about installing and configuring the SAP JCO libraries, see
“About required SAP JCO libraries,” earlier in this chapter.
After you install and configure SAP JCO libraries for use with Actuate iServer,
install and configure the SAPmdi.jar for use with Actuate iServer. Copy
SAPmdi.jar into the Actuate iServer oda\AcOdaSapDriver\MyClasses
directory. For example, on a computer running Windows, the default location
of the MyClasses directory is \Program Files\Actuate8\oda\
AcOdaSapDriver\MyClasses.
Any classes in the MyClasses directory take precedence over those in the
CLASSPATH environment variable.
The SAPmdi.jar file is not available on the SAP web site. The file is on the SAP
CD-ROM SAP WEB AS: SAP Web Application Server–Java Development
environment CD-ROM in the directory:
<cdrom drive>\JBA\lib\ext\SAPmdi.jar
Copy the file from the CD-ROM to the Actuate MyClasses directory.
The Actuate database connection to SAP R/3 requires SAP MDI and SAP R/3
release 4.0 or later supports SAP MDI. SAP MDI requires a certain version of
R/3 Basis software packages and might require importing a support package
to your R/3 installation.

Chapter 12, Working with database connections 429

 For information about compatible versions of SAP R/3 and SAP MDI, check
the SAP OSS notes for update requirements when using SAP MDI.

Connecting to a Sybase database

Actuate iServer 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:
■ Define the SYBASE environment variable.
■ Identify the database server.
■ Supply an account name and password.
■ Indicate the Actuate dynamic link libraries Actuate iServer uses to establish
the connection.
When configuring the Sybase client, you must configure the client’s locale
setting to match the Actuate iServer machine’s locale. For information about
the system locale and how Actuate iServer uses the locale, see “About
database connections,” earlier in this chapter.
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 following describes Actuate’s support for the Sybase interface:
■ DBInterface can have acsyb12 as a value, the acsyb12 library used with the
Sybase Open Client 12.0 and 12.5.
Actuate displays an error message for incompatibility for the following
conditions:
■ The DB interface library is acsyb12 and the Sybase Open Client version
is not 12.0 or 12.5.

430 Administering Actuate iSer ver System

 ■ 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.
■ The Sybase connection class has the MaximumStringLength parameter to
accommodate Sybase data types such as TEXT and LONGBINARY. The
default maximum column length is 4000 characters. Developers can change
this property value when designing an Actuate report.
The MaximumStringLength parameter can also be specified in an Actuate
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
configuration file” in Chapter 2, “Setting up Actuate iServer System
hardware.”
■ UNIVARCHAR and UNICHAR fields are not supported for Sybase Open
Client Sybase 12.5
■ The Sybase failover feature is not supported.
■ If you run the previous version report object executable (.rox) file with
Sybase Open Client 12.0 and the report does not have DBInterface value is
not acsyb12, Actuate generates an error message. To avoid this error, open
the report object design (.rod) file in the current version Actuate product,
change the DBInterface property value to acsyb12, and rebuild the report
object design (.rod) file with the current Actuate product.
■ 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 an Actuate report

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, an Actuate report object executable (.rox) file uses
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 an Actuate report object executable (.rox) file 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

Chapter 12, Working with database connections 431

 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 Actuate iServer runs on Windows, you must define the system environment
variable SYBASE. Defining a user environment variable is not equivalent;
Actuate iServer 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.
On HP-UX, Actuate recommends using the encoding C.utf8 and not using
univ.utf8.
■ Set LC_ALL using C.utf8 and not univ.utf8.
■ In locales.dat, set locale using C.utf8 and not univ.utf8. For example, use
the following:
locale = C.utf8,us_english, utf8
Do not use:
locale = univ.utf8,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 Actuate iServer 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 server running
Actuate iServer, regardless of the computer on which you type the name.
Failure to do so prevents successful connections.

432 Administering Actuate iSer ver System

 Supplying Sybase account information
Indicate the account Actuate iServer uses to connect to the database by
supplying its user name and password.

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 on Component Editor.

Using an Open Data Access driver

Actuate iServer supports Open Data Access (ODA) drivers that an Actuate
e.report (.rox) or Actuate information object (.dox) uses to retrieve data from a
data source. For information about creating an ODA driver, see Accessing Data.

Installing an Open Data Access driver

To install an ODA driver, create a directory in the Actuate iServer installation
oda directory and place the ODA files in the directory. Each ODA driver must
be in a separate directory. For example, if you have two ODA drivers, the
installation directories would be similar to the following directories:
■ AcServer/oda/oda-driver1
■ AcServer/oda/oda-driver2
The directory name for an ODA driver in the Actuate iServer oda directory
must match the driver name specified in the Actuate e.report (.rox) or Actuate
information object (.dox).
When installing an ODA driver, you must also install and configure any
software the ODA driver requires to access a data source. For example, you
must install and configure any database connection software the ODA driver
uses to connect to a database. You must also ensure the ODA driver can access
the required software.
Each ODA driver requires a run-time configuration file odaconfig.xml. The
configuration file must be in the ODA driver directory. You install the
configuration file and files required for the ODA driver on the Actuate iServer
machine that runs the report. Actuate recommends you keep the files that the
ODA driver uses in the ODA driver directory.

Chapter 12, Working with database connections 433

 Actuate iServer does not support installing ODA drivers in a directory below
the oda directory. For example, if you have two ODA drivers, Driver1 and
Driver2, Actuate iServer does not support the following ODA directory
structure for the two drivers:
■ AcServer/oda/CustomDrivers/Driver1
■ AcServer/oda/CustomDrivers/Driver2

About using an Open Data Access driver

When running a report using an ODA driver, the Actuate Factory process
loads the driver during the report generation. If the Factory process cannot
load specified driver, Actuate iServer logs an error message and report
generation terminates.
An ODA driver cannot share a library file with another ODA driver or data
source connection software. Each ODA driver must have a separate copy of
the library file for dedicated use. For example, on a Windows system, if a
database library uses a DLL to connect to a data source, and an ODA driver
uses the same DLL, you create a copy of the DLL file and use the copy with the
ODA driver.
If you change an ODA driver’s configuration such as a setting in the
configuration file or an ODA driver library, the Factory process uses the
updated configuration information and the updated library during the next
report generation.
Actuate iServer supports caching an ODA driver. If a Factory process uses a
cached ODA driver, the Factory process checks the last modified time of
configuration file and the cached driver’s run-time libraries before report
generation. If you modify the configuration file or the driver since last loading
the driver, the Factory process releases the cached driver and reloads it.
Using the ODA Java interface, a developer can create an ODA driver that
supports connection pooling,. For example, when a Factory process uses an
ODA driver, the driver can create a connection to the data source. When the
Factory process requests another connection to the data source, the ODA
driver can return a new connection or reuse the previous connection instance.

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 and Obsolescence Policy on the Actuate web site at:
http://support.actuate.com/es/products/supportedprod.asp

434 Administering Actuate iSer ver System

The Factory servers are in an Actuate iServer machine’s operation directory.
The Factory server used by Actuate iServer is named fctsrvr7. 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 fctsrvr7 file, and rename the database-specific
Factory server to fctsrvr7. These changes must be done while Actuate iServer
is not running.

OS and Informix ODBC

Factory Connect Data- Red
server DB2 2.40 Direct Oracle Progress Sybase Brick
AIX
default X X X X X
factsrvr
db2 X X X X X
redbrick X X X X X

HP-UX 11
default X X X X X X
factsrvr
redbrick X X X X X X

Solaris
default X X X X X X
factsrvr
redbrick X X X X X X

Chapter 12, Working with database connections 435

436 Administering Actuate iSer ver System
 Chapter

Working with Actuate

Chapter 13
13
iServer utilities
This chapter contains the following topics:
■ Using acacfconvert
■ Using acexport
■ Using acextern
■ Using acimport
■ Using acintern
■ Using acmode
■ Using actoc
■ Using acupgrade
■ Using acverify
■ About the UNIX PostScript font utility

Chapter 13, Working with Actuate iServer utilities 437

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 8 format export files. The ACF file must be created by Actuate
Release 3, 4, or 5 acexport utility.
The acacfconvert utility requires the following executable files: 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 acacfconvert 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 Actuate iServer
machine.
The following table lists the acacfconvert options.

Option Description
-config <path> Specify the path to the Actuate iServer
configuration file acserverconfig.xml if the file is
not in the default location. The default location is
in the Actuate iServer etc directory. For example,
on a UNIX system the default location is
$AC_SERVER_HOME/etc.
-external Specify an externalized 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 Encyclopedia volume. Default is the
empty password.

438 Administering Actuate iSer ver System

Option Description
-RSSE <library> Parameter specifies the location of an RSSE
library to use to validate existing references to
users and roles. Required with the -external
option if you use an externalized Encyclopedia
volume that uses an RSSE library. Do not use the
option if the volume uses an RSSE Web Service
application.
-rssevol <volume > Specify the externalized Encyclopedia volume, a
volume that uses RSSE. Use -rssevol with the
option -external when Actuate iServer manages
more than one volume and the volume is an
externalized volume.
-temp <temp_dir> Specify a temporary directory to be used for
intermediate acacfconvert files. The default is
AC_SERVER_HOME\tmp directory or the
machine’s temp directory, if
AC_SERVER_HOME\tmp does not exist.
-encoding <encoding> Specify an Actuate supported code page or
encoding if the old Encyclopedia volume uses
different encoding than the machine’s system
encoding. Default is system encoding. For
information about valid code page and encoding
values, see Chapter 3, “Understanding Actuate
Basic report encoding,” in Working with Multiple
Locales.

Acacfconvert uses acupgrade. Acupgrade handles a Japanese Encyclopedia

volume in the following manner. A Japanese Release 5 Encyclopedia volume
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 Encyclopedia volume using SJIS.
This example converts the export file c:\exports\sales.acf to Release 8 format
data in a directory. The directory containing the Release 8 version exported
volume is c:\exports\v8\sales:
acacfconvert -input c:\exports\sales.acf -output c:\exports\v8\sales
This example converts backup_feb_2001.acf into Release 8 format data in the
subdirectory backup_v8_feb_2001 in the current directory. Acacfconvert uses
the directory D:\temporary files to store temporary files:
acacfconvert -input backup_feb_2001.acf -output backup_v8_feb_2001
-temp "d:\temporary files"

Chapter 13, Working with Actuate iServer utilities 439

Using acexport
The acexport command-line utility exports 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 Actuate iServer. The export directory contains report executable
files, 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 Encyclopedia
volume. Use acimport to import the volume information that is exported in
the current release format. To upgrade from pre-Release 6 Encyclopedia
volume use acupgrade. For information about acupgrade, see “Using
acupgrade,” later 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 and
the sample Actuate RSSE application” in Chapter 4, “Configuring Actuate
iServer security.”
Acexport creates a log file containing information such as missing dependency
information and warning messages. The log file is AcExport<export
date_time>.log in the $AC_SERVER_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 Actuate iServer machine.

Exporting files and folders

Acexport allows the administrator to export the contents of the entire
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.

440 Administering Actuate iSer ver System

Files that are exported can depend on other files in the volume. For example, a
report object instance (.roi) file generated from an report object executable
(.rox) file depends on the report object executable (.rox) file.
The following illustration of Properties—Dependencies for a file 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
You can export completed, pending, and scheduled report generation jobs
related to report executable files and report documents.
When exporting jobs, acexport also exports related input and output files.

Chapter 13, Working with Actuate iServer utilities 441

 About the exported volume directories and files
The acexport utility creates a directory that contains four types of files:
■ TOC file what.txt contains a description of the other exported files.
■ Metadata export files contain the volume’s exported metadata.
■ Metadata ID files contain metadata ID information acimport uses to map
names and IDs.
■ Encyclopedia volume content files are the actual report executable files and
documents.
The content files are placed in subdirectories of the export root directory.

Copying the export directory

To copy the exported 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 the exported volume to a
single file.
Platforms such as Windows and UNIX use different end-of-line characters.
This causes problems when copying a Release 6 SP1 or earlier export directory
files between the different systems.
■ When you move Release 6 SP1P1 or earlier export directory files between
different systems, move the export directory’s .csv files in text mode. Move
the other export directory files in binary mode.
■ When you move Release 6 SP1P1 or later export directory files between
different systems, move all the export directory’s files in binary mode.

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.

442 Administering Actuate iSer ver System

Export option Description
-egroups Export all groups.
-eprinters Export all printers.
-eusers Export all users and roles.
FILES AND FOLDERS
-bf <folder1> Block (exclude) files from listed folders from
<folder2> … export. Specify fully qualified path from the
volume root folder, for example,
/user1/test.
-rbf <folder1> Recursively block (exclude) items from specified
<folder2> … 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> Export files in listed folders. Specify fully
<folder2> … 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.
-ref <folder1> Recursively export items in listed folders, such as
<folder2> … export items in subfolders. Specify fully qualified
path from the volume root folder, for example,
/user1/test.
-type <file_type1> Export files of specified file types. Valid file types
<file_type2> … 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
-all Exports all information from the volume. This is
the default option. Equivalent to the options
-ref / -eadmin -ejobs.
-config <path to Specify the full path to the Actuate iServer
configuration file> machine’s configuration file, for example,
C:\Program Files\Actuate8\server\etc.
The -config option is used with the -vol option. If
using acexport a non-master server node,
the -config option specifies configuration file.
-help Display option information.

Chapter 13, Working with Actuate iServer utilities 443

 Export option Description
-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
AC_SERVER_HOME directory. Cannot be used
with -vol option.
-vol <volume name> Specify the name of the volume to export. The
name must reference a valid volume in the server
configuration file. Required if Actuate iServer
manages multiple volumes. Acexport exports the
volume based on the configuration of Actuate
iServer. The name must be a valid Encyclopedia
volume. Use the -config 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 -config options or the -home option to specify the
Encyclopedia volume to export. To find the volume’s directory, use Actuate
Management Console to display a list of volumes and associated partitions
and display the directory assigned to the partition for a particular Actuate
iServer machine.
The default option for export is -all.

444 Administering Actuate iSer ver System

Acexport assumes the -all option if you use only the options -bf, -rbf, -latest, or
-type to specify list of exported files and folders. For example, the following
command uses only the -rbf option:
acexport -rbf /users/admin -output newvol
Acexport exports all the files and folders except the file and folders within
/users/admin and all the administrative information. To export only the files
and folders and excluding the file and folders within /users/admin, use the
following command:
acexport -efile -rbf /users/admin -output newvol
For file or folder names that contain spaces, enclose the file name in double
quotation marks ("). For example:
acexport -ref "/my reports" -output newvol
This example exports the administration information and two directories
/western and /midwest from the volume regions and places the exported
information in the directory newvol:
acexport -vol regions -config /configs/cluster1 -eadmin -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
The following command recursively exports the folder /users. The -rbf option
excludes the folder /users/admin and any files and folders within
/users/admin:
acexport -ref /users -rbf /users/admin -output newvol
The following command recursively exports the folder /users. The -bf option
excludes files in the folder /users/admin and exports folders within
/users/admin the files in those folders:
acexport -ref /users -bf /users/admin -output newvol
This example exports users, roles, groups and channels to the default export
directory encyc in the current directory:
acexport -eusers -egroups -echannels

Chapter 13, Working with Actuate iServer utilities 445

Using acextern
The command-line utility acextern converts existing user administration
information in an Encyclopedia volume. Use the acextern utility when
changing the Encyclopedia volume security scheme using one of the following
security levels to using an Actuate open security RSSE application that
operates at the External Registration security level:
■ The default Encyclopedia volume security level, where the Encyclopedia
volume stores the administration information internally
■ The External Authentication security level, where the volume uses an RSSE
application
Because acextern works directly with Encyclopedia volume files, back up your
existing Encyclopedia volume before you use the utility.
The acextern 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 Actuate iServer machine.
The system’s 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 full path to the
directory holding the Actuate iServer
configuration file. The default directory is the
local machine’s configuration file directory, for
example, C:\Program Files\Actuate8\server\
etc.
-help Display option information.
-operatorRole <role> Optional parameter specifies the name of the role
that will be the operator role.

446 Administering Actuate iSer ver System

 Option Description
-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. Do not use the option if the volume
uses an RSSE Web Service application.
-server <server name> Optional parameter specifies the Actuate iServer
machine name in the Actuate iServer
configuration file. The default to the local
machine name.
-vol <volume name> Specifies the Encyclopedia volume name to
convert. Required if Actuate iServer manages
multiple volumes. The name must be a valid
Encyclopedia volume in the Actuate iServer
configuration file. See the -config option for
information about specifying the configuration
file.

If the acextern -RSSE option is used, acextern uses the RSSE library application
to validate each Actuate name in the 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:
■ Privilege rules (access control lists) on folders and files in the Encyclopedia
volume
■ Privilege rules in scheduled jobs
■ Privilege rules on channels
■ Report job notification settings

Using acimport
Acimport imports Encyclopedia volume administration information such as
user and role information and a volume’s files and folders from a valid
volume export directory. Acimport is release specific and is used with the

Chapter 13, Working with Actuate iServer utilities 447

 same version volume. For example, acimport shipped with Actuate Release 8
creates a volume in Release 8 format.
You can use import to upgrade a Release 6 Encyclopedia volume after
exporting the old volume using the Release 6 acexport. To upgrade a pre-
Release 6 Encyclopedia volume use acupgrade. For information about
acupgrade, see “Using acupgrade,” later in this chapter.
Use acimport to import information from a directory that contains exported
Encyclopedia volume information to a target volume. If you specify a target
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.
If the administrator user of the target Encyclopedia volume has a password,
you must use the -password option and enter the administrator password
when importing data to the target 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 of the target Encyclopedia volume has no
password, a password is not required.
When importing to an Encyclopedia volume with multiple partitions, a
secondary partition must be active. The acimport partition allocation imports
the volume’s files into the partition with the most available free space. For
more information about using partitions, see Chapter 8, “Working with an
Actuate iServer System partition.”
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
the location of the library with the ICU_DATA environment variable. The
Actuate installation process sets ICU_DATA for the Actuate iServer machine.
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 and
the sample Actuate RSSE application” in Chapter 4, “Configuring Actuate
iServer security.”
Acimport creates a log file containing information such as missing
dependency information, and dropping, and warning messages. The log file is
AcImport<import date_time>.log in the AC_SERVER_HOME/log directory.
If you importing a export directory files between platforms, for example from
a Windows system to a UNIX system, you might need to move some files in
different modes. For information about moving files between systems, see
“Copying the export directory,” earlier in this chapter.

448 Administering Actuate iSer ver System

Importing volume information
The administrator can set options to specify what data is imported into an
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 Administrator’s 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 user’s e-mail
address.
If a user creates a new 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.
■ 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.
■ Requesting that imported files and folders whose names match existing
ones become new versions of existing files and folders.
■ 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. Imported files in the root directory whose names match
existing ones become new versions of existing files.

Chapter 13, Working with Actuate iServer utilities 449

 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.

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
-iallf Import all files and folders from exported
volume.

450 Administering Actuate iSer ver System

Import option Description
-if <export_f1> Import files exported from specified folders.
<export_f2> … Specify fully qualified path from the volume root
folder, for example, /user1/test.
-mf <old_dir1> Import objects exported from given folders in
<new_dir1> <old_dir2> source repository, but move (rename) objects to
<new_dir2> … 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 in the log file,
the dependency is broken, and the file is
replaced.
-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
-all Import all information. Default option.
Equivalent to -iallf -iadmin -ijobs.
Administrator settings are not changed. For
example, the Administrator’s password and
e-mail are not changed.
-config <path to Specify full the path to the Actuate iServer
configuration file> configuration file, for example,
C:\Program Files\Actuate8\server\etc.
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 Administrator’s password and
e-mail are not changed.
-help Display option information.

Chapter 13, Working with Actuate iServer utilities 451

 Import option Description
-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
AC_SERVER_HOME directory. Cannot be used
with -vol option.
-input <directory> Specify the directory containing the exported
volume data.
-password <password> Specify the password for the target Encyclopedia
volume administrator user. A prompt is
displayed if the administrator user has a
password and –password is not used.
-username <user> Specify an administrator user in the target
Encyclopedia volume. The default user is
administrator.
-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 -config option to
specify a configuration file. Acimport imports the
information to the volume based on the Actuate
iServer configuration. The name must reference a
valid Encyclopedia 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.

Use either the -vol and -config options or the -home option to specify the
target Encyclopedia volume that receives that volume data. If you do not
specify a target volume, the default volume is the volume managed by the
Actuate iServer node on the machine running acimport.
To find the volume’s directory, use the Actuate Management Console to
display the volumes and associated partitions and display the directory
assigned to the partition for a particular Actuate iServer machine.

452 Administering Actuate iSer ver System

Acimport assumes the -all option if you use only the options -rename, -replace,
or -version. For example, the following command uses only the -replace
option:
import -replace -input newvol
The -all, -iallf, -if, and -mf options have the following priority:
-all
-iallf,
-if, -mf,
If you use multiple options, acimport uses the option with highest priority and
ignores the options with lower priority. If you use both -if and -mf, acimport
uses both options to import and import and rename files. Acimport checks to
ensure that no source folder is imported more than once during a single
import operation.
Acimport imports all the files and folders replacing existing files, and imports
all the administrative information. To import only the files and folders from
the volume directory /users/admin, use the following command:
acimport -if /users/admin -input newvol
For file or folder names that contain spaces, enclose the file name in double
quotation marks ("). For example:
acimport -if "/my reports" -input c:\upgrade\newvol
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
AC_SERVER_HOME directory:
acimport -all -force -version -input 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
This command uses the export directory newdir and imports two directories
/region/western and /region/midwest into an Encyclopedia volume:
acimport -if /region/western /region/midwest -input newdir
The following example, assumes you created the export directory Admin-defs
that contains the volume user, role, and group definitions:
acimport -home "c:\program files\actuate8\server" -iadmin -input admin-defs

Chapter 13, Working with Actuate iServer utilities 453

Using acintern
The command-line utility acintern converts existing Encyclopedia volume
user administration information. Use the intern utility when changing the
Encyclopedia volume security scheme using an Actuate open security RSSE
application that operates at the External Registration security level to using
one of the following security levels:
■ The default Encyclopedia volume security level, where the Encyclopedia
volume stores administration information internally
■ The External Authentication security level, where the Encyclopedia
volume uses an RSSE application
Because acintern works directly with volume files, back up your existing
Encyclopedia volume before you use the utility.
The acintern 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 Actuate iServer machine.
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 system’s user account that runs acintern 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 full path to the
directory holding the Actuate iServer
configuration file. The default is the local
machine’s configuration file directory, for
example, C:\Program Files\Actuate8\server
\etc.
-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.

454 Administering Actuate iSer ver System

Option Description
-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.
-help Display option information.
-restore Restore data files from back up if acintern aborts
or exits without completing conversion of
volume data.
-RSSE <library> 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. Do not use
the option if the volume uses an RSSE Web
Service application.
-server <server name> Optional parameter specifies the Actuate iServer
machine name in the Actuate iServer
configuration file. The default to the local
machine name.
-vol <volume name> Specifies the Encyclopedia volume name to
convert. Required if Actuate iServer manages
multiple volumes. The name must be a valid
volume in the Actuate iServer configuration file.
See the -config option for information about
specifying the configuration file.

The acintern utility modifies the same volume information as acextern. The
option -restore is provided for acintern. This option is used only for recovery
when the acintern aborts or exits without completing conversion. The files
before conversion are restored.

Chapter 13, Working with Actuate iServer utilities 455

Using acmode
The command-line utility acmode places an online Encyclopedia volume in
and out of online backup mode, or to check the mode of a volume.
Online backup mode is an Actuate iServer 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.
Only Encyclopedia volume users assigned to the operator role can change the
state of the server. Running acmode requires the user name and password of
an Encyclopedia 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 Actuate iServer machine.
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 Actuate iServer. In an Actuate iServer
cluster the machine is the cluster master.
The default is localhost.
-Port <port number> Specify the port number Actuate iServer uses for
SOAP messages. The default is 9000. A space is
required between -Port and the port number.
-U <username> Specify the required user name and optionally
-P <password> 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. A space is
required between -Vol and the volume name.

456 Administering Actuate iSer ver System

 The option letters 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 an Actuate iServer machine managing a single volume, you
do not need to specify the volume. If Actuate iServer 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
volume’s 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
“Modifying Actuate iServer parameter values for an Encyclopedia volume” in
Chapter 9, “Working with an Actuate iServer System volume.”
When restoring an Encyclopedia volume from an online backup snapshot,
remove the translog directory from the volume’s directory if it exists. Actuate
iServer creates a new translog directory when bringing the volume online.
This example connects to the local server as user Administrator with password
secret and put volume sales into online backup mode:
acmode -Vol sales -D backup -U Administrator -P secret
This example connects to machine actuserver as user bkop and checks the
current mode of volume named default. Actuate iServer binds to the port 8009
for SOAP messages:
acmode -Vol default -M actuserver -Port 8009 -C -U bkop -P secret

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
location of the library with the ICU_DATA environment variable. The Actuate
installation process sets ICU_DATA for the Actuate iServer machine.
The following table describes the actoc options.

List option Description

ADMINISTRATION INFORMATION
-admin List all administration information.
GENERAL
-all List contents of entire export file.

Chapter 13, Working with Actuate iServer utilities 457

 List option Description
-help Display option information.
-input <directory> Specifies the export directory to be used.
-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.

Using acupgrade
The acupgrade command-line utility converts and upgrades a pre-Release 6
Encyclopedia volume to the current release version. Use acupgrade to convert
a Release 3, 4, or 5 Encyclopedia volume to work with the current release of
Actuate iServer. You can use acimport to upgrade a Release 6 Encyclopedia
volume after exporting the old volume using that version’s acexport. For
information about acimport, see “Using acimport,” earlier in this chapter. The
following list contains information about using acupgrade:
■ The Actuate iServer nodes managing the previous release and current
release Encyclopedia volumes must be offline when using acupgrade.
acupgrade always places the converted Encyclopedia volume in the encyc
directory for Actuate iServer, $AC_SERVER_HOME/encyc. You must
move or delete any existing Encyclopedia volume in the target current
release Actuate iServer home directory $AC_SERVER_HOME/encyc
before using acupgrade.
■ The acupgrade utility converts an Encyclopedia volume that is in the
admin, request, and object directories. The utility does not convert an
exported Encyclopedia volume that is in an .acf file.

458 Administering Actuate iSer ver System

■ During conversion, acupgrade creates a copy of the admin, request, and
object directories in the new Actuate iServer home directory.
■ If the old 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 library application is not
AC_SERVER_HOME\rsse\ldap\rsse.dll.
■ Acupgrade converts notices in the old Encyclopedia volume to completed
jobs. Acupgrade does not add a name to the completed job. The completed
job name is blank in the converted volume.
■ If the old Encyclopedia volume 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 “Modifying Actuate
iServer parameter values for an Encyclopedia volume” in Chapter 9,
“Working with an Actuate iServer System volume.”
If files in the volume use archive before deleting setting without an archive
driver, the files are not deleted from the volume when Actuate iServer
performs archiving. For information about autoarchive, see “Archiving
files and removing empty folders” in Chapter 20, “Archiving files and
backing up an Encyclopedia volume.”
■ After converting an old Encyclopedia volume 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 volume’s File
Types page. For information about the File Types page, see “Understanding
the File Types page” in Chapter 21, “Understanding Actuate iServer
options.”
■ If the acupgrade utility finds orphan files or folders in the old Encyclopedia
volume, acupgrade creates the folder lost&found in the new volume and
places the orphan objects in the folder. Orphan files and folders are items
that are physically in the Encyclopedia volume but are not visible or
accessible through the user interface.
■ The acupgrade utility shortens the following names:
■ Encyclopedia volume folders names are truncated to 100 characters.
■ 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.

Chapter 13, Working with Actuate iServer utilities 459

 Acupgrade creates a log file containing old and new names in the file
named truncate_<upgrade date>.log in the AC_SERVER_HOME/log
directory.
■ A Japanese Release 5 Encyclopedia volume 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
Encyclopedia volume using SJIS.
■ Use the -force option when acupgrade does not convert the Encyclopedia
volume because acupgrade does not consider the volume externalized or
internalized.
For example, if a previous release Encyclopedia volume uses an RSSE
application, use the -force option if acupgrade does not convert the
Encyclopedia volume because acupgrade detects the volume as
internalized.
When you use the -force option, the upgraded Encyclopedia volume is in
the same security state as the previous release Encyclopedia volume. For
example, if the old Encyclopedia volume uses an externalized security
source, the upgraded volume also uses externalized security.
■ Acupgrade does not migrate an Encyclopedia volume if both the following
conditions apply:
■ Actuate 8 and Actuate 5 reside in the same directory.
■ The file path for $AC_SERVER_HOME and the file path you specify for
the option -oldhome resolve to the same physical directory, for example,
if symbolic links map both paths to the same physical directory.
Acupgrade deletes the target Encyclopedia volume and does not create an
upgraded volume. To convert the volume, use the -copy option instead of
the -oldhome option. If you use the -copy option, acupgrade copies the
earlier version of the Encyclopedia volume to the
<server home for Actuate 8 >/oldstore directory.
The acupgrade utility creates a log file containing conversion information in
the $AC_SERVER_HOME/log directory.
The acupgrade 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 Actuate iServer machine.

460 Administering Actuate iSer ver System

The following table describes the options available with acupgrade.

Option Description
-config <path> Specify the path to the Actuate iServer
configuration file acserverconfig.xml if the file is
not in the default location. The default location is
in the Actuate iServer etc directory. For example,
on a UNIX system the default location is
$AC_SERVER_HOME/etc.
-copy Convert an Encyclopedia volume and create a
copy of original one in the new Actuate iServer
home.
-encoding <encoding> Specify an Actuate supported code page or
encoding if the old Encyclopedia volume uses
different encoding than the machine’s system
encoding. Default is system encoding. For
information about valid code page and encoding
values, see Chapter 3, “Understanding Actuate
Basic report encoding,” in Working with Multiple
Locales.
-external Convert an externalized Encyclopedia volume
used with an Actuate RSSE application. External
security system used with RSSE application must
be running and accessible. Default RSSE library
application path is
AC_SERVER_HOME\rsse\ldap\rsse.dll.
Use the -rsse option to specify the Actuate RSSE
library application used with the volume.
-force Force upgrading an Encyclopedia volume if
acupgrade does not convert an Encyclopedia
volume and the error message indicates the
Encyclopedia volume is either externalized or
internalized.
-help Display help information
-nocheck Disable check for corruption in old data store.
-nodisplay Disable display of information during
processing.
-oldhome <old server Specify the directory of the old Encyclopedia
dir> volume containing the admin, object, request
directories. The Encyclopedia volume is
converted and placed in the
$AC_SERVER_HOME directory.

Chapter 13, Working with Actuate iServer utilities 461

 Option Description
-password <password> Specify the old Encyclopedia volume
administrator’s password. Default is a blank
password.
-rsse <library path> Specify the fully qualified path to the Actuate
RSSE library application used with the
Encyclopedia volume. Used with -external
option to convert an externalized Encyclopedia
volume used with an Actuate RSSE library
application. Do not use the option if the volume
uses an RSSE Web Service application.
-rssevol <volume name> Specify the externalized Encyclopedia volume, a
volume that uses RSSE. Use -rssevol with the
option -external when Actuate iServer manages
more than one volume and the volume is an
externalized volume.
-temp_dir <path> Specify a temporary directory for upgrading an
Encyclopedia volume. The path is a fully
qualified path to an existing directory. The
acupgrade utility places the upgraded
Encyclopedia volume in the folder <path>/
encyc.
If you use the –oldhome option with –temp_dir,
acupgrade copies the old Encyclopedia volume
to the temporary directory before upgrading. If
you do not use –oldhome, move the old
Encyclopedia to the temporary directory before
running acupgrade.
Use this option if the iServer disk partition does
not have enough free space to upgrade an
Encyclopedia volume, or to create the upgraded
Encyclopedia volume on another disk partition.

If the volume administrator in the existing 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> …]

462 Administering Actuate iSer ver System

 If the volume administrator in the existing 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.
Use the -external and -RSSE options when the old Encyclopedia volume is
externalized. The -RSSE option specifies the fully qualified path to the RSSE
library that communicates with the external security source:
AcUpgrade –oldhome <encyc-home> -external –RSSE<path to library>
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.
■ The following command forces upgrading an externalized Encyclopedia
volume when acconvert detects the volume as internalized:
acupgrade –oldhome <encyc-home> -external –RSSE<path to library> -force
The following command forces upgrading an internalized Encyclopedia
volume when acconvert detects the volume as externalized:
acupgrade –oldhome <home> -force

Using acverify
The acverify command-line utility validates an 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:
■ When you observe an Actuate iServer performance problem that is
associated with a specific volume.
■ When an Actuate iServer error message or an Actuate iServer log entry
indicates that there is a possible volume corruption
■ After an Actuate iServer crash or an abnormal shutdown that may leave
the volume in an inconsistent state
■ After restoring a volume from a archive created while Actuate iServer was
in online backup mode. Actuate recommends using acverify with the
-check restore option after restoring an Encyclopedia volume.

Chapter 13, Working with Actuate iServer utilities 463

 ■ 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
location of the library with the ICU_DATA environment variable. The Actuate
installation process sets ICU_DATA for the Actuate iServer machine.
The following table describes the acverify options.

Option Description
-check <option list> Specifies tests to perform on the Encyclopedia
volume. Valid options are db, admin, files, jobs,
restore and all. Separate multiple options by a
space.
■ db option checks detailed, low level, volume
integrity.
■ admin option checks administrative
information such as users, roles, groups,
channels, and printers.
■ files option checks file and folder information.
■ jobs option checks job related information.
■ restore option checks the volume restored
from an archived snapshot. Actuate
recommends using acverify after restoring an
Encyclopedia volume.
■ 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 full path to the location of the
Actuate iServer configuration file, for example,
C:\Program Files\Actuate8\server\etc.
-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<verify
date_time>.log in the AC_SERVER_HOME\log
directory.
-repair If specified, acverify attempts to fix corruption
that it finds.

464 Administering Actuate iSer ver System

Option Description
-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 Encyclopedia volume to
be checked. If omitted, the primary volume being
managed by the current server is assumed. If the
server manages more than one volume, you must
use the -vol option to specify a volume.

When using acverify with an Actuate iServer cluster node, the node must be
configured to access the volume to be checked. With Actuate iServer in a
stand-alone configuration, run acverify from the Actuate iServer machine.
To access an Encyclopedia volume, acverify must read the cluster
configuration file and must know the logical name of volume. Specify the
Actuate iServer configuration file and Encyclopedia volume using the
-config, -vol, and -server options:
■ Specify the location of the cluster configuration using -config. As the
default, the cluster configuration file is located in the cluster master
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 master machine or if you are using acverify with Actuate iServer in
a stand-alone configuration. 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 iServer\8. On
UNIX systems AC_SERVER_HOME is an environment variable.
■ 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 with Actuate iServer in a stand-alone configuration or on an Actuate
iServer cluster node that manages an Encyclopedia volume, acverify
checks only the primary volume managed by a particular Actuate iServer
machine. Without the -vol option, acverify displays an error if the server
manages more than one volume.
■ Specify the cluster node or server name running acverify using -server. Use
this option to provide the Actuate iServer name when the Actuate iServer
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.

Chapter 13, Working with Actuate iServer utilities 465

 If you specify the -repair option and acverify finds orphan files or folders in
the Encyclopedia volume, acverify creates a folder in the volume and places
the orphan objects in the folder. The folder name is:
lost_found_error-information
Orphan files and folders are items that are physically in the Encyclopedia
volume but are not visible or accessible through the user interface.
The following example used on a stand-alone server machine checks the
Encyclopedia volume’s 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 master'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

About the UNIX PostScript font utility

The Actuate UNIX utility fontutils installs and uninstalls PostScript fonts to
the Actuate iServer machine. The utility is in the $AC_SERVER_HOME/bin
directory. Before you use the fontutils utility, make sure the following path:
$AC_SERVER_HOME/lib
is appended to the library path environment variable:
■ On SunOS the environment variable is LD_LIBRARY_PATH
■ On AIX the environment variable is LIBPATH
■ On HP-UX the environment variable is SHLIB_PATH
For information about using fonts for printing on a UNIX system running
Actuate iServer, see “Printing on UNIX” in Chapter 2, “Setting up Actuate
iServer System hardware.” For information about using fonts with multiple

466 Administering Actuate iSer ver System

locales and installing and using fonts see Chapter 4, “Using fonts in Actuate
Basic reports with multiple locales,” in Working with Multiple Locales.

Installing a PostScript font

Copy the font’s .afm and .pfa 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 .pfa file to UNIX format. Change the permissions
to readable by all users and change the .pfa file’s permissions so that it is
writable by all users.
With the .afm and .pfa files in the $AC_SERVER_HOME/bin, use fontutils and
the following options from a command line:
fontutils -T 1 -1"<font name>" -2<font file>.afm -3 <font file>.pfa
-4<CodePage>
where font name is the name of the font used in the report and CodePage is the
font’s code page. Enclose the font name in double quotes. Font file is the name
of the .afm or .pfa font.

Uninstalling a PostScript font

To uninstall a font use the fontutils utility and the following options from a
command line:
fontutils -T 2 -1”<font name>” -4<CodePage>
where font name is the name of the font used in the report and CodePage is the
font’s code page. Enclose the font name in double quotes.

Understanding PostScript font conversion issues

When converting a font using Fontographer 4.1 from Macromedia, choose
File➛GenerateFontFile. 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 font’s 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 and use the grep utility to
search for the string KPX in the font’s AFM file:
grep -c KPX mynewfont.afm
Open the .afm file in a text editor, search for the 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.

Chapter 13, Working with Actuate iServer utilities 467

468 Administering Actuate iSer ver System
 Chapter

Setting Actuate iServer

Chapter 14
14
parameters
This chapter contains the following topics:
■ About Actuate iServer parameters
■ About registry keys and environment variables

Chapter 14, Setting Actuate iServer parameters 469

About Actuate iServer parameters
The Actuate iServer System administrator uses Actuate Management Console
to configure Actuate iServer. The configuration information is maintained as a
set of Actuate iServer parameters.
Set commonly used Actuate iServer parameters in different portions of
Actuate Management Console. For example, set an Encyclopedia volume’s
backup servers in Volumes—Properties—Server Assignments. For
information about using Actuate Management Console and about Actuate
iServer System administration, see Chapter 5, “Actuate iServer System
administration overview.”
Set advanced Actuate iServer parameters in the following locations in Actuate
Management Console:
■ System—Properties—Advanced controls some settings for Actuate iServer
System such as usage and error logging, file system failover, and e-mail
notice messaging limits. For information about advanced system
parameters, see “Specifying advanced Actuate iServer System parameter
values” in Chapter 6, “Working with system-wide Actuate iServer
parameters.”
■ Server—Properties—Advanced controls some settings for Actuate iServer
server node items such as Factory process functionality, View process
functionality, and Actuate Open server file types. For information about
advanced server parameters, see “Working with advanced Actuate iServer
parameter values” in Chapter 7, “Working with an Actuate iServer System
server.”
■ Volume—Properties—Advanced controls some settings for Actuate iServer
Encyclopedia volume Encyclopedia volume items such as job notice
purging, and the URL link in e-mail notices. For information about
advanced volume parameters, see “Working with advanced Encyclopedia
volume parameters” in Chapter 9, “Working with an Actuate iServer
System volume.”
The following tables group Actuate iServer parameters into the following
functional groups:
■ Actuate iServer System parameters
■ Usage and Error Logging parameters
■ Integration Service parameters
■ Caching Service parameters
■ iServer node parameters
■ Encyclopedia volume parameters

470 Administering Actuate iSer ver System

 ■ Volume partition configuration parameters
■ Viewing Service parameters
■ Reporting Service parameters
■ SOAP Dispatch Service parameters
■ Server-specific Partition configuration parameters
■ A Printer used by this Server parameters
■ Open server file type parameters
■ Open server file type driver parameters
■ Resource Group parameters
■ SMTP Server parameters

Actuate iServer System parameters

The following table lists the Actuate iServer system parameters.

Display name
Server System parameter
System name
Parameter: SystemName
Default system encoding
Parameter: DefaultEncoding
Default system locale
Parameter: DefaultLocale
Description
Name of cluster, if it belongs to one.
Takes effect at system restart.
Category: General
Default encoding for the servers in the cluster. Default value is
windows-1252.
Takes effect at system restart.
Category: Locale
Default locale for the servers in the cluster. Default value is C
locale.
Takes effect at system restart.
Category: Locale

Chapter 14, Setting Actuate iServer parameters 471

Display name
Server System parameter Description
Maximum number of Maximum number of printers stand-alone Actuate iServer
printers to automatically adds to the server’s printer list during startup. Default value is
configure 15. Range is from 0 to 50.
Parameter: During restart, Actuate iServer deletes Actuate iServer printer
MaxAutoConfigPrinters information and adds the names the operating system's list of
printers to the Actuate iServer configuration. 0 disables
automatic printer configuration. Actuate iServer does not
update the list of printers during server restart.
Increase the value if you have more than 15 printers
configured on the Actuate iServer machine. Set the value to 0
to disable updating the list of printers during server restart.
For example, set the value to 0 if Actuate iServer uses printers
that are not detected by the operating system.
With a large number of printers configured for Actuate
iServer, performance drops significantly for operations such as
listing the printers in the Management Console.
Takes effect at system restart.
Category: Printing
Account to receive E-mail account that receives Actuate iServer administrative e-
administrative e-mail mail. For example, Actuate iServer sends an e-mail notice
Parameter: AdminEmail when Actuate iServer CPU license problems occur.
Specify an e-mail address recognized by Actuate iServer e-
mail servers. Default value is blank, Actuate iServer does not
send an e-mail message.
E-mail messaging must be configured on each node in the
Actuate iServer cluster.
Takes effect at system restart.
Category: Administrative
Configuration directory Partition for system configuration file and Actuate iServer
partition license file. Default is blank. Actuate iServer uses the Actuate
Parameter: iServer home etc directory on the master Actuate iServer node.
ConfigHomePartition When configuring cluster master failover specify an Actuate
iServer partition accessible to the current cluster master and
backup cluster masters.
Takes effect immediately.
Category: Configuration File

472 Administering Actuate iSer ver System

Display name
Server System parameter
List of backup servers for
the cluster master
Parameter:
MasterBackupList
Failover retry period when
IO failure occurs
Parameter:
FailoverRetryPeriod
Delay between each failover
retry when IO failure occurs
Parameter:
FailoverIOFailureDelay
Heartbeat failure period
Parameter:
HeartbeatFailurePeriod
Heartbeat send interval
Parameter:
HeartbeatSendPeriod
Multicast address
Parameter:
MulticastIPAddress
Multicast port
Parameter: MulticastPort
Multicast packet TTL
Parameter: MulticastTTL
Description
List of Actuate iServer nodes that are backup servers for the
cluster master.
Takes effect immediately.
Category: Failover
The failover retry period for master configuration file lock and
volume I/O file failure. Default is 300 seconds
Takes effect immediately.
Category: Failover
The time delay between each attempt of master configuration
file lock failover and volume failover after a file I/O failure.
Default is 30 seconds.
Takes effect immediately.
Category: Failover
Interval in seconds before detecting that the server has failed
because periodic communication was not received. Default
value is 90 seconds.
Takes effect at system restart.
Category: Heartbeat
Interval in seconds between sending two communication
messages. Default value is 30.
Takes effect at system restart.
Category: Heartbeat
Multicast Group Address used by Actuate iServer cluster for
heartbeat.
Takes effect at system restart.
Category: Heartbeat
Multicast Group Port used by Actuate iServer cluster to
receive heartbeat. Default value is 9300.
Takes effect at system restart.
Category: Heartbeat
If using Multicast, the maximum number of point-to-point
links (hops) allowed in a packets transmission path. Default
value is 1 hop.
Takes effect at system restart.
Category: Heartbeat
Chapter 14, Setting Actuate iServer parameters 473
Display name
Server System parameter Description
UDP port UDP port to use to receive heartbeat packets if Actuate iServer
Parameter: UDPPort does not use multicast. Default value is 9300.
Takes effect at system restart.
Category: Heartbeat
Use Multicast for cluster Flag to indicate multicast should be used for heartbeat. Default
heartbeats value is false.
Parameter: UseMulticast Takes effect at system restart.
Category: Heartbeat
Use as default volume Default Encyclopedia volume.
Parameter: Takes effect at system restart.
SystemDefaultVolume
Category: Load Balancing
Use externalized font file Specify how to use the customized_fonts.rox and
Parameter: master_fonts.rox files when searching for fonts when running
UseExternalizedFonts or viewing Actuate reports (ROX or ROI) by setting the value
to no, primary, or secondary. Default value is Primary.
Takes effect at system restart.
Category: Fonts
Maximum mail message Maximum size in KB of e-mail including attachment sent by
size Parameter: Actuate iServer. Minimum value is 100KB, maximum value is
MaxMailMessageSize 1048576KB, 1GB. Default size is 5120KB, 5MB.
Increase the value if Actuate iServer sends large e-mails, and
the mail server can receive greater sizes. For examples e-mails
containing RTF documents or PDF documents with many
images. Decrease the value limit the size of e-mails.
Most e-mail servers limit the maximum size of messages they
accept.
Takes effect at system restart.
Category: E-mail Transmission Limits

474 Administering Actuate iSer ver System

Display name
Server System parameter Description
Maximum number of Maximum number of e-mail address recipients allowed when
recipients per e-mail Actuate iServer sends a single e-mail. Default value is 10000.
message Range is from 100 to 100,000.
Parameter: If the number of e-mail recipients is larger than the value,
MaxMailRecipients Actuate iServer divides the list into smaller lists and sends
multiple e-mail messages using the smaller e-mail recipient
lists. Each e-mail message’s content is identical.
Most e-mail servers limit the number of recipients specified for
a single e-mail message.
Takes effect at system restart.
Category: E-mail Transmission Limits
Use dummy line in place of Flag to use value of UseDummyToLine in Actuate iServer
empty To: line e-mail notification To: line if both the To: and Cc: values are
Parameter: empty. Default value is true, use the DummyToLine value.
UseDummyToLine False disables using DummyToLine value.
Parameter used when Actuate iServer uses UNIX sendmail or
SMTP to send e-mail notification.
Takes effect at system restart.
Category: Empty To: Line In E-mail Message
Related parameter:
DummyToLine
Dummy To: line If UseDummyToLineString parameter is true, the text used in
Parameter: DummyToLine Actuate iServer e-mail notification To: line if both the To: and
Cc: values are empty. Default value is (names withheld).
Takes effect at system restart.
Category: Empty To: Line In E-mail Message
Related parameter:
UseDummyToLine
Enable SMTP Enables using SMTP e-mail servers for Actuate iServer e-mail
Parameter: UseSMTP notices. Default value is false, Actuate iServer uses Microsoft
Exchange on Windows systems and sendmail on UNIX
systems.
If the value is true, Actuate iServer uses SMTP e-mail servers.
Takes effect at system restart.
Category: E-mail Transmission Protocol

Chapter 14, Setting Actuate iServer parameters 475

 Usage and Error Logging parameters
The following table lists the Actuate iServer usage and error logging
parameters.

Display name
Usage and error logging
parameter
Deletion log enabled
Parameter:
DeletionLogEnabled
Deletion log level
Parameter:
DeletionLogLevel
Error log enabled
Parameter:
ErrorLogEnabled
Description
Actuate iServer usage logging extension records activity in a
log file when a user deletes an object from an Encyclopedia
volume. The default value is false, do not record activity.
If the value is true, Actuate iServer usage logging extension
writes information to a log file. Depending on the logging
extension, this might affect server performance. Writing
information to a log file increases disk space usage.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameters:
DeletionLogLevel
UsageLoggingExtensionName
Deletion log level. For the Actuate usage logging extension
that ships Actuate iServer, values are Standard and Detail.
Default value is Standard. Takes effect only when
DeletionLogEnabled is true.
Takes effect immediately.
Category: Usage And Error Log File Settings
Actuate iServer error logging extension records Actuate
iServer error information in a log file. Default value is false do
not record errors.
If the value is true, Actuate iServer writes information to a log
file. Depending on the logging extension, this might affect
server performance. Writing information to a log file increases
disk space usage.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameters:
ErrorLogLevel
ErrorLoggingExtensionName

476 Administering Actuate iSer ver System

Display name
Usage and error logging
parameter Description
Error logging extension Name of error logging DLL or shared library. Default value is
name ErrorLoggingExt. Takes effect when ErrorLogEnabled is true.
Parameter: Takes effect at system restart.
ErrorLoggingExtension
Name Category: Usage And Error Log File Settings
Related parameters:
ErrorLogLevel
ErrorLogEnabled
Error log level Specify the type of error information logged by the error
Parameter: ErrorLogLevel logging extension. Takes effect when ErrorLogEnabled is true.
Information logged depends on the error logging application
used with Actuate iServer. For the Actuate error logging
extension that ships Actuate iServer, values are Information,
Warning, Severe or Fatal. Default value is Information.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameters:
ErrorLogEnabled
ErrorLoggingExtensionName
Generation log enabled Actuate iServer usage logging extension records activity in a
Parameter: log file for Encyclopedia volume generation requests. The
GenerationLogEnabled default value is false, do not record activity.
If the value is true, Actuate iServer usage logging extension
writes information to a log file. Depending on the logging
extension, this might affect server performance. Writing
information to a log file increases disk space usage.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameter:
GenerationLogLevel
UsageLoggingExtensionName
Generation log level Generation log level. For the Actuate usage logging extension
Parameter: that ships Actuate iServer, values are Standard and Detail.
GenerationLogLevel Default value is Standard. Takes effect when
GenerationLogEnabled is true.
Takes effect immediately.
Category: Usage And Error Log File Settings

Chapter 14, Setting Actuate iServer parameters 477

Display name
Usage and error logging
parameter Description
Printing log enabled Actuate iServer usage logging extension records activity in a
Parameter: log file for Actuate iServer print requests. The default value is
PrintingLogEnabled false, do not record activity.
If the value is true, Actuate iServer usage logging extension
writes information to a log file. Depending on the logging
extension, this might affect server performance. Writing
information to a log file increases disk space usage.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameter:
PrintingLogLevel
Printing log level Printing log level. For the Actuate usage logging extension
Parameter: that ships Actuate iServer, values are Standard and Detail.
PrintingLogLevel Default value is Standard. Takes effect when
PrintingLogEnabled is true.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameter:
PrintingLogEnabled
Usage logging extension Name of usage logging DLL or shared library. Default value is
name UsrActivityLoggingExt. Used when a usage logging
Parameter: parameter is true.
UsageLoggingExtension Takes effect at system restart.
Name
Category: Usage And Error Log File Settings
Related parameters:
LogEnabled and LogLevel for Deletion, Printing, Generation,
Viewing, Administrative, and Integration.

478 Administering Actuate iSer ver System

Display name
Usage and error logging
parameter Description
Viewing log enabled Actuate iServer usage logging extension records activity in a
Parameter: log file for Encyclopedia volume viewing operations.
ViewingLogEnabled The default value is false, do not record activity. If the value is
true, Actuate iServer usage logging extension writes
information to a log file. Depending on the logging extension,
this might affect server performance. Writing information to a
log file increases disk space usage.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameter:
PrintingLogLevel
Viewing log level Viewing log level. For the Actuate usage logging extension
Parameter: that ships Actuate iServer, values are Standard and Detail.
ViewingLogLevel Default value is Standard. Takes effect only when
ViewingLogEnabled is true.
Takes effect immediately.
Category: Usage And Error Log File Settings
Administrative log enabled Actuate iServer usage logging extension records activity in a
Parameter: log file for Encyclopedia volume administrative operations.
AdminLogEnabled The default value is false, do not record activity. If the value is
true, Actuate iServer usage logging extension writes
information to a log file. Depending on the logging extension,
this might affect server performance. Writing information to a
log file increases disk space usage.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameter:
AdminLogLevel
Administrative log level Administrative operation log level. For the Actuate usage
Parameter: AdminLogLevel logging extension that ships Actuate iServer, values are
Standard and Detail. Default value is Standard. Takes effect
only when AdminLogEnabled is true.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameter:
AdminLogEnabled

Chapter 14, Setting Actuate iServer parameters 479

Display name
Usage and error logging
parameter
Integration server log
enabled
Parameter: EiiLogEnabled
Integration server log level
Parameter: EiiLogLevel
Usage and error log version
Parameter:
UsageAndErrorLogVersion
480 Administering Actuate iSer ver System
Description
Actuate iServer usage logging extension records activity in a
log file for Encyclopedia volume Integration service
operations. The default value is false, do not record activity.
If the value is true, Actuate iServer usage logging extension
writes information to a log file. Depending on the logging
extension, this might affect server performance. Writing
information to a log file increases disk space usage.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameter:
EiiLogLevel
Integration server log level. For the Actuate usage logging
extension that ships Actuate iServer, values are Standard and
Detail. Default value is Standard. Takes effect only when
EiiLogEnabled is true.
Takes effect immediately.
Category: Usage And Error Log File Settings
Related parameter:
EiiLogEnabled
Usage and error logging version level. Default value is 8, the
current version usage and error logging extension. Possible
values are 7 and 8.
7 specifies the previous release version. Actuate iServer
supports the previous release version usage and error logging
extension or the current version.
Change the value to 7 if you use a previous release usage and
error logging extension with Actuate iServer.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameters:
ErrorLoggingExtensionName
UsageLoggingExtensionName
Display name
Usage and error logging
parameter Description
Usage log file name Base name for the filename of the usage log file. Actuate
Parameter: iServer sends this value to the usage logging extension.
UsageLogFileName Default value is usage_log.
The Actuate usage logging extension that ships with Actuate
iServer uses this value to create a file name with extension csv.
A custom usage logging extension might not use this value.
The Actuate usage logging extension places the log file in the
Actuate iServer home log directory.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameter:
NumberOfUsageLogFiles
Usage log file size Maximum size of the usage log files in KB. If Actuate iServer
Parameter: uses multiple log files, this is the maximum size of each log
UsageLogFileSize file. Default value is 2048KB.
The Actuate usage logging extension that ships with Actuate
iServer uses this value. A custom usage logging extension
might not use this value.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameter:
UsageLoggingExtensionName
Number of usage log files Maximum number of usage log files. The default value is 2.
Parameter: The Actuate usage logging extension that ships with Actuate
NumberOfUsageLogFiles iServer uses this value to create log file names usage_log.csv
and usage_log_1.csv.
A custom usage logging extension might not use this value.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameter:
ErrorLoggingExtensionName

Chapter 14, Setting Actuate iServer parameters 481

Display name
Usage and error logging
parameter
Display date time as string
Parameter:
DateTimeAsString
Error log file name
Parameter:
ErrorLogFileName
Description
Specifies the format of a log entry date and time field for usage
and error logs. The format is either a string in the format mm/
dd/yyyy or an unsigned long specifying the number of
seconds since January 1, 1970.
The default value is false, use unsigned long format.
The Actuate usage and error logging extensions use this value.
A custom usage or error logging extension might not use this
value.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameters:
ErrorLoggingExtensionName
UsageLoggingExtensionName
Base name for the filename of the error log file. Actuate iServer
sends this value to the error logging extension.
Default value is error_log.
The Actuate error logging extension that ships with Actuate
iServer uses this value to create a file name with extension .csv.
A custom error logging extension might not use this value.
The Actuate error logging extension places the log file in the
Actuate iServer home log directory.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameter:
NumberOfErrorLogFiles

482 Administering Actuate iSer ver System

Display name
Usage and error logging
parameter
Error log file size
Parameter: ErrorLogFileSize
Number of error log files
Parameter:
NumberOfErrorLogFiles
Integration Service parameters
The following table lists the Actuate iServer Integration Service parameters.
Display name
Integration service
parameter
Enable integration service
Parameter:
EnableIntegrationService
Port for integration server
operations
Parameter: SOAPPort
Description
Maximum size of the error log files in KB. If Actuate iServer
uses multiple log files, this is the maximum size of each log
file.
The Actuate error logging extension that ships with Actuate
iServer uses this value. A custom error logging extension
might not use this value.
Default value is 2048KB.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameter:
ErrorLoggingExtensionName
Maximum number of error log files.
The default value is 2. The Actuate error logging extension
that ships with Actuate iServer uses the value to create file
names error_log.csv and error_log_1.csv.
A custom error logging extension might not use this value.
Takes effect at system restart.
Category: Usage And Error Log File Settings
Related parameters:
ErrorLoggingExtensionName
Description
Flag to enable or disable the Integration service. Default value
is false.
Takes effect immediately.
Category: General
TCP/IP port for Integration process communication with
Encyclopedia volume process. Default value is 11800. Range is
an integer between 1024 and 65535.
Takes effect at server restart.
Category: Process Communication
Chapter 14, Setting Actuate iServer parameters 483
Display name
Integration service
parameter
Port for integration server
queries
Parameter: NWPPort
Max SOAP requests
Parameter: MaxConnections
Max SOAP request threads
Parameter: MaxThreads
Max query run time
Parameter:
MaxQueryRunTime
Maximum query size in
rows
Parameter:
MaxQueryInputRows
Max memory per query
Parameter:
MaxQueryMemory
Log directory
Parameter: LogDirectory
Integration service log
Parameter: LoggingOn
484 Administering Actuate iSer ver System
Description
Port for Integration process communication when running
information objects. Default value is 11500. Range is an integer
between 1024 and 65535.
Takes effect at server restart.
Category: Process Communication
Maximum number of connections when communicating with
Encyclopedia volume process. Default value is 20. Range is an
integer between 4 and 1024.
Takes effect at server restart.
Category: Query Settings
Maximum number of threads when communicating with
Encyclopedia volume process. Default value is 8. Range is an
integer between 2 and 200.
Takes effect at server restart.
Category: Query Settings
Maximum time Actuate iServer allows for running a
information object query. Default value is 0. Range is an
integer between 0 and 65535
Takes effect at server restart.
Category: Query Settings
Maximum Query Size in Rows. Default value is 0. Range is an
integer between 0 and 65535.
Takes effect at server restart.
Category: Query Settings
Maximum memory allowed for an individual query. Default
value is 0. Range is an integer between 0 and 65535.
Takes effect at server restart.
Category: Query Settings
Integration service log directory. Default value is the Actuate
iServer home log directory.
Takes effect immediately.
Category: General Logging
Flag to enable or disable Integration service diagnostic
logging. Default value is true.
Takes effect immediately.
Category: General Logging
Display name
Integration service
parameter
Log level
Parameter: LogLevel
Log size
Parameter: LogSize
Number of log files
Parameter: NumLogs
Caching Service parameters
The following table lists the Actuate iServer Caching Service parameters.
Display name
Caching service parameter
Enable caching service
Parameter:
EnableCachingService
Port for caching server
operations
Parameter: SOAPPort
NWPPort
Parameter: NWPPort
Max SOAP requests
Parameter: MaxConnections
Description
Integration service log level. Default value is 8000.
Takes effect immediately.
Category: General Logging
Integration service log size in KB. Default value is 10000.
Takes effect immediately.
Category: General Logging
Maximum number of Integration service log files. Default
value is 1.
Takes effect immediately.
Category: General Logging
Description
Flag to enable or disable Actuate iServer Caching service.
Default value is false.
Takes effect immediately.
Category: General
TCP/IP port for Caching process communication with
Encyclopedia volume process.
Default value is 11200. Range is an integer between 1024 and
65535.
Takes effect at server restart.
Category: Process Communication
Port for Caching process communication with Integration
process. Default value is 0.
Takes effect at server restart.
Category: Process Communication
Maximum number of connections when communicating with
Encyclopedia volume process. Default value is 20. Range is an
integer between 2 and 1024.
Takes effect at server restart.
Category: LoadSettings
Chapter 14, Setting Actuate iServer parameters 485
Display name
Caching service parameter Description
Max SOAP request threads Maximum number of threads when communicating with
Parameter: MaxThreads Encyclopedia volume process. Default value is 8. Range is an
integer between 2 and 200.
Takes effect at server restart.
Category: LoadSettings
Log directory Caching service diagnostic log directory. Default value is the
Parameter: LogDirectory Actuate iServer home log directory.
Takes effect immediately.
Category: General Logging
Caching service log Flag to enable or disable Caching service diagnostic logging.
Parameter: LoggingOn Default value is true.
Takes effect immediately.
Category: General Logging
Log level Caching service diagnostic log level. Default value is 8000.
Parameter: LogLevel Takes effect immediately.
Category: General Logging
Log size Maximum Caching service diagnostic log size in KB. Default
Parameter: LogSize value is 10000.
Takes effect immediately.
Category: General Logging
Number of log files Maximum number of Caching service diagnostic log files.
Parameter: NumLogs Default value is 1.
Takes effect immediately.
Category: General Logging

486 Administering Actuate iSer ver System

 iServer node parameters
The following table lists the Actuate iServer node parameters

Display name
Server node parameter Description
Chart JVM parameter string JVM parameter string Actuate iServer uses when creating
Parameter: charts in a report object executable (.rox). Default value is an
ChartJVMParameterString empty string.
Takes effect at server restart.
Category: Chart Server
Chart server IP address IP address Actuate iServer uses when communicating with the
Parameter: Java chart software to create charts for a report object
ChartServerIPAddress executable (.rox). Default value is 127.0.0.1.
Do not change the default value.
Takes effect at server restart.
Category: Chart Server
Related parameter:
ChartServerPort
Chart server max heap size Maximum JVM heap size in MB Actuate iServer uses when
Parameter: using the Java chart software to create charts for a report object
ChartServerMaxHeapSize executable (.rox). Default value is 128.
You might need to increase this value, if your reports contain a
large number of large charts and you print or generate PDF.
Increase the value if Actuate iServer generates an
OutOfMemory Java exception when generating a chart.
If the value is very large, the Java process to generate charts
might compete with Actuate iServer for memory. Ensure that
the Actuate iServer machine has enough free memory to
accomodate the maximum heap size. Actuate recommends not
setting it to more than 256MB.
Takes effect at server restart.
Category: Chart Server

Chapter 14, Setting Actuate iServer parameters 487

Display name
Server node parameter
Chart server port number
Parameter: ChartServerPort
Configuration file for
database connections and
search path
Parameter: ConnConfigFile
Global search path for files
used in report design
Parameter:
ConnConfigSearchPath
Century break
Parameter: CenturyBreak
488 Administering Actuate iSer ver System
Description
Port number Actuate iServer uses when communicating with
the Java chart software to create charts for a report object
executable (.rox). Default value is 9032.
Change the value if another application is using the default
port number. Actuate recommends not using well known port
numbers such as 80, or 8080.
Takes effect at server restart.
Category: Chart Server
Related parameter:
ChartServerIPAddress
Configuration file provides database connection and data
source information used by Actuate report ROX files.
Actuate report ROX files use database connection information
and data source information from either the report’s
connection component or from the configuration file.
Takes effect at server restart.
Category: Database Connection Configuration
Related parameter:
ConnConfigSearchPath
Search paths for external resources the Actuate Basic ROX
uses. For example, graphics files or external libraries
referenced in a ROX that are retrieved at view time or during
report generation. Each path can be either relative or full path.
Actuate iServer also uses path information the SearchPath
section of the configuration file.
Takes effect at server restart.
Category: Database Connection Configuration
Related parameter:
ConnConfigSearchPath
How Actuate iServer converts two-digit year values into four-
digit years when the two-digit values are used. Default value
is 30.
Takes effect at server restart.
Category: Dates
Display name
Server node parameter
Let DateDiff() perform the
same behavior as VB 6.0
DateDiff()
Parameter:
UseOldABDateDiff
Description
Parameter: Description
Maximum heap size for Java
virtual machine
Parameter:
JVMMaxHeapSize
Volume used by the
Requester and Report Server
APIs
Parameter:
RequesterRSAPIVolume
Log directory
Parameter: LogDirectory
Description
Controls the DateDiff( ) function in Actuate Basic reports. Use
the functionality based on Microsoft Visual Basic .Net, or on
Microsoft Visual Basic 6.0. Default value is false, use the Visual
Basic .Net functionality.
Set the value to true if you view or run Actuate Basic reports
built with Actuate Release 7 or earlier software that use
DateDiff( ) with a ww or www date part indicator.
Takes effect immediately.
Category: Dates
Optional description of Actuate iServer node displayed in the
list of servers.
Takes effect immediately.
Category: General
Maximum heap size in MB of the Java VM used by the Actuate
iServer Factory and View processes for Actuate Basic reports.
Default value is 0, use the JVM default size.
Ensure that the Actuate iServer machine has enough free
memory to accommodate the maximum heap size. Actuate
recommends not setting it to more than 256MB.
Takes effect at server restart.
Category: Java Object Interface
Encyclopedia volume that Actuate iServer uses for Requester
and Report Server API.
Takes effect at system restart.
Category: RSAPI
Location of the Actuate iServer diagnostic log files. The default
directory is the Actuate iServer home log directory.
Specify the path to a directory on a files system where Actuate
iServer has read and write permissions.
Takes effect immediately.
Category: General Logging
Related parameter:
LoggingOn
Chapter 14, Setting Actuate iServer parameters 489
Display name
Server node parameter Description
Log level Level of logging for Actuate iServer diagnostic logging. Range
Parameter: LogLevel is from 0 to 8000. Default value is 8000. A value of 0 writes all
diagnostic messages to the log file. A value of 8000 writes only
warning or error messages to the log file.
Actuate recommends contacting Actuate support before
changing this value.
Setting the value to log more information degrades Actuate
iServer performance.
Takes effect immediately.
Category: General Logging
Related parameter:
LoggingOn
Log size (KB) Maximum size of the Actuate iServer diagnostic log files. The
Parameter: LogSize value is the maximum size for each log file. Actuate iServer
overwrites the log files when Actuate iServer reaches the
maximum number of log files and the log file reaches the
maximum size. The default is 10000. The minimum value is 0.
Change the value based on the information you want to keep
in the log file and the mount of disk space available.
Takes effect immediately.
Category: General Logging
Related parameter:
LoggingOn
Number of logs Maximum number of diagnostic log files Actuate iServer
Parameter: NumLogs maintains per server process. The default number of log files is
1. Increasing the number of log files will cause the Actuate
iServer process to write out the diagnostic messages to the
specified number of log files before overwriting an existing log
file.
Change the value based on the information you want to keep
in the log file and the mount of disk space available.
Takes effect immediately.
Category: General Logging
Related parameter:
LoggingOn

490 Administering Actuate iSer ver System

Display name
Server node parameter Description
Enable logging Enable diagnostic logging for Actuate iServer processes.
Parameter: LoggingOn Default value is true. At startup, each Actuate iServer process
creates a log file in the log directory.
Takes effect immediately.
Category: General Logging
Related parameters:
LogDirectory
LogLevel
LogSize
NumLogs
Application container The Actuate iServer application container port. Actuate
process listen port iServer uses application container to host web services
Parameter: applications. A port number is a valid, unused port, an integer
AppContainerPort between 1 and 65535.
The application container process hosts applications such as
Actuate Management Console and the Actuate Formula One
application engine that generates Formula One reports.
You can configure Actuate iServer to use a different
application server to host web services used by Actuate
iServer.
Takes effect at server restart.
Category: Application Container Process
Base socket number for Needed for RSAPI. Specify the start of a range of port numbers
reply to client for ports used for communication between Actuate iServer
Parameter: and clients or Actuate ReportCast. Default is 0. Maximum
BaseSocketNumForReply value is 32767.
If the start of the range of port numbers is not set, Actuate
iServer ignores the range setting. If the start of the range is set
and the range is not set, Actuate iServer uses a default range of
1.
Takes effect at server restart.
Category: Sockets

Chapter 14, Setting Actuate iServer parameters 491

Display name
Server node parameter
Base socket number for RPC
Parameter:
BaseSocketNumForRPC
Number of sockets for reply
to client
Parameter:
NumSocketsForReply
Number of RPC sockets
Parameter:
NumSocketsForRPC
IP address for server SOAP
endpoint
Parameter: ServerIPAddress
Port number for server
SOAP endpoint
Parameter: ServerSOAPPort
492 Administering Actuate iSer ver System
Description
Needed for RSAPI. Specify the start of a range of port numbers
Actuate iServer attempts to use for the request server RPC
ports. Default is 0. The maximum value is 32767.
If the start of the range of port numbers is not set, Actuate
iServer ignores the range setting. If the start of the range is set
and the range is not set, Actuate iServer uses a default range of
1.
Actuate iServer starts at the BASE port and attempts to use up
to BASE + COUNT - 1 port to find a single port.
Takes effect at server restart.
Category: Sockets
Needed for RSAPI. Specify the range of port numbers for ports
used for communication between Actuate iServer and clients
or Actuate ReportCast. Default is 1. Maximum value is 32767.
If the start of the range of port numbers is not set, Actuate
iServer ignores the range setting. If the start of the range is set
and the range is not set, Actuate iServer uses a default range of
1.
Takes effect at server restart.
Category: Sockets
Needed for RSAPI. Specify the range of port numbers Actuate
iServer attempts to use for the request server RPC ports.
Default is 1. Maximum value is 32767.
If the start of the range of port numbers is not set, Actuate
iServer ignores the range setting. If the start of the range is set
and the range is not set, Actuate iServer uses a default range of
1. Actuate iServer starts at the BASE port and attempts to use
up to BASE + COUNT - 1 port to find a single port.
Takes effect at server restart.
Category: Sockets
IP Address for Server SOAP Endpoint.
Takes effect at server restart.
Category: Server Configuration
Port number for server SOAP endpoint. Default value is 9300.
Takes effect at server restart.
Category: SOAP Settings
Display name
Server node parameter
Port base for internal soap
messages
Parameter:
ServerSOAPPortBase
Port count from base for
internal soap messages
Parameter:
ServerSOAPPortCount
Description
Port base for internal soap messages. Default value is 9500.
Takes effect at server restart.
Category: SOAP Settings
Port count from base for internal soap messages. Default value
is 500.
Takes effect at server restart.
Category: SOAP Settings
Chapter 14, Setting Actuate iServer parameters 493
 Encyclopedia volume parameters
The following table lists the Actuate iServer Encyclopedia volume parameters.

Display name
Encyclopedia volume
parameter Description
Expiration time of failed jobs Controls the lifetime of failure job entries on an Encyclopedia
Parameter: volume Jobs—Completed page. Failure job entries are purged
FailureJobExpiration during the job purge time when Actuate iServer does not find
an associated notice in an Encyclopedia volume channel and
the job entry lifetime has exceeded FailureJobExpiration (in
units of minutes).
Default value is 43200 minutes, 30 days. Minimum value is 0.
A job entry is purged during the scheduled job purge times
specified by ScheduleForPurgingNotices. Also, Actuate
iServer does not purge a job entry on Jobs—Completed the
job’s associated completed notices are all deleted from
Encyclopedia volume channels. Notified user's notice purge
settings also affect a job entry’s lifetime.
Purging notices helps reduce the Encyclopedia volume size
and contributes to better iServer performance. The
administrator should choose the smallest number that satisfies
their job retention policy.
A large number of jobs notices kept in the Encyclopedia
volume, might cause increased disk space usage and reduced
Actuate iServer performance.
Takes effect immediately.
Category: Archiving And Purging
Related parameter:
ScheduleForPurgingNotices
Default expiration time of Default volume expiration time in minutes for successful
success notices completed notices. Users can set their Job property to use this
Parameter: value.
DefaultSuccessNotice Default value is 0, the notices never expire. Specify the number
Expiration of minutes before Actuate iServer deletes a success job notice.
If a user specifies 0 for success notice expiration, Actuate
iServer uses the value from DefaultSuccessNoticeExpiration.
Takes effect immediately.
Category: Archiving And Purging

494 Administering Actuate iSer ver System

Display name
Encyclopedia volume
parameter
Default expiration time of
failure notices
Parameter:
DefaultFailureNotice
Expiration
Volume archive library path
Parameter:
ObjectArchiveDLL
Command line to start
Volume Archive Service
provider
Parameter:
ArchiveServiceCmd
Description
Default volume expiration time in minutes for failure
completed notices. Users can set their Job property to use this
value.
Default value is 0, the notices never expire. Specify the number
of minutes before Actuate iServer deletes a failure job notice.
If a user specifies 0 for failure notice expiration, Actuate
iServer uses the value from DefaultFailureNoticeExpiration.
Takes effect immediately.
Category: Archiving And Purging
Specify C-based archive DLL or shared object used for
Encyclopedia volume Auto Archive.
If you use an autoarchive application, specify only one of
either C-based archive library using ObjectArchiveDLL or the
SOAP-based archiving application using ArchiveServiceCmd.
Takes effect immediately.
Category: Archiving And Purging
Related parameter:
ArchiveServiceCmd
Specify the command to start the SOAP-base AutoArchive
application.
If you use an autoarchive application, specify only one of
either C-based archive library using ObjectArchiveDLL or the
SOAP-based archiving application using ArchiveServiceCmd.
Takes effect immediately.
Category: Archiving And Purging
Related parameter:
ObjectArchiveDLL
Chapter 14, Setting Actuate iServer parameters 495
Display name
Encyclopedia volume
parameter Description
Schedule for purging notices The start times when Actuate iServer removes expired
Parameter: requests from the Encyclopedia volume’s Jobs—Completed
ScheduleForPurgingNotices page. Default value is 2:15, run the task to remove expired
requests daily at 2:15am.
The format is a list of times separated by semicolons, in
ascending order, using a 24-hour format. For example,
03:15;16:15.
An empty string for this parameter disables the job entry and
channel notice purging and is not recommended.
System administrator should specify one or more times during
the day when Actuate iServer not busy.
The times should not overlap with times Actuate iServer runs
AutoArchive.
Takes effect immediately.
Category: Archiving And Purging
Related parameters:
SuccessJobExpiration
FailureJobExpiration

496 Administering Actuate iSer ver System

Display name
Encyclopedia volume
parameter
Expiration time of Success
Job
Parameter:
SuccessJobExpiration
Partition for Notification
Configuration Files
Parameter:
NotificationConfigPartition
Primary server
Parameter: PrimaryServer
Description
Controls the lifetime of success job entries on an Encyclopedia
volume Jobs—Completed page. Success job entries are purged
during the job purge time when Actuate iServer does not find
an associated notice in an Encyclopedia volume channel and
the job entry lifetime has exceeded FailureJobExpiration (in
units of minutes).
Default value is 43200 minutes, 30 days. Minimum value is 0.
A job entry is purged during the scheduled job purge times
specified by ScheduleForPurgingNotices. Also, Actuate
iServer does not purge a job entry on Jobs—Completed the
job’s associated completed notices are all deleted from
Encyclopedia volume channels. Notified user's notice purge
settings also affect a job entry’s lifetime.
Purging notices helps reduce the Encyclopedia volume size
and contributes to better iServer performance. The
administrator should choose the smallest number that satisfies
their job retention policy.
A large number of jobs notices kept in the Encyclopedia
volume, might cause increased disk space usage and reduced
Actuate iServer performance.
Takes effect immediately.
Category: Archiving And Purging
Related parameter:
ScheduleForPurgingNotices
Actuate iServer partition for e-mail notification configuration
file. Default is the Actuate iServer home etc.directory. With the
default value in an Actuate iServer cluster, each View process
uses the notification template in the local etc directory when
processing e-mail notification.
Specify an Actuate iServer partition when using multiple View
services for e-mail notification in an Actuate iServer cluster to
use a single e-mail notification configuration file.
Takes effect at volume restart.
Category: Configuration File Partition
The Actuate iServer node that is the current owner of the
Encyclopedia volume.
Takes effect immediately.
Category: Failover Settings
Chapter 14, Setting Actuate iServer parameters 497
Display name
Encyclopedia volume
parameter
Description
Parameter: Description
Secondary servers that can
manage the volume
Parameter: ServerList
Volume data store location
Parameter: PrimaryPartition
Volume data store directory
minimum space
Parameter:
PrimaryPartitionMinSpace
498 Administering Actuate iSer ver System
Description
Optional description of the Encyclopedia volume displayed in
list of volumes.
Takes effect immediately.
Category: General
List of Actuate iServer nodes that can manage the
Encyclopedia volume in case of volume failover.
Takes effect immediately.
Category: Failover Settings
Specifies the Actuate iServer partition that is an Encyclopedia
volume’s primary partition. The partition’s physical location
on the server file system server is determined by the
ServerFileSystemSetting variable for that Actuate iServer.
Actuate iServer installation creates a default partition in the
Actuate iServer home encyc directory. Actuate iServer uses
this partition as the default Encyclopedia volume’s primary
partition.
Takes effect at volume restart.
Category: Meta Data Partition
Related parameters:
PrimaryPartitionMinSpace
TranslogPartition
Minimum disk space required on an Encyclopedia volume's
primary partition. Default value is 128 MB. This is also the
recommended minimum value.
Actuate iServer takes the volume offline when the partition’s
available disk space drops below this value.
Increase the value if an application using the primary partition
disk consumes disk space at a fast rate, or if the primary
partition disk is subject to fragmentation.
Takes effect at volume restart.
Category: Meta Data Partition
Related parameter:
PrimaryPartition
Display name
Encyclopedia volume
parameter Description
URL Prefix for Active Portal Active Portal for .NET URL prefix Actuate iServer uses when
for .NET creating a link in an e-mail that notifies users of report
Parameter: generation status.
ActivePortalForDotNETUR Takes effect immediately.
L
Category: Notification
Prefix
Related parameter:
EmailURLType
Active Portal URL Prefix Active Portal for JSP URL prefix Actuate iServer uses when
Parameter: creating a link in an e-mail that notifies users of report
ActivePortalURLPrefix generation status.
Takes effect immediately.
Category: Notification
Related parameter:
EmailURLType
URL for E-mail Notifications Type of URL specified in a e-mail. Type can be ActivePortal,
Parameter: EmailURLType ActivePortalForDotNet, ReportCast, or All. Default value is
ActivePortal.
Takes effect immediately.
Category: Notification
Related parameters:
ActivePortalURLPrefix
ActivePortalForDotNETURLPrefix
ReportCast URL Prefix ReportCast URL prefix Actuate iServer uses when creating a
Parameter: link in an e-mail that notifies users of report generation status.
ReportCastURLPrefix Takes effect immediately.
Category: Notification
Related parameter:
EmailURLType

Chapter 14, Setting Actuate iServer parameters 499

Display name
Encyclopedia volume
parameter Description
MDS URL in e-mail Controls the value of the serverURL parameter in a hyperlink
hyperlink to report contained in an Actuate iServer e-mail notification message.
Parameter: ServerURL The default value is no value, Actuate iServer uses an Actuate
iServer node in the cluster that is online and has the Message
Distribution service enabled.
An Actuate iServer e-mail notification can contain a hyperlink
to a document in an Encyclopedia volume, for example:
http://machine1:8700/acweb/newrequest/
index.aspx?__requestType=scheduled&__executableName=/
forecast.rox%3B1&serverURL=http://
end2243:8000&volume=volume1

ServerURL controls the value of the serverURL parameter in

the URL. In the example, the serverURL parameter and value
are:
serverURL=http://end2243:8000
Include the http prefix when specifying a value, for example,
http://new-server:8400
Takes effect immediately.
Category: Notification
Encyclopedia memory Amount of memory reserved for Encyclopedia volume
buffer pool size database memory buffer pool. The default is 10 MB. The
Parameter: BufferPoolSize memory buffer pool caches volume file metadata in memory
to increase performance and concurrency.
The default 10 MB is the recommended minimum for any
system. A value of 100MB is recommended for a production
system with low to moderate load. Actuate recommends
keeping the value lower than the amount of physical memory
available to Actuate iServer.
One indication of insufficient buffer pool size is increased disk
I/O traffic to files in the Encyclopedia volume's db directory.
When Actuate iServer performance does not scale and you
think the Encyclopedia volume is the bottleneck, increase this
value.
Increasing this value increases the memory usage of the
Actuate iServer encycsrvr process managing the Encyclopedia
volume. and it might reduce disk I/O and improve encycsrvr
performance.
Takes effect at volume restart.
Category: Performance

500 Administering Actuate iSer ver System

Display name
Encyclopedia volume
parameter Description
Is a Sample Application Flag to specify the Encyclopedia volume is a sample
volume application volume. Default value is false.
Parameter: IsSampleVolume Takes effect at volume restart.
Category: Sample Application
Enable open security Enables Actuate iServer RSSE open security and uses the C-
Parameter: based RSSE library. Default value is false.
EnableOpenSecurity If you enable or disable open security on an existing
Encyclopedia volume, you might need to use the Actuate
utility acextern or acintern.
Aextern prepares an Encyclopedia volume for use with open
security enabled. Acintern prepares an Encyclopedia volume
when you disable open security.
Takes effect at volume restart.
Category: Security Extension
Related parameters:
RSSELibrary
RSSEMultiThreadSafeLibrary
RSSECacheTimeout
Timeout for open security Controls the time an security information resides in the
cache Actuate iServer cache after Actuate iServer retrieves the
Parameter: information from the RSSE application. The default is 60
RSSECacheTimeout minutes. The minimum is 1 minute.
Change the value to match the frequency of change in the
RSSE external security source. If the information does not
change often, increase the value. If the information changes
frequently, lower the value.
In general, better performance occurs with a larger value.
Actuate iServer reuses cache data from the RSSE data source
and does not retrieve data from the data source. Increasing the
value increases the risk of using stale security information.
Takes effect at volume restart.
Category: Security Extension
Related parameters:
EnableOpenSecurity
EnableRSSEService

Chapter 14, Setting Actuate iServer parameters 501

Display name
Encyclopedia volume
parameter Description
Open security library The name and location of the C-based RSSE library. Actuate
location iServer uses this value if EnableOpenSecurity is set to true.
Parameter: RSSELibrary Takes effect at volume restart.
Category: Security Extension
Related parameters:
EnableOpenSecurity
Maximum ACL buffer size Maximum buffer size sent to the RSSE to retrieve a user ACL
Parameter: string. The default value is 65536 bytes, 64KB.
RSSEMaxACLBufferSize Increase the value if the RSSE application sends ACL strings
that have a maximum lengths larger than the default value.
Actuate iServer uses the value if EnableOpenSecurity is true.
Takes effect at volume restart.
Category: Security Extension
Related parameters:
EnableOpenSecurity
Open security library is Specifies that the RSSE application is multi-thread safe.
multi-thread safe Default is false, Actuate iServer serializes calls to the library.
Parameter: Serializing calls affects performance and concurrency of client
RSSEMultiThreadSafe messages sent to Actuate iServer.
Library
When processing multiple, simultaneous requests, a multi-
thread safe RSSE application provides better performance than
an application that must process request serially.
Actuate iServer uses the value if EnableOpenSecurity is true.
Takes effect at volume restart.
Category: Security Extension
Related parameters:
EnableOpenSecurity

502 Administering Actuate iSer ver System

Display name
Encyclopedia volume
parameter
Enable RSSE service
Parameter:
EnableRSSEService
RSSE service IP address
Parameter: RSSEIPAddress
RSSE service port
Parameter: RSSESoapPort
RSSE context string to form
request URL
Parameter:
RSSEContextString
Description
Enables Actuate iServer RSSE open security and use the
SOAP-based web service. Default value is false.
If you enable or disable open security on an existing
Encyclopedia volume, you might need to use the Actuate
utility acextern or acintern.
Aextern prepares an Encyclopedia volume for use with open
security enabled. Acintern prepares an Encyclopedia volume
when you disable open security.
Takes effect at volume restart.
Category: Service
Related parameters:
RSSEIPAddress
RSSESOAPPort
RSSECacheTimeout
The server name or IP address where the RSSE service resides.
Default value is localhost.
Takes effect at volume restart.
Category: Service
Related parameter:
EnableRSSEService
The port number at which the RSSE service resides on a
machine. Default value is 8900.
Takes effect at volume restart.
Category: Service
Related parameter:
EnableRSSEService
Specifies the context string of the request URL to send a
message to the RSSE service. Default value is
/acrsse/servlet/AxisServlet
Takes effect at volume restart.
Category: Service
Related parameter:
EnableRSSEService
Chapter 14, Setting Actuate iServer parameters 503
Display name
Encyclopedia volume
parameter
Enable volume failover
when RSSE fails
Parameter:
EnableRSSEFailover
Command line to control
initiation for RSSE service
Parameter:
RSSECommandLineStart
Maximum number of
elements that can be
returned in one RSAPI
request
Parameter:
RSAPIFetchLimit
504 Administering Actuate iSer ver System
Description
Enables Actuate iServer Encyclopedia volume failover when
the volume is using an RSSE application. Default is true.
If set to true and Actuate iServer managing the volume cannot
connect to the web service for the RSSE service, Actuate
iServer starts the Encyclopedia volume failover process.
Volume must be configured for failover.
Takes effect at volume restart.
Category: Service
Related parameters:
EnableRSSEService
The command Actuate iServer issues if the web service for the
RSSE service is not running.
If Actuate iServer cannot connect to the web service for the
RSSE service, Actuate iServer starts an operating system shell
and runs the value as command line request.
Takes effect at volume restart.
Category: Service
Related parameters:
EnableRSSEService
For applications that use the Actuate Report Server API,
specifies the maximum number of items Actuate iServer
returns in a RSAPI list. Actuate iServer truncates the list if a
RSAPI call results in a list that contains more elements than the
value specified. The default is 5000 and is the recommended
value. The minimum value is 0.
Actuate recommends using incremental fetch features to
retrieve large lists. Increase the value to the size of the longest
list sent by Actuate iServer if incremental fetch features cannot
be used.
When Actuate iServer encounters performance problems such
as excessive memory usage caused by a RSAPI application
frequently retrieving large lists, decreasing this value might
improve performance, but might cause the RSAPI application
problems when returning a large number of items.
Takes effect at volume restart.
Category: Fetch Limits
Display name
Encyclopedia volume
parameter Description
Custom encyclopedia DB Actuate iServer partition used for an Encyclopedia volume’s
log partition transaction log. The default, with no value specified, is the
Parameter: Encyclopedia volume’s primary partition.
TransLogPartition The iServer installation creates a default partition located in
Actuate iServer home encyc directory, and sets the default
Encyclopedia volume and the volume’s transaction log to use
the partition.
Specifying an Actuate iServer partition for the transaction log
might increase Actuate iServer performance. If the Actuate
iServer uses the transaction log frequently, performance might
improve if you place transaction log partition on a disk with
fast I/O.
The actual physical location of the Actuate iServer partition is
the value of ServerFileSystemSetting.
Takes effect at volume restart.
Category: Log Files Partition
Related parameters:
PrimaryPartition
TranslogPartitionMinSpace
Encyc DB log partition Minimum disk space required for the Actuate iServer partition
minimum space used by an Encyclopedia volume's transaction log. Actuate
Parameter: iServer takes the volume offline when the partition’s available
TransLogPartitionMinSpace disk space drops below this value.
Default value is 128 MB is the recommended minimum value.
Actuate recommends a large value if the disk hosting the
primary partition is subject to fragmentation.
To avoid out of disk space errors, increase the value if an
application that uses the transaction log partition disk
consumes disk spaces at a fast rate.
Takes effect at volume restart.
Category: Log Files Partition
Related parameter:
TranslogPartition

Chapter 14, Setting Actuate iServer parameters 505

Display name
Encyclopedia volume
parameter Description
Volume default Actuate The full path to an existing Actuate Query Template.
Query template file If the value is missing, empty, or invalid, Actuate iServer uses
Parameter: the template file that is installed with the Encyclopedia
DefaultQueryTemplate volume.
Actuate iServer uses an Actuate Query Template file to format
the Actuate Query output. Actuate iServer uses the default
template file to format output when a user runs an Actuate
Query query using an information object that does not specify
a template file.
Takes effect immediately.
Category: Actuate Query Generation
Number of times to retry Number of times to retry failed generation or print requests.
failed requests Range is from 0 to 30. Default value is 0.
Parameter: Takes effect immediately.
NumRequestRetries
Category: Asynchronous Job Retries
Time after which to retry Time after which to retry failed asynchronous requests
failed request (Seconds). Range is from 0 32767. Default value is 0.
Parameter: Takes effect immediately.
RequestRetryInterval
Category: Asynchronous Job Retries

506 Administering Actuate iSer ver System

 Volume partition configuration parameters
The following table lists the Actuate iServer Volume-specific Partition
configuration parameters

Display name
Volume partition parameter Description
Description Optional description of the Encyclopedia volume. Actuate
Parameter: Description iServer displays the description in list of volumes.
Takes effect immediately.
Category: General
Warning threshold for low Minimum file system free disk space warning level for a
partition disk space volume’s partition. Default is 512MB.
Parameter: If a user tries to create a file in a partition with less than
LowFreeSpaceMB LowFreeSpaceMB free disk space, Actuate iServer displays a
warning and writes a warning to the log file. File creation
succeeds.
Takes effect immediately.
Category: Partition
Related parameter:
MinFreeSpaceMB

Chapter 14, Setting Actuate iServer parameters 507

Display name
Volume partition parameter Description
Minimum partition disk File creation requests for an Encyclopedia volume’s partition
space required for file fail if the partition free disk space is less than
creation MinFreeSpaceMB. Default 128MB.
Parameter: If the volume partition's free disk space falls below this value,
MinFreeSpaceMB Actuate iServer stops using the partition to store Encyclopedia
volume files. If all partitions used by a volume are below their
minimum settings, Actuate iServer cannot create new files in
the volume.
A large value prevents Actuate iServer from filling up disks to
a level that causes disk fragmentation. A large value reduces
the disk space that iServer can use on the partition.
A smaller value allows more space on the partition for
Encyclopedia volume files. A smaller value increases the risk
of operation failures when disk space is low.
Takes effect immediately.
Category: Partition
Related parameter:
LowFreeSpaceMB
Partition state Partition status. Values are Active, Phaseout, Unused, and
Parameter: State Unavailable. Default value is Unused.
When the state is Active, an Encyclopedia volume is using the
partition to store files. When the state is Phaseout, an
Encyclopedia volume is not adding new files to the partition.
The partition might contain files. When the state is Unused, no
Encyclopedia volume is using the partition.
Actuate iServer sets a partition’s state to Active when you add
a partition to an Encyclopedia volume.
Actuate iServer sets a Encyclopedia volume partition’s state to
Phaseout when you change the partition’s state from start to
stop and the partition contains volume files.
Actuate iServer sets the partition state to unused when all files
are moved out of the partition.
Takes effect immediately.
Category: Partition

508 Administering Actuate iSer ver System

 Viewing Service parameters
The following table lists the Actuate iServer Viewing Service parameters
Display name
Viewing service parameter
Viewing weight
Parameter: ViewingWeight
Enable viewing service
Parameter:
EnableViewingService
Maximum concurrent
requests
Parameter:
MaxConcurrentRequests
Timeout for process file
cache
Parameter:
FileCacheTimeout
Description
Relative value Actuate iServer uses to distribute viewing
requests among Actuate iServer nodes with the View service
enabled in an Actuate iServer cluster. Default value is 100.
Takes effect immediately.
Category: Cluster Load Balancing
Flag to enable or disable the View service. Default value is
false.
Takes effect immediately.
Category: General
Maximum number of concurrent requests handled by a View
process. Default value is 128.
Takes effect immediately.
Category: Request Management
Controls the timeout of a View process file cache. The default
Value 86400 seconds, 1 day, is the recommended value.
Actuate recommends a value between the range of 3600, 1
hour and 259200, 3 days.
The View process uses the timeout value to determine which
objects to purge when Actuate iServer accesses the file cache.
For an Actuate Basic report, a View process puts objects such
as images, audio, video, and applets into the file cache.
The View process cache is a disk cache, increasing the timeout
might cause more disk space usage.
Change the value based on the objects a View process stores in
the file cache and user viewing habits.
If you decrease the timeout value, for example to 300 seconds,
5 minutes, the View process might purge cache objects too
frequently and degrade viewing performance.
If you increase the value, for example to 259200, 3 days, the
user might see outdated images in a report.
Takes effect at server restart.
Category: File Caching
Related parameters:
MaxFileCacheEntriesPerProcess
MaxFileCacheSizePerProcess
Chapter 14, Setting Actuate iServer parameters 509
Display name
Viewing service parameter Description
Maximum file cache entries Maximum number of entries in a View process cache. Default
per process value is 3000. Range is from 5 to 20000. If the value is less than
Parameter: 5, 5 is used. If the value is greater than 20000, 20000 is used.
MaxFileCacheEntriesPer Actuate recommends a value between the values of 500 and
Process 10000.
Increase the value if a View process requires more file cache
entries. For example, when generating PDF, the View process
stores all images in the file cache and writes them to PDF file
when generating the PDF file. If a report contains more than
3000 images, you must increase the value generate a PDF file
from the report.
If the size of the objects in the file cache reaches the maximum
allowed size, the View process replaces old objects with new
ones, even if the number of objects is less than the maximum
allowed.
The file cache is a disk cache, increasing the value might
increase the disk space a View process uses.
Takes affect at server restart.
Category: File Caching
Related parameters:
FileCacheTimeout
MaxFileCacheSizePerProcess

510 Administering Actuate iSer ver System

Display name
Viewing service parameter Description
Maximum file cache size per Maximum file cache size per View process. Default value is
process 50MB. The value can be any positive integer.
Parameter: The cache size is for each View process. An Actuate iServer
MaxFileCacheSizePer node with the View service enabled can run several View
Process processes simultaneously. The maximum cache size for all
View processes allowed on the Actuate iServer machine must
be less than the amount of free disk space available on the
system.
The cache is a disk cache. If the value is too small, for example
smaller than 1MB, the View process clears the cache frequently
and degrades viewing performance. If the value is too large,
for example larger than 1GB, Actuate iServer might increase
temporary disk space usage.
If the number of the objects in the file cache reaches the
maximum allowed, the View process replaces old objects with
new ones, even if the total size of the objects is less than the
maximum allowed.
Takes effect at server restart.
Category: File Caching
Related parameters:
FileCacheTimeout
MaxFileCacheEntriesPerProcess

Chapter 14, Setting Actuate iServer parameters 511

Display name
Viewing service parameter Description
Enable extended view cache Controls View process caching of report documents. Default
Parameter: value is NoCache. Values are NoCache, CacheAll, PLSOnly.
ExtendedViewingCache NoCache turns off caching, PLSOnly caches previous viewing
operations when viewing Actuate Basic reports with page-
level security enabled, and CacheAll caches previous viewing
operations for all reports.
If users experience poor performance when viewing Actuate
Basic reports that use page-level security, Actuate
recommends contacting Actuate support before changing this
value.
Caching is done on a per user and per Actuate Basic report
basis. The viewing cache is memory based and increases the
amount of virtual memory used by a View process. Extended
view caching improves performance but requires a substantial
amount of additional memory.
Change the value to enable caching to improve the
performance of viewing an Actuate Basic report, and in
particular a report that uses page-level security. Set the value
to PLSOnly to enable the cache only for a report document that
uses Page Level Security used the PLSOnly option.
When setting this value to PLSOnly or CacheALL you might
need to modify the related viewing cache parameters.
Takes effect at system restart.
Category: ROI Cache
Related parameters:
MaxExtendedViewingCacheSizePerProcess
ExtendedViewingCacheTimeout
MaxExtendedViewingUserCacheSizePerProgram

512 Administering Actuate iSer ver System

Display name
Viewing service parameter Description
Extended viewing cache Controls the cache timeout value when
timeout ExtendedViewingCache parameter is CacheAll or PLSOnly.
Parameter: Default value is 1200, the minimum value is 0. Actuate
ExtendedViewingCache recommends a value between 600 and 7200. If the value is 0,
Timeout Actuate iServer does not use the cache.
The caching is done on a per user and per Actuate basic report
basis.
Depending on user report viewing patterns, reducing the
value, might reduce the amount of memory a View process
uses without degrading viewing performance. For example,
increase the value if users view a report for longer than longer
than 20 minutes, 1200 seconds or decrease the value if users
view a report for less than longer than 20 minutes.
Takes effect at server restart.
Category: ROI Cache
Related parameters:
ExtendedViewingCache
MaxExtendedViewingCacheSizePerProcess

Chapter 14, Setting Actuate iServer parameters 513

Display name
Viewing service parameter Description
Maximum Number of Maximum number of report document entries cached when
Entries for Extended ExtendedViewingCache value is CacheAll or PLSOnly. Default
Viewing Cache value is 300. Actuate iServer uses 0 if you specify a negative
Parameter: integer. A value of 0 disables the cache.
MaxExtendedViewingCache The caching is done on a per user and per Actuate basic report
SizePerProcess basis.
Actuate recommends contacting Actuate support before
changing this value. Actuate recommends a value between the
range of 100 and 1500.
To disable the extended viewing cache, set
ExtendedViewingCache to NoCache. Do not set
MaxExtendedViewingCacheSizePerProcess to 0.
Depending on user report viewing patterns, reducing the
value, might reduce the amount of memory a View process
uses without degrading viewing performance.
The cache is memory based and impacts the amount of virtual
memory used by the Actuate View processes.
Setting the cache size is too large, for example larger than 1500,
might cause inefficient use of memory by the View process,
and degrade system performance.
If you increase the cache size, decreasing
ExtendedViewingCacheTimeout might increase memory
usage efficiency by releasing unused memory more quickly.
Takes effect at server restart.
Category: ROI Cache
Related parameters:
The following Extended Viewing Cache settings:
ExtendedViewingCache
ExtendedViewingCacheTimeout

514 Administering Actuate iSer ver System

Display name
Viewing service parameter Description
Maximum number of Maximum number of cached ROX files used by a View
cached ROX files process. The default value is 128. The minimum value 0
Parameter: disables the cache. Do not set the value to 0. Actuate
MaxROXCacheSizePer recommends a value between the range of 64 to 512.
Process Increase the value if a View process uses more than 128 ROX
files. Increasing the value improves the viewing performance
and uses more memory.
Setting the value too low, for example to less than 64 might
increase disk I/O and degrade viewing performance. Setting
the value is too high, for example, greater than 1024, might
cause inefficient use of memory by the View process, and
degrade system performance.
If you increase MaxROXCacheSizePerProcess, decreasing
MaxROXCacheSizeTimeout might improve performance by
freeing unused memory more quickly.
Takes effect at server restart.
Category: ROX Cache
Related parameters:
MaxROXCacheSizeTimeout
Maximum timeout for Timeout for ROX files in the ROX cache. ROX cache is a View
cached ROX files process memory-based cache. The default value is 3600
Parameter: seconds. The minimum value is 0 disables the ROX cache. Do
MaxROXCacheSizeTimeout not set the value to 0.
Decrease the value if users frequently view Actuate Basic
reports generated by different ROX files.
Setting the value too low for example, to less than 600 causes
decreases the viewing performance by increasing file I/O.
Setting to large a value, for example larger than 86400,
decreases the effectiveness of the purging algorithm and
increases memory use.
If you increase MaxROXCacheSizeTimeout, increasing
MaxROXCacheSizePerProcess might also increase
performance by allowing more ROX files to stay in the cache
that might otherwise be purged due to the cache size limit.
Takes effect immediately.
Category: ROX Cache
Related parameter:
MaxROXCacheSizePerProcess

Chapter 14, Setting Actuate iServer parameters 515

Display name
Viewing service parameter Description
ACL cache timeout Maximum time interval a View process waits to check an
Parameter: ACLTimeout Encyclopedia volume document’s ACL and access
permissions while a user is viewing the document. Default
value is 3600 seconds.
The View process purges the user’s View session cache if there
is a change in the ACL or the access permissions. View process
does not purge the cache if there is no change.
Change the value based on the expected amount of changes to
a document’s ACL and permissions.
A small value might cause the View process to perform checks
and cache purges frequently and degrade viewing
performance.
Takes effect at server restart.
Category: Session Cache
Related parameter:
SessionCacheTimeout
Maximum cached sessions Maximum number of view sessions (user and .roi files) in the
per process view session cache. Default value is 4096.
Parameter: Takes effect at server restart.
SessionCacheSizePerProcess
Category: Session Cache
Session cache timeout Number of seconds before invalidating the contents of a user’s
Parameter: View session cache. Default Value: 3600 seconds
SessionCacheTimeout After session cache times out, the View process purges the
cache when:
■ A user access the cache data
■ The View process adds a new session to the cache
A small value might cause the View process to purge cache
frequently and degrade viewing performance.
Takes effect at server restart.
Category: Session Cache
Related parameters:
ACLTimeout
SessionCacheSizePerProcess

516 Administering Actuate iSer ver System

Display name
Viewing service parameter
CSS file location required for
viewing through Active
Portal/ Management
Console
Parameter:
CSSFileLocationJSPRC
CSS file location required for
ReportCast
Parameter:
CSSFileLocationRC
DHTML generator
information
Parameter:
DHTMLGeneratorInfo
JavaScript file location
required for viewing
through Active Portal/
Management Console
Parameter:
JSFileLocationJSPRC
JavaScript file location
required for ReportCast
Parameter:
JSFileLocationRC
Log directory
Parameter: LogDirectory
Enable logging
Parameter: LoggingOn
Description
Location of Cascading Style Sheet files used when viewing
reports using Active Portal or Management Console. Default
value is ../css/.
Takes effect at server restart.
Category: CSS
Location of Cascading Style Sheet files used when viewing
reports using Actuate ReportCast. Default value is
/actuate/default/standard/.
Takes effect at server restart.
Category: CSS
DHTML Generator Information. Default value is Actuate.
The value of the NAME attribute in the META tag of DHTML
output generated by the View process. If the value is an empty
string, the META tag is not included in the DHTML output.
Takes effect at server restart.
Category: DHTML Generator Information
Location of JavaScript files used when viewing reports using
Active Portal or Management Console. Default value is ../js/.
Takes effect at server restart.
Category: Javascript
Location of JavaScript files used when viewing reports using
Actuate ReportCast. Default value is
/actuate/default/standard/.
Takes effect at server restart.
Category: Javascript
Directory of View service log file.
Takes effect immediately.
Category: General Logging
Enable View service diagnostic logging. Default value is true.
Takes effect immediately.
Category: General Logging
Chapter 14, Setting Actuate iServer parameters 517
Display name
Viewing service parameter Description
Log level Logging level of View service diagnostic logging. Default
Parameter: LogLevel value is 8000. Range if an integer between 0 and 8000.
Takes effect immediately.
Category: General Logging
Log size Size of View service diagnostic log file in KB. Default value is
Parameter: LogSize 5000.
Takes effect immediately.
Category: General Logging
Number of logs Maximum number of View process diagnostic log files.
Parameter: NumLogs Default value is 1.
Takes effect at immediately.
Category: General Logging
Main Title e.Analysis default main title text.
Parameter: Takes effect at server restart.
eAnalysisMainTitle
Category: Branding
Watermark e.Analysis watermark. Default value is daedclejcpafef.
Parameter: Takes effect at server restart.
eAnalysisWatermark
Category: Branding
Window Title e.Analysis window title. Default value is Actuate e.Analysis.
Parameter: Takes effect at server restart.
eAnalysisWindowTitle
Category: Branding
Data cube size Maximum e.Analysis data cube size in MB. Default value is
Parameter: 6MB.
eAnalysisCubeSizeLimit Takes effect at server restart.
Category: General
Decimal points Decimal precision. Default value is 3.
Parameter: Takes effect at server restart.
eAnalysisDecimalPoint
Category: General
Codebase Path used by The e.Analysis application codebase path when viewing
Active Portal and reports using Active Portal or Management Console.Default
Management Console. value is ../eanalysis.
Parameter: Takes effect at server restart
eAnalysisPathJSPRC
Category: General

518 Administering Actuate iSer ver System

Display name
Viewing service parameter
Show 3D histograms
Parameter:
eAnalysisShowHistogramIn
3D
Show Histogram data
values as percent
Parameter:
eAnalysisShowHistogram
Percent
Show histogram data values
as numeric
Parameter:
eAnalysisShowHistogram
Values
Show Line graph
subcategory labels
Parameter:
eAnalysisShowLineLabels
Show Line graph data
values as percent
Parameter:
eAnalysisShowLinePercent
Show Line graph data
values as numeric
Parameter:
eAnalysisShowLineValues
Combine pie chart
subcategories that are less
than this % of total
Parameter:
eAnalysisPieChartCombine
Minimum
Show 3D pie chart graphs
Parameter:
eAnalysisShowPieChartIn
3D
Description
Show e.Analysis histograms in 3D. Default value is true.
Takes effect at server restart.
Category: Histogram
Show e.Analysis Histogram data values as percent. Default
value is false.
Takes effect at server restart.
Category: Histogram
Show e.Analysis histogram data values as numeric data.
Default value is true.
Takes effect at server restart.
Category: Histogram
Show e.Analysis line graph subcategory labels. Default value
is false.
Takes effect at server restart.
Category: Labels
Show e.Analysis line graph data values as percent. Default
value is false.
Takes effect at server restart.
Category: Labels
Show e.Analysis line graph data values as numeric data.
Default value is false.
Takes effect at server restart.
Category: Labels
Combine Pie Chart subcategories that are less than this
percentage of total. Default value is 3. Range is from 0 to 99.
Takes effect at server restart.
Category: PieChart
Show e.Analysis pie chart graphs in 3D. Default value is true.
Takes effect at server restart.
Category: PieChart
Chapter 14, Setting Actuate iServer parameters 519
Display name
Viewing service parameter Description
Show pie chart sub category Show e.Analysis pie chart sub category label. Default value is
label true.
Parameter: Takes effect at server restart.
eAnalysisShowPieChart
Category: PieChart
Labels
Show pie chart data values Show e.Analysis pie chart data values as percent. Default
as percent value is true.
Parameter: Takes effect at server restart.
eAnalysisShowPieChart
Category: PieChart
Percent
Show pie chart data values Show e.Analysis pie chart data values as numeric data.
as numeric Default value is true.
Parameter: Takes effect at server restart.
eAnalysisShowPieChart
Values Category: PieChart

Auto-resize vertical axis
Parameter:
eAnalysisAutoResize
VerticalAxis
Disable measures total
Parameter:
eAnalysisDisableMeasures
Total
Automatically expand the rows to fill the height of the data
display area. Default value is true.
Takes effect at server restart.
Category: Table View
Disable measures total in e.Analysis. Default value is false.
Takes effect at server restart.
Category: Table View

Horizontal axis color e.Analysis horizontal axis color. Default value is 158, 158, 207.
Parameter: Takes effect at server restart.
eAnalysisHorizontalAxis Category: Table View
Color
Show hierarchy of column Show hierarchy of column sub categories in e.Analysis.
sub categories Default value is true.
Parameter: Takes effect at server restart.
eAnalysisShowColumn
Category: Table View
Levels
Show column totals Show e.Analysis column totals. Default value is false.
Parameter: Takes effect at server restart.
eAnalysisShowColumn
Category: Table View
Totals
Show leading column totals Show e.Analysis leading column totals. Default value is true.
Parameter: Takes effect at server restart.
eAnalysisShowColumn
Category: Table View
TotalsLeading

520 Administering Actuate iSer ver System

Display name
Viewing service parameter
Show hierarchy of row sub
categories
Parameter:
eAnalysisShowRowLevels
Show row totals
Parameter:
eAnalysisShowRowTotals
Show leading column totals
Parameter:
eAnalysisShowRowTotal
Leading
Show drill controls Show e.Analysis drill down controls. Default value is true.
Parameter: Takes effect at server restart.
eAnalysisShowDrillControls
Category: Table View
Show columns with no data
Parameter:
eAnalysisShowEmpty
Columns
Show rows with no data
Parameter:
eAnalysisShowEmptyRows
Show grid lines
Parameter:
eAnalysisShowGridLines
Show columns with all zeros
Parameter:
eAnalysisShowZero
Columns
Show rows with all zeros
Parameter:
eAnalysisShowZeroRows
Show Zero Variables
Parameter:
eAnalysisShowZero
Variables
Description
Show hierarchy of row sub categories in e.Analysis. Default
value is true.
Takes effect at server restart.
Category: Table View
Show row totals in e.Analysis. Default value is false.
Takes effect at server restart.
Category: Table View
Show leading column totals in e.Analysis. Default value is
true.
Takes effect at server restart.
Category: Table View
Show columns with no data in e.Analysis. Default value is
true.
Takes effect at server restart.
Category: Table View
Show rows with no data in e.Analysis. Default value is true.
Takes effect at server restart.
Category: Table View
Show e.Analysis grid lines. Default value is true.
Takes effect at server restart.
Category: Table View
Show e.Analysis columns with all zeros. Default value is true.
Takes effect at server restart.
Category: Table View
Show e.Analysis rows with all zeros. Default value is true.
Takes effect at server restart.
Category: Table View
Show e.Analysis zero rows. Default value is false.
Takes effect at server restart.
Category: Table View
Chapter 14, Setting Actuate iServer parameters 521
Display name
Viewing service parameter
Sort dimension:
Parameter:
eAnalysisSortDimension
Vertical axis color
Parameter:
eAnalysisVerticalAxisColor
Hide calculate item
Parameter:
eAnalysisHideCalculate
Hide help button
Parameter:
eAnalysisHideHelp
Hide home button
Parameter:
eAnalysisHideHome
Hide horizontal bar chart
button
Parameter:
eAnalysisHideHorizontal
BarChart
Hide horizontal fit to page
button
Parameter:
eAnalysisHideHorizontalFit
ToPage
Hide line graph button
Parameter:
eAnalysisHideLineGraph
Hide pie chart button
Parameter:
eAnalysisHidePieChart
522 Administering Actuate iSer ver System
Description
Sorts e.Analysis dimension data. Values are ascending,
descending, false, and no value. The default is ascending, sort
data in ascending order. No value, sorts data in ascending
order. Descending sorts data in descending order. False
disables sorting, dimension data displays unsorted.
Takes effect at server restart.
Category: Table View
e.Analysis vertical axis color Default value is 158, 207, 178.
Takes effect at server restart.
Category: Table View
Display calculated function columns in e.Analysis graphs.
Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis help button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis home button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis horizontal bar chart button. Default value is
false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis horizontal fit to page button. Default value is
false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis line graph button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis pie chart button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Display name
Viewing service parameter
Hide preferences button
Parameter:
eAnalysisHidePreferences
Hide print button
Parameter:
eAnalysisHidePrint
Hide save button
Parameter:
eAnalysisHideSave
Hide save as Microsoft Excel
button
Parameter:
eAnalysisHideSaveAsMS
Excel
Hide save as Microsoft Word
button
Parameter:
eAnalysisHideSaveAsMS
Word
Hide table view button
Parameter:
eAnalysisHideTableView
Hide vertical bar chart
button
Parameter:
eAnalysisHideVerticalBar
Chart
Hide vertical fit to page
button
Parameter:
eAnalysisHideVerticalFitTo
Page
Hide work offline button
Parameter:
eAnalysisHideWorkOffline
Description
Hide e.Analysis preferences button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis print button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis Save button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis Save a Microsoft Excel button. Default value
is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis Save a Microsoft Word button. Default value
is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis table view button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis vertical bar chart button. Default value is
false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis fit vertical to page button. Default value is
false.
Takes effect at server restart.
Category: Toolbar
Hide e.Analysis work offline button. Default value is false.
Takes effect at server restart.
Category: Toolbar
Chapter 14, Setting Actuate iServer parameters 523
Display name
Viewing service parameter Description
View Excel files with Specifies using Microsoft Excel 97 to view Excel files generated
Excel97 by the View process. Default value is false.
Variable: Set the value to true if users view Excel files using Excel 97.
ViewExcelFileWithExcel97 The View process limits the number of characters in an
Actuate Basic report control converted to Excel spreadsheet to
2000 characters. The 2000 character limit is an Excel 97
limitation. If the value is false, the limit is 4000 characters.
Takes effect at server restart.
Category: Display
Maximum number of pages Maximum number of pages a user can convert to Excel format
convertible to Excel in a single request while a user is viewing a report in DHTML
Parameter: format. The default value is 50 pages. Setting the value to 0
MaxPagesConvertibleTo results in an empty Excel when a user tries to download report
Excel pages in Excel format.
If the request contains more pages than the maximum number,
the View process converts the maximum allowed and displays
a warning message at the end of the generated Excel file.
Increase the value to the maximum number of pages you
allow users to convert to Excel format as a single request. If the
value too large, for example, greater than 2000, and a user
converts a 2000 page report, Actuate iServer performance
degrades while the View process converts the report.
Takes effect at server restart.
Category: Generation

524 Administering Actuate iSer ver System

Display name
Viewing service parameter Description
PDF quality Controls the resolution quality of charts and graphs in an
Parameter: PDFQuality Actuate Basic report when you save the report output to PDF.
Default value is 100. Range is an integer between 100 and 300.
Actuate recommends not changing the value.
With a value of 100, the View process generates an acceptable
chart or graph with the smallest PDF file size. PDF Quality
level 300 gives a higher resolution chart or graph and increases
the size of the PDF file.
Change the default to a higher value to increase the resolution
of a chart or graph if the Actuate Basic report generates a
relatively small, complicated chart or graph.
Changing the value to the 300, the maximum, usually creates a
PDF file 9 times larger. A higher value requires more memory
to generate the PDF. A value of 300 requires 9 times more
memory than a value of 100. A higher value usually requires a
longer time to generate the PDF file.
To control the size and quality of static images in a PDF file
generated from an Actuate Basic report, use the
PDFUseJPEGForImage.
Takes effect at server restart.
Category: DisplayPDF
Related parameter:
PDFUseJPEGForImage
Use JPEG for images in PDF Flag to indicate JPEG image should be used for static images in
Parameter: PDF files. Default value is false, use Rgbzip images. If the
PDFUseJPEGForImage value is true, use JPEG images.
The View process can generate either JPEG or Rgbzip images
in PDF files. Rgbzip format images in a PDF file provide better
quality but are larger.
This parameter controls static image quality. To control the size
and quality of Actuate Basic charts or graphs use PDFQuality.
Takes effect at server restart.
Category: DisplayPDF
Related parameter:
PDFQuality

Chapter 14, Setting Actuate iServer parameters 525

Display name
Viewing service parameter
The creator of the original
document (the report)
Parameter: PDFCreator
The application that
produced the PDF
Parameter: PDFProducer
Socket base for processes
Parameter:
SocketBaseForProcesses
Socket count for processes
Parameter:
SocketCountForProcesses
Maximum number of
processes
Parameter: MaxProcesses
Minimum number of
Processes
Parameter: MinProcesses
526 Administering Actuate iSer ver System
Description
The PDF creator property in a PDF file created by a View
process. Default value is Actuate.
Takes effect at server restart.
Category: PDF Generator Information
Related parameter:
PDFProducer
The PDF producer property in a PDF file created by a View
process. Default value is Actuate XML to PDF Converter 1.0.
Takes effect at server restart.
Category: PDF Generator Information
Related parameter:
PDFCreator
Needed for RSAPI. Specify the starting number for the View
process socket port to receive the ReportCast or client viewing
requests. Default value is 18500. Value must be between 1025
and 65535.
Takes effect at server restart.
Category: RSAPI
Needed for RSAPI. Specify the range from the base up to
which the view server socket port number can go. Default
value is 200. Range is from 0 to 64510. The sum of Socket Base
For Processes parameter and Socket Count for Processes
parameter must be less than 65535.
Takes effect at server restart.
Category: RSAPI
Maximum number of View Processes per locale. Default value
is 2. Range is from 0 to 128.
Takes effect immediately.
Category: Load Management
Minimum number of View processes per locale. Default value
is 0. Range is from 0 to 128.
Takes effect immediately.
Category: Load Management
Display name
Viewing service parameter
Maximum number of
worker threads per process
Parameter:
MaxThreadsPerProcess
Font used for search results
exported to Excel
Parameter:
FontUsedForSearchResultTo
Excel
Search timeout
Parameter: SearchTimeout
Description
Maximum number of active threads processing requests.
Default value is 4. The number of short view requests plus the
number of long view requests being processed.
Takes effect at server restart.
Category: Performance
Font used when saving search results as a Microsoft Excel file.
The default value is Arial.
If needed, change the value to a font installed on the users’
systems.
Takes effect at server restart.
Category: DisplaySearch
Maximum time Actuate iServer allows to perform a search in
an Actuate Basic report. The default value is 180 seconds.
Minimum value is 0, Actuate iServer does not stop a search.
Actuate recommends a value between 60 seconds and 600
seconds.
If a search takes longer than the timeout value, Actuate iServer
stops the search and issues a warning.
Change the value to a longer time, if users require longer times
to perform searches.
Actuate recommends upgrading the Actuate iServer machine
If user searches require a long timeout.
Takes effect at server restart.
Category: Generation
Chapter 14, Setting Actuate iServer parameters 527
 Reporting Service parameters
The following table lists the Actuate iServer Reporting Service parameters
Display name
Reporting service
parameter
Synchronous reporting
weight
Parameter:
SynchReportingWeight
Output directory for
Factory-generated Excel
Files using ExcelAPI
Parameter:
OutputDirForRuntimeExcel
Enable Generation Service
Parameter:
EnableGenerationService
Height for the image
Parameter:
LeftImageHeightForActuate
QueryOutput
Path to the image
Parameter:
LeftImageNameForActuate
QueryOutput
Width for the image
Parameter:
LeftImageWidthForActuate
QueryOutput
Height for the image
Parameter:
RightImageHeightFor
ActuateQueryOutput
528 Administering Actuate iSer ver System
Description
Relative value used for distributing synchronous report
requests among servers with the View service enabled in an
Actuate iServer cluster. Default value is 100.
Takes effect immediately.
Category: Cluster Load Balancing
Specify the full path name of the directory to which Actuate
iServer sends Excel-format report output.
Takes effect at server restart.
Category: Excel Generation
Flag to enable or disable the Factory service. Default value is
false.
Takes effect immediately.
Category: General
Specify the height in inches of the image that appears in the
upper left corner of Actuate Query pages.
Takes effect immediately.
Category: Top-left corner image in Actuate Query Output
Specify the path to the image that appears in the upper left
corner of Actuate Query pages.
Takes effect immediately.
Category: Top-left corner image in Actuate Query Output
Specify the width in inches of the image that appears in the
upper left corner of Actuate Query pages.
Takes effect immediately.
Category: Top-left corner image in Actuate Query Output
Specify the height in inches of the image that appears in the
upper right corner of Actuate Query pages.
Takes effect immediately.
Category: Top-right corner image in Actuate Query Output
Display name
Reporting service
parameter Description
Path to the image Specify the path to the image that appears in the upper right
Parameter: corner of Actuate Query pages.
RightImageNameFor Takes effect immediately.
ActuateQueryOutput
Category: Top-right corner image in Actuate Query Output
Width for the image Specify the width in inches of the image that appears in the
Parameter: upper right corner of Actuate Query pages.
RightImageWidthFor Takes effect immediately.
ActuateQueryOutput
Category: Top-right corner image in Actuate Query Output
Log directory Directory for Factory process diagnostic logs.
Parameter: LogDirectory Takes effect immediately.
Category: General Logging
Enable logging Enable Factory process diagnostic logging. Default value is
Parameter: LoggingOn true.
Takes effect immediately.
Category: General Logging
Log level Logging level of Factory process diagnostic log file. Default
Parameter: LogLevel value is 8000.
Takes effect immediately.
Category: General Logging
Log size (KB) Maximum size of Factory process diagnostic log file. Default
Parameter: LogSize value is 10000 KB.
Takes effect immediately.
Category: General Logging
Number of logs Number of Factory process diagnostic log files. Default value
Parameter: NumLogs is 1.
Takes effect at immediately.
Category: General Logging

Chapter 14, Setting Actuate iServer parameters 529

Display name
Reporting service
parameter Description
SAP Native Connector Trace Logging level for the SAP native connector. Value is an integer
Logging Level between 1 to log all information, and 10000 to disable logging.
Parameter: Default value is 10000. Turn on logging to diagnose runtime
JavaDataSourceLogLevele problems with the SAP native connector when running a
report from an Encyclopedia volume.
6000 logs detailed trace information, 7000 logs configuration
messages, 8000 logs warnings, and 9000 logs serious errors.
Takes effect at immediately.
Category: SAP Native Connector
Disable caching of ROX Controls caching of an ROX file by the Factory process during
Parameter: report generation. To disable caching, set the parameter to
DisableProgramManager true. Default value is false.
Cache Takes effect at server restart.
Category: ROX Cache
Maximum number of Maximum number of ROX files cached by a Factory process.
cached ROX files per factory Default value is 128.
Parameter: Takes effect at system restart.
MaxROXCacheSizePer
Factory Category: ROX Cache

e.SpreadSheet server port
number
Parameter:
eSpreadSheetServerPort
Report use originating
encyclopedia for requester
API calls
Parameter:
RequesterAPIConnectToRE
Port used for e.Spreadsheet server. Default value is 1569.
Takes effect at server restart.
Category: eSpreadSheet
Controls the value of the server parameter used in Requester
API calls. Default value is true.
Actuate iServer uses the name or IP address of the
Encyclopedia volume managing the report. Actuate iServer
ignores the parameters used in AcReqConnect or the <server>
part in the syntax rotp://<server>/<path>/<filename>.
Set the value to false to use the server parameter value
specified in the report executable code. For example, a report
executable in one Encyclopedia volume contains Requester
code to run reports in another Encyclopedia volume. Set the
RequesterAPIConnectToRE value to false to use the value
specified in report executable’s code.
Takes effect immediately.
Category: Requester API

530 Administering Actuate iSer ver System

Display name
Reporting service
parameter Description
Time after which inactive Interval of time to wait before Actuate iServer shuts down an
factories are shutdown idle Factory processes. The default value 0 disables Factory
Parameter: process shutdown. A Factory process runs until you stop
FactoryIdleTimeout Actuate iServer.
Set the value to an interval that avoids a high turnover of
Factory processes or to manage system resources. For
example, set a timeout value if you assign Factory processes to
resource groups that are not using the Factory processes
constantly. Set the value to shut down Factory processes that
are not being used by the resource groups.
If the value is 1 second, a Factory process shuts down after
running a job if another job is not assigned to it within one
second.
Takes effect immediately.
Category: Factory Service
Related parameter:
ProcessRecycleCount
Number of requests before Limits the total number of requests a Factory process runs.
recycling processes After a process runs the specified number of requests, Actuate
Parameter: iServer shuts down the process. The default value 0 disables
ProcessRecycleCount Factory process recycling.
Enable Factory process recycling if you notice that the Factory
process resource usage increasing over time. For example, if
Factory process memory and handle usage increases over
time.
Takes effect at server restart.
Category: Factory Service
Related parameter:
FactoryIdleTimeout

Chapter 14, Setting Actuate iServer parameters 531

Display name
Reporting service
parameter Description
Maximum execution time Maximum length of time a synchronous Factory process runs
for transient reports when generating a Actuate Basic report as an immediate job.
Parameter: Job fails if it takes longer than the specified time to run.
MaxSyncJobRuntime Default value is 300 seconds. Range is from 0 to 86400 (24
hours).
If the value is 0, a synchronous job never generates
successfully. Actuate recommends a maximum of 900 seconds
or less.
Decrease value to optimize Factory process usage. For
example, if you expect to run synchronous jobs that take less
time than the current value, decrease the value to free idle
Factory processes that have completed generating a report.
An immediate job is designed to run short reports. Increase the
value if user run report synchronously that take longer than 5
minutes to generate. Actuate recommends running large
reports asynchronously.
If the value is too high, and all synchronous Factory processes
are running long reports, other, shorter synchronous jobs
might fail.
Takes effect immediately.
Category: Sync Report Execution
Related parameters:
SyncJobQueueWait
SyncJobQueueSize

532 Administering Actuate iSer ver System

Display name
Reporting service
parameter Description
Job queue size for Maximum number of requests allowed in the transient and
synchronous reports synchronous report request queue. Default value is 100. Range
Parameter: is from 0 to 99,999.
SyncJobQueueSize If the value is 0, jobs fail if a Factory process not is available.
Actuate iServer does not queue synchronous jobs.
When Actuate iServer reaches the maximum jobs on the
queue, it sends an message to the user submitting the job.
Actuate iServer provides one job queue per synchronous
resource group. The same setting applies to all synchronous
resource groups.
Increase the value if error displays during peak hours. Also
consider allocating more resources to the Actuate iServer
System. For example, adding more CPUs or changing the
cluster configuration to support faster report generation.
If the average number of jobs on the queue is high, there might
not be enough Factory resources available, or the system on
which the iServer runs can not handle the current load.
Actuate iServer also fails jobs based on the queue timeout, For
example, if a job on the queue has reached the maximum time
allowed on the queue, Actuate iServer fails the job.
Takes effect immediately.
Category: Sync Report Execution
Related parameters:
SyncJobQueueWait
MaxSyncJobRuntime

Chapter 14, Setting Actuate iServer parameters 533

Display name
Reporting service
parameter Description
Job queue timeout for Maximum time a transient and synchronous report request
transient reports spends in the queue waiting for generation. Default value is
Parameter: 600 seconds. Range if from 0 to 999.
SyncJobQueueWait Actuate iServer queues a synchronous job when a Factory
process is not available. If the job doesn't start before the
timeout period, Actuate iServer sends a message to the user.
If the value is 0, Actuate iServer does not queue synchronous
jobs. The jobs fail if no Factory process is available. If the value
is too high, the number of queued jobs might reach the
maximum and be rejected.
Increase the value if messages display during peak hours. Also
consider allocating more resources to the system, for example,
adding more CPUs or changing the cluster configuration to
support faster report generation.
If the average number of jobs on the queue is high, there might
not be enough Factory resources available, or the system on
which the iServer runs can not handle the current load.
Actuate iServer also fails a job if adding the job to the queue
exceeds maximum number of queued jobs.
Takes effect immediately.
Category: Sync Report Execution
Related parameters:
SyncJobQueueSize
MaxSyncJobRuntime

534 Administering Actuate iSer ver System

Display name
Reporting service
parameter Description
Location of disk cache for Directory Actuate iServer stores temporary transient report
transient reports generation files.Default value is the Actuate iServer home tmp
Parameter: directory.
TransientReportCache Specify a directory where Actuate iServer has read and write
Location permissions. Change the value to use to a directory dedicated
for transient report generation.
Disk I/O speed affects transient report generation
performance. Using a local disk with fast I/O might increase
transient report generation performance.
Transient report generation performance might decrease if you
specify a directory accessed through the network rather than a
local disk.
Related parameters:
TransientReportCacheSize
TransientReportTimeout
Disk cache size for transient Maximum disk space allowed to store temporary transient
reports report generation files. Default value is 100 MB. Range is from
Parameter: 0 to 99999.
TransientReportCacheSize A value of 0 allows only one transient report. When Actuate
iServer reaches the maximum value, it returns a transient store
is full error.
Change the value to based the disk space you want the
transient report cache to use. Changing the
TransientReportTimeout might increase the efficiency of the
cache.
Takes effect immediately.
Category: Transient Report Storage
Related parameters:
TransientReportCacheLocation
TransientReportTimeout.

Chapter 14, Setting Actuate iServer parameters 535

Display name
Reporting service
parameter Description
Disk cache timeout for Maximum lifetime of a transient report in the transient report
transient reports cache. After the length of time, Actuate iServer removes the
Parameter: report from the cache. Default value is 30 minutes. Range is
TransientReportTimeOut from 1 to 1440.
Specify a value that includes report generation time and
maximum user viewing time. Increase the value if users use
the report for longer than 30 minutes. Decrease the value to
limit the amount of time reports stay in the cache.
Increasing the TransientStoreMaxCacheEntries value and this
value, might increase Actuate iServer memory usage.
Set TransientReportTimeOut to a value larger than the sum of
SyncJobQueueWait and MaxSyncJobRuntime.
Takes effect immediately.
Category: Transient Report Storage
Related parameters:
TransientReportCacheLocation
TransientReportCacheSize
TransientStoreMaxCacheEntries
TransientReportTimeOut
SyncJobQueueWait
MaxSyncJobRuntime

536 Administering Actuate iSer ver System

Display name
Reporting service
parameter Description
Max cache entries for Maximum number of transient synchronous reports Actuate
transient reports iServer manages in the transient report cache. Default value is
Parameter: 10000.
TransientStoreMaxCache Increase the value if users generate a large number of transient
Entries reports in a short period of time Actuate iServer displays a
failed to register a temporary report message:
Specify a value larger than maximum number of reports you
expect users to generate within the period of time specified by
TransientReportTimeout. You might also need to increase the
transient report cache size.
Increasing both TransientStoreMaxCacheEntries and
TransientReportTimeout might increase Actuate iServer
memory usage.
Setting the value to 0 prevents the generation of persistent and
transient synchronous reports.
Takes effect immediately.
Category: Transient Report Execution Storage
Related parameter:
TransientReportTimeOut
TransientReportCacheLocation
TransientReportCacheSize
SyncJobQueueWait
MaxSyncJobRuntime

Chapter 14, Setting Actuate iServer parameters 537

 SOAP Dispatch Service parameters
The following table lists the Actuate iServer SOAP Dispatch Service
parameters

Display name
SOAP dispatch parameter
Message distribution service
IP address
Parameter:
SOAPDispatchIPAddress
Message distribution service
port
Parameter:
SOAPDispatchSOAPPort
Description
IP address or machine name of the Message Distribution
Service.
If you specify a machine, Actuate iServer binds to all available
interfaces on the machine.
The SOAPDispatchIPAddress and SOAPDispatchSOAPPort
specify the entry point where an Actuate iServer accepts client
requests.
Takes effect at server restart.
Category: Communication
Related parameters:
SOAPDispatchSOAPPort
Port of the Message Distribution Service. Default value is 8000.
Value is a valid, unused port, typically between 1024 and
65535.
The SOAPDispatchIPAddress and SOAPDispatchSOAPPort
specify the entry point where an Actuate server accepts client
requests.
Takes effect at server restart.
Category: Communication
Related parameters
SOAPDispatchIPAddress

538 Administering Actuate iSer ver System

Display name
SOAP dispatch parameter Description
Enable request service Flag to enable or disable the Message Distribution service.
Parameter: Cannot be changed for the cluster master or stand-alone
EnableRequestService server. Default value is false.
Takes effect immediately.
Category: General
Maximum number of Total number of concurrent requests processed by Actuate
connections iServer through the Message Distribution service. When the
Parameter: maximum is reached, Actuate iServer refuses to process any
MaxEndpointThreads new incoming requests.
Actuate recommends performing throughput tests if you
change the value.
Actuate recommends a value of 1000. If the value is 0, Actuate
iServer will not accept any incoming request.
The MaxEndpointThreads should be set high enough handle
the server or cluster load.
If the value is set too low, Actuate iServer will not utilize all
system resources when handling the maximum number of
client requests.
Increasing the value might reduce total throughput. At peak
usage times, Actuate iServer might use the maximum
available system resources such as system memory, CPU
cycles, and temporary disk space. As a result, throughput
degrades.
Takes effect at server restart.
Category: Request Management

Chapter 14, Setting Actuate iServer parameters 539

 Server-specific Partition configuration parameters
The following table lists the Actuate iServer Server-specific Partition
configuration parameters

Display name
Server partition parameter Description
Name Name of an Actuate iServer partition. Actuate iServer displays
Parameter: Name the name in the list of partitions.
Takes effect immediately.
Category: SMTP Server
Location of partition relative File system path to the directory used by the Actuate iServer
to the server partition.
Parameter: Path Takes effect immediately.
Category: Partition Access

A Printer used by this Server parameters

The following table lists the Actuate iServer A Printer used by this Server
parameters

Display name
Server node printer
parameter
Name used by operating
system to identify printer
Parameter: PrinterOSName
PPD file name on UNIX
Parameter:
UNIXPPDFileName
Spool command on UNIX
Parameter:
UNIXSpoolCommand
Description
Printer name.
Takes effect at server restart.
Category: Identification
PPD file name for UNIX printer.
Takes effect at server restart.
Category: Identification
Spool command used with UNIX printer.
Takes effect at server restart.
Category: Identification

540 Administering Actuate iSer ver System

 Open server file type parameters
The following table lists the Actuate open server file type parameters
TypeID: NetOSIFileType

Display name
Open Server parameter Description
Name Name of the Actuate iServer NetOSI file type. Actuate iServer
Parameter: Name displays the name in the list of NetOSI file types.
Takes effect immediately.
Version of third-party Open server interface version. Default value is 2. Value is 2 or
service 3.
Parameter: NetOSIVersion Actuate recommends contacting Actuate support before
changing this value. Change the value to specify a different
version open server interface.
Takes effect at server restart.
Category: Factory-side Parameters for Third-Party Service
Command line arguments Command line for open server driver. Used when
Parameter: Commandline NetOSIVersion is 3 and factory needs to start the open server
service.
Takes effect immediately.
Category: Factory-side Parameters for Third-Party Service
Related parameter:
NetOSIVersion
Use attachment Flag to specify type of file transfers between Factory process
Parameter: IsAttachment and open server service. Used when NetOSIVersion is 3.
Default value for this is false, open server files are specified by
a file path. If true, open server files are sent as attachments.
If the Factory process and open server service are on different
machines and file access using a file path is not possible, then
use attachment mode.
Takes effect immediately.
Category: Factory-side Parameters for Third-Party Service
Related parameter:
NetOSIVersion

Chapter 14, Setting Actuate iServer parameters 541

Display name
Open Server parameter Description
SOAP port number Port number to connect with the open server service running
Parameter: SOAPPort on an application server.
Takes effect immediately.
Category: Third-Party Service Parameters
Related parameter:
NetOSIVersion
Application context String used as the application context used when sending a
Parameter: AppContext SOAP message the open server service deployed on
application server.
Takes effect at server restart.
Category: Third-Party Service Parameters
Related parameter:
NetOSIVersion
Target hostname IP address or name of host-machine hosting open server
Parameter: service. Default value is localhost.
NetOSIHostName Takes effect at server restart.
Category: Third-Party Service Parameters
Related parameter:
NetOSIVersion
SOAP message timeout Timeout for SOAP messages between Factory process and
Parameter: Timeout open server service.
If the value is larger than report request timeout, Factory
process aborts the request. If timeout value is too small,
Factory process breaks the connection before open server
service is able to respond.
Takes effect immediately.
Category: Third-Party Service Parameters
Related parameter:
NetOSIVersion

542 Administering Actuate iSer ver System

 Open server file type driver parameters
Display name
OSI parameter
Name
Parameter: Name
OSI driver path
Parameter: OSIDriverPath
OSI parameter file
Parameter:
OSIParameterFilePath
Resource Group parameters
The following table lists the Actuate iServer resource group parameters
Display name
Resource group parameter
Name
Parameter: Name
Resource group description
Parameter: Description
Description
Name of an Actuate iServer OSI filetype driver information.
Displays in the list of OSI filetype drivers.
Full path to an open server driver. Actuate iServer runs the
open server driver when starting and stopping an Actuate
iServer.
Actuate iServer appends the value OSIParameterFilePath as
an argument when running the open server driver.
Takes effect at server restart.
Category: General Information
Related parameter:
OSIParameterFilePath
Optional parameter file used with the open server driver
specified in OSIDriverPath. Actuate iServer appends the value
as an argument when running the server driver driver
specified in OSIDriverPath when starting and stopping an
Actuate iServer.
Takes effect at server restart.
Category: General Information
Related parameter:
OSIDriverPath
Description
Name of an Actuate iServer resource group. Displays in the
list of resource groups.
Takes effect immediately.
Optional resource group description displays in list of
resource groups.
Takes effect immediately.
Category: General
Chapter 14, Setting Actuate iServer parameters 543
Display name
Resource group parameter
Enables the resource group
for the server
Parameter: Activate
Disables the resource group
Parameter: Disabled
Resource group type
Parameter: Type
Maximum number of
factories for the resource
group on the server
Parameter: MaxFactory
FileTypeList
Parameter: FileTypeList
Asynchronous resource
group maximum priority
Parameter: MaxPriority
544 Administering Actuate iSer ver System
Description
Enables the resource group for the Actuate iServer node.
Default value is true.
Takes effect immediately.
Category: Configuration
Disables an Actuate iServer resource group. Default value is
false.
Takes effect immediately.
Category: General
Type of report jobs handled by the resource group. Async for
asynchronous jobs, Sync for synchronous jobs. Default value is
Async.
Takes effect immediately.
Category: General
Maximum number of Factory the resource group can run on
an Actuate iServer node. Number is between 0 and 256.
Takes effect immediately.
Category: Configuration
List of Encyclopedia volume file types assigned to the resource
group for Async and Sync resource groups.
Takes effect immediately.
Category: Configuration
Maximum value of an asynchronous resource group priority
range. Default value is 1000. Range is between 0 and 1000.
The resource group’s Factory processes run jobs within the
priority range. The minimum and maximum values are
between 0 and 1000. The minimum value must be less than the
maximum value.
Takes effect immediately.
Category: Priorities
Display name
Resource group parameter Description
Asynchronous resource Minimum value of an asynchronous resource group priority
group minimum priority range. Default value is 0 (zero). Range is between 0 and 1000.
Parameter: MinPriority The resource group’s Factory processes run jobs within the
priority range. The minimum and maximum values are
between 0 and 1000. The minimum value must be less than the
maximum value.
Takes effect immediately.
Category: Priorities
Resource group volume Encyclopedia volume assigned to a resource group. The
assignment resource group can be assigned to a specific volume or All for
Parameter: Volume all volumes in the Actuate iServer System.
Takes effect immediately.
Category: Volume Assignment

SMTP Server parameters

The following table lists the Actuate iServer SMTP Server parameters

Display name
SMTP server parameter Description
SMTP Server name Name of an SMTP server. Actuate iServer displays the name in
Parameter: Name the list of SMTP Servers.
Takes effect immediately.
Hostname or IP address Hostname or IP address of an SMTP e-mail server Actuate
Parameter: SMTPHostName iServer uses for e-mail notices. The value must be a valid
SMTP e-mail server host name or IP address.
Takes effect immediately.
Category: Communication and Protocol
Related parameter:
SMTPPort
Listen port TCP/IP port of an SMTP e-mail server Actuate iServer uses for
Parameter: SMTPPort e-mail notices. Default value is 25. Range is from 1 to 65535.
Takes effect immediately.
Category: Communication and Protocol
Related parameter:
SMTPHostName

Chapter 14, Setting Actuate iServer parameters 545

Display name
SMTP server parameter Description
SMTP greeting Displayed name of e-mail return address the SMTP server uses
Parameter: Greeting for returned e-mail. Default is an empty string.
Actuate recommends changing the default value only when
the SMTP server requires a non-empty string. Actuate iServer
generates an error in a diagnostic log file if Actuate iServer
receives an error using the HELO request.
See the SMTP e-mail server documentation for information
about acceptable values. If an empty string does not work, a
value that might work is <domain_name>.com, where
<domain_name> is the domain name of the organization
running Actuate iServer.
Takes effect immediately.
Category: Communication and Protocol
Sender e-mail address The SMTP e-mail server sends e-mail to this address when an
Parameter: SenderAddress e-mail notice is not deliverable. The value must be an e-mail
address of the form <user>@<domain>.
Takes effect immediately.
Category: E-mail Sender Information
Related SMTP server attribute:
SenderName

546 Administering Actuate iSer ver System

Display name
SMTP server parameter Description
Sender display name Name displayed in the e-mail notice From field. When no
Parameter: SenderName value is specified, Actuate iServer uses the value of
SenderAddress.
Takes effect immediately.
Category: E-mail Sender Information
Related SMTP server attribute:
SenderAddress
SMTP mailing weight Relative weight to an SMTP e-mail server for routing e-mail
Parameter: MailingWeight notice request. Default value is 100. Range is from 0 to
1000000. If the value is 0, Actuate iServer uses the SMTP e-mail
server only after receiving errors from all other SMTP servers.
Change the value to adjust the number of e-mail messages sent
from Actuate iServer to an SMTP server. For example, Actuate
iServer uses 2 SMTP servers to deliver e-mail. To send twice
the number of e-mail messages using one SMTP server as the
other, change the value for one of the SMTP servers to twice
the value of the other server.
Changing this value might improve the performance and
resource usage of Actuate iServer by lowering the time
Actuate iServer waits for SMTP servers to process requests.
Takes effect immediately.
Category: Load Balancing

About registry keys and environment variables

Set registry keys on Microsoft Windows server operating systems or
environment variables on UNIX systems control Actuate services and
application execution at a system level. For example, use of registry keys or
environment variables includes setting the maximum database column length
Actuate iServer uses when generating an Actuate Basic report.

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 iServer\8.

Chapter 14, Setting Actuate iServer parameters 547

 To create a registry entry:
1 Choose Start➛Run.
2 In Run, type:
regedit.exe
3 Choose OK.
Registry Editor presents a hierarchical list of registry keys.
4 HKEY_LOCAL_MACHINE\Software\Actuate
\Actuate iServer\8.
5 To create a new string entry for the Actuate iServer machine key, choose
Edit➛New➛String 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
Edit➛Modify. Enter the appropriate value or strings of values for the
registry key.
For example, to set Actuate iServer home AC_SERVER_HOME:
1 Choose Start➛Run.
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 iServer\8.
5 To create a new string entry for the Actuate iServer machine key, choose
Edit➛New➛String value.
6 Change the name of the key to AC_SERVER_HOME.
7 To change the value for the entry, highlight the entry. Choose Edit➛Modify.
The value to the Actuate iServer installation directory.

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

548 Administering Actuate iSer ver System

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 the
configuration of Actuate iServer and an Actuate iServer System cluster. 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 Chapter 2, “Setting up Actuate iServer System
hardware.”

Variable name Description

AC_DBMS_INFORMIX_MAXVARLEN Maximum column length Actuate
uses with Informix databases.
Default value is 4000.
AC_DBMS_ODBC_MAXVARLEN Maximum column length Actuate
uses with ODBC databases.
Default value is 8000.
AC_DBMS_ORACLE_MAXVARLEN Maximum column length Actuate
uses with Oracle databases.
Default value is 4000.
AC_DBMS_PROGRESS_MAXVARLEN Maximum column length Actuate
uses with Progress databases.
Default value is 4000.
AC_SERVER_HOME Specify the home directory of the
Actuate iServer. Default value is
the directory into which you
installed Actuate iServer
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.

Chapter 14, Setting Actuate iServer parameters 549

 Variable name Description
DISPLAY UNIX only. Specifies the X
Windows server used by the
Actuate iServer machine.
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 executable files.
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 iServer Xprinter
home.
XPPATH UNIX only. Specifies the path to
the Actuate iServer Xprinter files.
XVFBDISPLAY UNIX only. Specifies the xvfb X
Windows server used by the
Actuate iServer machine.

550 Administering Actuate iSer ver System

 Part

Administering an Encyclopedia
Part 4
4
volume

Par t 4, Admini ster ing an Encycl opedia volume 551

552 Administering Actuate iSer ver System
 Chapter

Understanding
Chapter15
15
Encyclopedia volume
administration
This chapter contains the following topics:
■ Encyclopedia volume administration overview
■ Connecting to an Encyclopedia volume
■ About the Volume Administration console
■ Searching for data
■ Filtering Encyclopedia volume data
■ Setting properties for more than one item at a time
■ About the Administrator and the Operator
■ Setting Encyclopedia volume limits

Chapter 15, Understanding Encyclopedia volume administration 553

Encyclopedia volume administration overview
You use the Volume Administration console of Actuate Management Console
to manage Encyclopedia volumes. Volume administration pages can be
viewed using a web browser. Typical volume administration tasks include:
■ User administration tasks:
■ Adding, modifying, and deleting users
■ Defining the operations that users, or groups of users, can perform
■ Creating and maintaining lists of users to be informed when specified
events take place
■ Printer administration tasks:
■ Configuring printers
■ Specifying a default printer
■ Archiving tasks:
■ Specifying the Encyclopedia volume’s default archive rules
■ Initiating an archive sweep
■ Online backup tasks:
■ Setting a schedule for online backup mode
■ Starting and stopping online backup mode
■ Channel administration tasks:
■ Adding, modifying, and deleting channels
■ Defining which users, or groups of users, have access to which channels
■ Security tasks:
■ Configuring and maintaining security information based on
information supplied by a third-party package for use with the
Encyclopedia volume
■ If you have the e.Report Option and the Page Level Security Option
enabled, other tasks include configuring the Encyclopedia volume for
Actuate Basic reports that use page-level security, including:
- Giving security roles and users secure read privilege on reports
using page-level security
- Installing and configuring the Report Server Security Extension
(RSSE) if needed

554 Administering Actuate iSer ver System

 ■ Open server tasks:
■ Creating open server file types to run open server reports
■ Importing open server reports
■ Maintaining the open server drivers and third-party report generation
software
Some administrative tasks must be performed using the System
Administration console of Actuate Management Console. For more
information about these tasks, see Part 3, “Administering
Actuate iServer services.”

Connecting to an Encyclopedia volume

To connect to an Encyclopedia volume and perform volume administration
tasks, you use Actuate Management Console. Using a web browser, 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 16, “Managing Encyclopedia volume
security.”
As an Actuate iServer System administrator, you can change the default
Encyclopedia volume to which you log in by changing the value for System
default volume on System—Properties—General. For information about
System—Properties—General, see “Setting general Actuate iServer parameter
values for an Actuate iServer machine” in Chapter 7, “Working with an
Actuate iServer System server.”

How to connect to an Encyclopedia volume

1 Start Actuate Management Console.
To start Actuate Management Console on a Windows platform, choose
Start➛Programs➛Actuate 8➛Actuate Management Console from the task
bar.
To start Actuate Management Console on a UNIX platform, start your web
browser and enter the URL for the Actuate Management Console login
page, for example:
http://actuate1:8900/acadmin/login.jsp?serverURL=http://actuate2:8000
&daemonURL=http://actuate2:8100
where
■ actuate1:8900 is the web server that runs the web pages that provide the
interface to Actuate iServer System.

Chapter 15, Understanding Encyclopedia volume administration 555

 ■ acadmin is a keyword that indicates access to Actuate Management
Console.
■ login.jsp is the web page that displays the login interface.
■ serverURL=http://actuate2:8000 specifies the location of the Actuate
iServer.
■ daemonURL=http://actuate2:8100 specifies the location of the Actuate
Process Management Daemon.
2 Select the appropriate Encyclopedia volume.
Alternatively, you can specify the Encyclopedia volume in the URL. For
example, to log in to the Encyclopedia volume HQ directly, type:
http://actuate1:8900/acadmin/login.jsp?serverURL=http://actuate2:8000
&daemonURL=http://actuate2:8100&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 Encyclopedia volume at a time. To log in to multiple
Encyclopedia volumes, open multiple web browser windows. Each web
browser window handles one connection to an Encyclopedia volume.

How to solve login problems

If you get the message Log in Failed:
1 Confirm that you are using the correct Encyclopedia volume information.

556 Administering Actuate iSer ver System

 2 Confirm that Actuate iServer 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 Actuate iServer System and
the servers on which it is installed.

About the Volume Administration console

When you log in to an Encyclopedia 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 page’s banner is similar to the following illustration.

The banner contains the following elements:

■ A logo.
By default, Actuate’s logo is displayed. The Actuate logo is a link to the
Actuate home page.
■ The name of the system to which you are connected.
■ The name of the Encyclopedia volume to which you are connected.
■ Your user name.

Chapter 15, Understanding Encyclopedia volume administration 557

 ■ A link to log out.
■ 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.
■ A link to online help.

Using the side menu

The side 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 Options—General to set:
■ The number of rows to display per page in normal lists
■ The maximum number of rows to display in search results lists

558 Administering Actuate iSer ver System

■ The locale
■ The time zone
The following illustration shows the Options—General.

Use the other tabs on the Options page to specify:

■ The columns to display on tabular list pages
■ The order in which to display the columns
For example, Options—Users specifies that the following columns appear on
the Users page:
■ Name
■ E-mail address
■ Home folder
■ Description
The following illustration shows Options—Users with these settings.

Chapter 15, Understanding Encyclopedia volume administration 559

 The following illustration shows the Users page.

To display additional columns on the Users page, move the columns from the
Available columns list to the Selected columns list on Options—Users. To
change the order of the columns, use the up and down arrows to the right of
the Selected columns list.

About required fields

If an asterisk appears after a field on a volume administration page, the field is
a required field. If you do not type an entry in this field, the browser displays
an error message when you choose OK.

Searching for data

You can search for data in an Encyclopedia volume that meet certain criteria.
You can also specify which columns to display in the search results list. Name
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:
■ Jobs
■ Files and folders
■ Users
■ Security roles

560 Administering Actuate iSer ver System

■ Notification groups
■ Channels

Searching for strings that contain special

characters
If a search expression contains one or more special characters, each special
character must be preceded by a backslash (\). Special characters include
characters that are operators in a search expression:
■ Comma (,)
■ Hyphen (-)
■ Exclamation point (!)
■ Less than sign (<)
■ Greater than sign (>)
■ Equal sign (=)
■ Open square bracket ([)
■ Close square bracket (])
■ Question mark (?)
■ Number sign (#)
■ Asterisk (*)
■ Backslash (\)
■ Pipe sign (|)
■ Ampersand (&)
■ Single quotation mark (‘)
For example, to search for the user name user# you must type the following
search expression:
user\#
If you type the search expression:
user#
the search returns user names that begin with user and end with a number, for
example user1, user2, etc.

Chapter 15, Understanding Encyclopedia volume administration 561

 Searching for Encyclopedia volume data
Suppose that you want to display a list of users that meet the following
criteria:
■ E-mail address ends with @new-company.com
■ Home folder is /Sales/Managers
■ Web viewing preference is DHTML
■ Maximum job priority is greater than 500
■ A completion notice is created for jobs that succeed
■ Channel subscriptions include the Sales channel
You want to display the following columns from left to right:
■ Name
■ Priority
■ E-mail Notification
■ Completion Notices

How to display search results

To display the search results:
1 In the Volume Administration console, choose Users.
2 Choose Search.
3 Complete Search—Criteria, as shown in the following illustration.

562 Administering Actuate iSer ver System

4 Choose Columns.
5 Move the following columns from Selected to Available:
■ E-mail Address
■ Home Folder
■ Description
6 Move the following columns from Available to Selected:
■ Priority
■ E-mail Notification
■ Completion Notices
The following illustration shows Users—Search.

Chapter 15, Understanding Encyclopedia volume administration 563

 7 Choose Search.
Search Results appears.

8 To modify the criteria or columns, choose Change Search.

Filtering Encyclopedia volume data

Many volume administration pages provide a filter. The filter enables you to
reduce the number of rows retrieved from the Encyclopedia volume’s 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 the Users page, and choose Apply.
The following data appears.

564 Administering Actuate iSer ver System

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
Users—Properties—Roles, type sales* in Filter and choose Apply Filter. The
following illustration shows the results.

Chapter 15, Understanding Encyclopedia volume administration 565

 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.
The following illustration shows Properties—General.

566 Administering Actuate iSer ver System

 For more information about creating and maintaining channels, see “Creating
and maintaining channels” in Chapter 17, “Administering channels and
notification groups.”

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 Encyclopedia 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 Actuate Management Console.

About pages available to all users

The following pages are available to all users:
■ 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.

Chapter 15, Understanding Encyclopedia volume administration 567

 Use Jobs to:
■ Display information about a job.
■ Set the properties of a job.
■ Open a document.
■ Print a document on an Actuate iServer System printer.
■ Create a job.
■ Retry a failed job.
■ Delete a job.
■ Delete completion notices.
■ 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 Encyclopedia volume. Use Files and Folders pages to:
■ Set the properties of a file or folder.
■ Add, copy, move, or delete a file or folder.
■ Open a file or folder.
■ Create a parameter values file.
■ Download a file.
■ Print a document on an Actuate iServer System printer.
■ Create a job.
■ Channels
Channels displays a list of channels to which the user is subscribed. Use
Channels pages to:
■ Display the contents of a channel.
■ Delete notices from a channel.
■ Display information about a job.
■ Open a document.
■ Print a document on an Actuate iServer System printer.
■ Create a job.
■ Personal Settings
Personal Settings does not appear in the side 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, such as:
■ Your password

568 Administering Actuate iSer ver System

 ■ Your e-mail address
■ The method of notification for completed jobs
■ Channel subscriptions
■ Printer settings
Use Personal Settings to view:
■ The security roles assigned to you
■ The notification groups of which you are a member
■ Your privilege template

About 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:
■ Users
Users displays a list of users that have access to the Encyclopedia volume.
Use Users to:
■ Set the properties of a user.
■ Add and remove channel subscriptions.
■ Add or delete a user.
■ Security Roles
Security Roles displays a list of security roles. Use Security Roles to:
■ Set the properties of a security role.
■ Assign security roles to users.
■ Add or delete a security role.
■ Notification Groups
Notification Groups displays a list of notification groups. Use Notification
Groups to:
■ Set the properties of a notification group.
■ Add users to a notification group.
■ Add or delete a notification group.

Chapter 15, Understanding Encyclopedia volume administration 569

 ■ Channels
Channels displays a list of channels. Use Channels to:
■ Set the properties of a channel.
■ Add or delete a channel.
■ Display a list of subscribers to the channel.
■ File Types
File Types displays a list of file types. Use File Types to:
■ Set the properties of a file type.
■ Add or delete a file type.
■ Add, modify, or delete the parameters associated with a file type.
■ Upload icons associated with a file type.
■ Volume
Use Volume to:
■ Set the properties of the Encyclopedia volume, including:
- Default retry policy for failed jobs
- Default browser settings
- Privileges on the Encyclopedia volume’s root folder
- Auto-archive policy for the Encyclopedia volume
- Default printer settings
■ Start an auto-archive sweep.
■ Place the Encyclopedia volume in online backup mode.
■ Schedule online backups.

Setting Encyclopedia volume limits

Many of the relationships in the Encyclopedia 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 is 100.
Hard limit is 1000.
Channels to which a single user is subscribed. Recommended limit is 15.
Hard limit is 150.

570 Administering Actuate iSer ver System

Relationship Limits
Notification groups of which a single user is a Recommended limit is 100.
member. Hard limit is 2000.
Security roles of which a single user is a Recommended limit is 100.
member. Hard limit is 2000.
Security roles that are children of a single Recommended limit is 100.
security role. Hard limit is 2000.
Security roles that are parents of a single Recommended limit is 100.
security role. Hard limit is 2000.
Users and notification groups notified from a Recommended limit is 100.
single job. Hard limit is 1000.
Users and security roles in a single Access Recommended limit is 100.
Control List for a file, folder, or channel, Hard limit is 2000.
including Access Control Lists created by jobs.
Users and security roles in a single privilege Recommended limit is 100.
template. Hard limit is 2000.
Users who are members of a single notification Unlimited (greater than
group. 1,000,000).
Users who are members of a single security Unlimited (greater than
role. 1,000,000).
Users who are subscribed to a single channel. Unlimited (greater than
1,000,000).

Chapter 15, Understanding Encyclopedia volume administration 571

572 Administering Actuate iSer ver System
 Chapter

Managing Encyclopedia
Chapter 16
16
volume security
This chapter contains the following topics:
■ About Encyclopedia volume security
■ Managing users, privileges, and security roles
■ About page-level security
■ About Actuate Open Security
■ Using the Volume Administration console with open security
■ About information object pass-through security

Chapter 16, Managing Encyclopedia volume security 573

About Encyclopedia volume security
Actuate iServer System provides the following Encyclopedia volume security
capabilities:
■ User accounts and passwords
Working with user accounts and passwords, the Encyclopedia volume
administrator controls access to an Encyclopedia volume.
■ Privileges
Privileges provide security for data in the Encyclopedia volume by
specifying the operations that a user can perform on files and folders. The
Encyclopedia volume administrator can grant privileges for files and
folders. Users can set privileges for files and folders that they own. Users
can also set privileges for a file or folder owned by another user if given
grant privilege for the item. To grant privileges for a file or folder to a user
other than the owner, the item’s access type must be shared.
■ Roles
An administrator can create roles to manage privileges more efficiently.
The administrator can grant a set of privileges to a role and then assign the
role to all appropriate users.
■ Privilege templates
A user’s privilege template can specify granting privileges for all new
objects created by that user. For example, a user’s privilege template can
automatically grant privileges for new objects to the user’s assistant,
teammate, or supervisor.
■ File and folder access types
Files and folders can have either shared or private access type. If a file or
folder is shared, a user with grant privilege for the item can grant
privileges for the item to other users. If file or folder is private, only the
owner and the Encyclopedia volume administrator can access it.
■ Actuate report page-level security
Report developers set up reports to use page-level security to control access
by users to specific sections of reports. Using page-level security, report
developers can create a report with security rules that control which pages
a user can view. To use page-level security, you must purchase and enable
the Actuate Page Level Security option.

574 Administering Actuate iSer ver System

■ Report Server Security Extension
Developers can create applications that extend or partially replace the
security provided for Encyclopedia volumes. For example, an external
security application can be accessed to validate user names and passwords.

About user accounts and passwords

To access an Encyclopedia volume, you must provide a user name and,
typically, a password. The Encyclopedia volume administrator sets up all user
accounts for an Encyclopedia volume. Each user account includes information
about the user name and password. You can change your password once you
are logged in to the Encyclopedia volume.
About the anonymous user
In Actuate ReportCast, the administrator can create an Encyclopedia volume
user with the name anonymous and leave this user’s password blank. Then
users can access the Encyclopedia volume as the anonymous user without
entering a password. The users can then use any privileges granted to the
anonymous user.
When logging into Actuate ReportCast automatically as the anonymous user,
the URL must contain the parameter and value userID=anonymous.
If you log in to Actuate ReportCast as the anonymous user and attempt to
view a file for which the anonymous user has only visible privilege, the login
dialog appears. You can then log on as another user with a privilege to view
the file. Entering a valid user name and password reconnects you to the
Encyclopedia volume with the new authentication information and privileges.

Working with privileges

A privilege is a relationship between a user and a folder or file on the volume.
The privilege indicates whether the user can perform certain operations on the
folder or file. For example, the read privilege indicates that you can view or
print a file or view the contents of a folder. If you attempt to perform an
operation, such as deleting a file, without the necessary privileges, a message
appears indicating the missing privilege.
All users can read from the Encyclopedia volume’s root folder. When you
connect to an Encyclopedia volume, the items you see are those for which you
have been granted the visible privilege. The volume administrator has full
privileges for all items on the volume.
If you create or upload a file or folder, you are the owner and automatically
receive full privileges for the item. One of these privileges, the grant privilege,
allows you to grant privileges to other users. If you give another user the grant
privilege, that user also can grant privileges for the file or folder. The volume

Chapter 16, Managing Encyclopedia volume security 575

 administrator can not remove the visible and grant privileges from the owner
of a file or folder.
To grant or remove privileges for a file or folder, the following conditions must
be true:
■ The file or folder’s access type must be shared.
■ You must have grant privilege for the file or folder.
■ If you are in Actuate Active Portal, you must have the Actuate Active
Portal Advanced or Actuate Active Portal Administrator security role.
For information about roles, see “Working with roles,” later in this chapter. For
information about the Administrator user and security role, see “About the
Administrator user and security role,” later in this chapter.
For information about privilege templates, see “Working with privilege
templates,” later in this chapter.
For information about file and folder access types, see “About file and folder
access types,” later in this chapter.
For information about managing users, privileges, and roles, see “Managing
users, privileges, and security roles,” later in this chapter.

Planning how to assign privileges

When a user creates a folder or file in the Encyclopedia volume, the user
automatically has all privileges for the item. The owner, administrator, or
anyone with grant privilege for the item can grant privileges for the item to
other users.
The Encyclopedia volume uses the following privileges:
■ Visible (V)
Visible privilege allows users to see the file or folder listed in the
Encyclopedia volume. Users must have visible privilege for any other
privilege to be used. A user with read and execute privilege for a ROX or
DOX file implicitly has visible privilege for it. A user with read or secure
read privilege for any other type of file implicitly has visible privilege for it.
■ Secure Read (S)
The secure read privilege allows users to read specified parts of an Actuate
Basic report without being able to read the entire report. The secure read
privilege has meaning only for an Actuate Basic report document (.roi) and
if you have the Actuate Page Level Security option enabled.
■ Read (R)
The read privilege allows the user to read the contents of a file. For a folder,
read privileges are equivalent to visible privilege for the folder.

576 Administering Actuate iSer ver System

■ Execute (E)
The execute privilege allows the Actuate iServer Factory service to read the
file so that it can execute it. The execute privilege has no meaning for
folders. For this privilege to be effective, a user also must have visible
privilege for the item.
■ Trusted Execute (T)
The trusted execute privilege allows users to execute an information object
without having execute privileges for the information object’s underlying
data sources. This privilege only applies to Actuate information object
(.iob) files and (.map) files. Only a user with the Administrator role can
grant the trusted execute privilege.
■ Write (W)
The write privilege for a file allows a user to replace a file. The write
privilege for a folder allows users to create items in the folder. For this
privilege to be effective, a user also must have visible privilege for the item.
■ Delete (D)
The delete privilege for an item allows a user to remove the item from the
volume. For this privilege to be effective, a user also must have visible
privilege for the item.
■ Grant (G)
Users implicitly have grant privilege for the item if the user owns the item.
For this privilege to be effective, a user also must have visible privilege for
the item.
In planning privileges, consider the privileges necessary on the following
items:
■ Privileges for the item specified for the action
Some actions require only privileges for the item itself. For example,
downloading an item only requires privileges for the item.
■ Privileges for other files involved in the action
Some actions involve use of another file and require privileges for that file.
For example, to view a cube, a CB4 file, a user needs read privilege for the
CB4 file plus read and execute privileges for the associated DP4 file.
■ Privileges for folders that contain the item
Other actions require privileges for the source or destination folder of an
item. For example, copying an item requires visible and write privileges for
the destination folder.

Chapter 16, Managing Encyclopedia volume security 577

 The rest of this section lists the privileges required for the item specified for the
action, folders containing the item, and other files involved in the action. In
these tables, the term report executable files includes files with the following
extensions: .dox, .dp4, .icd, .jod, .joi, .jox, .rox, .rpx, .sqt, .vtf, .vtx, and .xrd. The
term report documents includes files with the following extensions: .bas, .cb4,
.cvw, .doi, .dop, .dov, .htm, .html, .iob, .odp, .pdf, .rod, .roi, .rop, .ros, .rov, .row,
.rpt, .rpw, .rtf, .sma, .spf, .sqw, .txt, and .xls.
The following table lists the privileges required on an item specified for each
type of action. The privileges are indicated by the first letter of their names:
V (Visible), S (Secure Read), R (Read), E (Execute), T (Trusted Execute), W
(Write), D (Delete) and G (Grant).

Privileges required on item

Action Type of item V S R E T W D G
Browsing the item listing in the Any V
Encyclopedia file list and viewing
its properties and access control list
Copying Any V R
Creating a query definition Data object R
executable file or
information
object file
Deleting Any V D
Downloading Any R
Executing Any executable (S or (E or
file R) T)
Granting or revoking privileges Any V G
Moving Any V W
Printing Any (S or
R)
Renaming Any V W
Replacing the latest version of a Any report V D
document document
Viewing an item’s contents Any (S or
R)

578 Administering Actuate iSer ver System

 The following table lists actions that also require privileges for other files
involved in the action.

Action Type of item Privileges required on another file

Deleting Folder Visible and delete privileges for all files in the deleted
folder
Executing Report executable files ■ Visible and delete privileges for the existing report
document if it is replaced during execution
■ Read and execute privileges for the corresponding
DB4 file if a CB4 is executed
■ Read and execute privileges for the corresponding
DOX, IOB, or SMA file if a DOV is executed.
Viewing Report documents ■ Execute privilege required on the executable file
only if executing at the same time
■ Read privilege for the report executable if viewing
using Actuate Viewer

The following table lists actions that require privileges for a source or
destination folder.

Action Type of folders Privileges required on folders

Copying an item Destination folder Visible and write privileges
Creating a new item in a folder or Destination folder Visible and write privileges
replacing the latest version of an
item
Moving an item Destination folder Visible and write privileges
and source folder

For information about Encyclopedia volume file types, see “Understanding

the File Types page” in Chapter 21, “Understanding Actuate iServer options.”
You can also see the definitions of the individual file types in Actuate 8
Glossary.

About root folder privileges

The following list describes the privileges that the administrator and users can
set on the Encyclopedia volume’s root folder:
■ For shared items such as reports, or other folders in the root folder, users
with grant privilege for the item can change the privileges for the item.
■ For a user to create folders in the root folder, the administrator must grant
write privilege for the root folder to the user, or a security role that contains
the user.

Chapter 16, Managing Encyclopedia volume security 579

 ■ An administrator can add or remove only the write and grant privileges for
users and security roles on the root folder.
The Administrator can create a shared folder in the Encyclopedia volume’s
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 home folder privileges

When an administrator specifies a home folder for a user, the user
automatically has visible, read, and write privileges for the folder. Users
cannot modify their own home folder setting. If the administrator changes the
location of the home folder, the previous home folder’s privilege settings do
not change.
If the Encyclopedia volume uses the Actuate Open Security RSSE application
the privileges for a user’s home folder are not automatically updated. The
Encyclopedia volume’s administrator must assign privileges for the user’s
home folder.

Using the trusted execute privilege for information objects

and data source maps
Actuate iServer supports the trusted execute privilege on an Actuate
information object (.iob) file and an Actuate data source map (.sma) file. If a
user has trusted execute privilege on an information object or data source
map, Actuate iServer does not check the privileges of any data sources that the
user’s information object or map uses. If the user has only execute privilege,
Actuate iServer checks the privileges of the underlying data sources before it
runs the information object or map.
For example, when a user runs an information object or map MyObject and
MyObject uses information objects Source1 and Source2, Actuate iServer
performs the following security checking:
■ If the user has trusted execute privilege on MyObject, Actuate iServer
performs no checking on the data sources used to create MyObject.
■ If the user has execute privilege but not trusted execute privilege, Actuate
iServer checks the privileges on Source1 and Source2 before running
MyObject. Actuate iServer checks the privileges recursively objects used by
Source1 and Source2 to ensure the objects have the appropriate execute or
trusted execute privilege for the user.
Set the trusted execute privilege on a file’s Properties—Privileges page. The
following illustration shows privileges for an information object file.

580 Administering Actuate iSer ver System

Actuate iServer removes trusted execute privilege when you update an object
or copy an object.
Using trusted execute privilege is independent of pass-through security. For
information about pass-through security for information objects and data
source maps, see “About information object pass-through security,” later in
this chapter.

Working with roles

The Encyclopedia volume administrator creates security roles to group users
that might require the same privileges for items. Using security roles lets you
assign and maintain privileges more consistently and with less effort. A
security role is a name for a set of privilege levels. Security roles can be used to
ensure that the same privileges are granted to a group of users. Security roles
also help administrators manage privilege sets as the environment changes.
For example, the Encyclopedia volume administrator might create a security
role called Sales that groups all the sales representatives and a security role
called R&D that groups all the engineers.
For each folder or file you create, you can assign different privileges to
different users. For example, you might want to allow the R&D team members
to view a sales report you generated and be able to run the associated report
executable file. In this case, you would grant to the R&D team members read

Chapter 16, Managing Encyclopedia volume security 581

 privilege for the report document and you would grant read and execute
privileges for the associated report executable file.
You might want to allow members of another team, such as the Sales team, to
view the report but not execute it. In this case, you grant to those users only
the read privilege for the report document. They would have no privileges for
the report executable file.
The following illustrates the above scenario without the use of roles. DAdams,
JSalinger, and LThompson belong to the R&D team. BCarter, EFitz, and SHorn
belong to the Sales team.

For each item… Sales Report Sales Report

document executable
(ROI) (ROX)

1. Select each
DAdams BCarter DAdams BCarter
user

JSalinger EFitz JSalinger EFitz

LThompson SHorn LThompson SHorn

2. Set privileges
Read Read Read
None
Execute

An efficient way to assign the same folder or file privileges to a group of users
is to assign privileges to a security role. The following illustration shows how
different privileges are granted to security roles. If you compare the following
illustration with the previous one, you see the convenience of having using
security roles to grant privileges to groups of users. Instead of granting
privileges to six users for each file, you grant privileges to two security roles
for each file.

582 Administering Actuate iSer ver System

For each item… Sales Report Sales Report
document executable
(ROI) (ROX)

1. Select each
R&D Sales R&D Sales
security role

(which groups
DAdams BCarter DAdams BCarter
certain users)

JSalinger EFitz JSalinger EFitz

LThompson SHorn LThompson SHorn

2. Set privileges
Read Read Read
None
Execute

Using security roles to relate sets of privileges and groups of users reduces the
complexity of administration tasks in two ways:
■ 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 modifies the
privileges of all users who are assigned that security role.
■ 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 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. If a role
inherited the privilege from a parent security role, remove the privilege from
the parent role.
If a user can assign privileges then the user can assign those privileges to roles.
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.

Chapter 16, Managing Encyclopedia volume security 583

 There are special Actuate security roles, called the Administrator security role,
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. There are also three roles that correspond to Actuate Active Portal
user levels: Active Portal Administrator, Active Portal Advanced, and Active
Portal Intermediate. These roles control the features available to Encyclopedia
volume users when they use Actuate Active Portal.
For information about privileges, see “Working with privileges,” earlier in this
chapter.
For information about privilege templates, see “Working with privilege
templates,” later in this chapter.
For information about file and folder access types, see “About file and folder
access types,” later in this chapter.
For information about managing users, privileges, and roles, see “Managing
users, privileges, and security roles,” later in this chapter.

Strategies for defining security roles

To make effective use of the flexibility of security roles, administrators should
decide on a strategy for deploying them. Two general types of strategies exist:
■ A flat strategy that simply allocates privileges in groups
■ 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.

584 Administering Actuate iSer ver System

About the flat strategy
With the flat strategy, administrators create:
■ One security role that allows access to inventory, pricing, and shipping
information
■ One security role that allows access to office comparisons and quota
measurements
■ One security role that allows access to regional summary reports

Role Sales Manager Regional VP

Inventory Comparisons Summary

Pricing Quotas
Reports Shipping

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. The disadvantage is that it often requires
the assignment of multiple security roles to individual users, as with managers
and the Regional VP in this example.

About the hierarchical strategy

With the hierarchical strategy, administrators create:
■ One security role that allows access to inventory, pricing, and shipping
information
■ One security role in which the parent is the first security role and also
allows access to office comparisons and quota measurements
■ One security role in which the parent is the second security role and also
allows access to regional summary reports

Chapter 16, Managing Encyclopedia volume security 585

 Regional VP

Role Manager
Sales

Inventory Comparisons Summary

Reports
Pricing Quotas
Shipping

Sales people are assigned the first security role, as in the flat strategy, while
managers are assigned the second security role, and the Regional VP is
assigned 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.
Determining the source of a user’s privilege, however, can be more involved
because of the layers of inheritance.

About the Administrator user and security role

An Encyclopedia volume 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:
■ You do not have to create the Administrator user and security role. They
always exist in the Encyclopedia volume.
■ Administrators cannot delete the administrator user or security role.
■ Initially, the administrator user is the only user that can add, modify, and
delete administration items, including users. As an 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.
■ Administrators have all privileges on all items in the Encyclopedia 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.

586 Administering Actuate iSer ver System

About the Operator security role
The Operator security role has the following properties:
■ You do not have to create the Operator security role. It always exists in the
Encyclopedia volume.
■ The administrator user is assigned to the Operator security role.
■ Administrators cannot delete the Operator security role.
■ Administrators can add or remove users from the Operator security role.
■ Administrators and other users assigned to the Operator security role can
place the Encyclopedia volume in online backup mode using either the
Volume Administration console or the Actuate iServer 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:
■ The All security role exists as soon as you add the Encyclopedia volume to
Actuate iServer System.
■ 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.
■ Administrators cannot delete the All security role.
■ All users are members of the All security role. An administrator cannot
remove a user from the All security role.
■ An administrator cannot use the All security role as a child or parent of
other security roles.

About Actuate Active Portal roles

When using Actuate Active Portal, an Encyclopedia volume user can perform
functions such as navigate to a volume folder and view a document. Actuate
Active Portal supports additional user functionality based on the user’s role
membership. The following lists the Actuate Active Portal roles that permit
additional functionality such as adding and deleting folders:
■ Active Portal Intermediate
■ Active Portal Advanced
■ Active Portal Administrator

Chapter 16, Managing Encyclopedia volume security 587

 The following table categorizes the features available to the Actuate Active
Portal roles:

Actuate Active Portal

feature Intermediate Advanced Administrator
Search for files and folders. X X X
Create a folder. X X
Delete a folder. X X
Share and set privileges on X X
a file or folder.
Send e-mail notification X X X
with attachments to
oneself.
Use job priority when X X
running a job.
Subscribe to a channel. X X X
Customize Actuate Active X
Portal skins.

A system administrator with access to Actuate Active Portal configuration

files can customize the Actuate Active Portal role names and the features
available to the roles. For information about customizing Actuate Active
Portal, see Creating Custom Web Applications using Actuate Active Portal.

Working with privilege templates

Each user has a privilege template that specifies the privileges that other users
have to items he or she creates. The default privilege template assigns the full
set of privileges to the creator of the item and the Encyclopedia volume
administrator, and no privileges to other users. Privilege templates override
the default privileges. The privilege template has no effect on private items.
Administrators can modify any user’s privilege template. For example, an
administrator can change a user’s privilege template so the user’s manager or
assistant always have read and write privileges to items the user creates. An
administrator can modify a user’s privilege template. By modifying a user’s
privilege template, an administrator can change the default privileges
assigned to items a user creates. Users can only modify their own template in
the Navigator, which is accessible from Actuate e.Report Designer
Professional, e.Report Designer, Actuate End User Desktop and Actuate
Viewer.
Administrators typically modify the default privilege template to make it easy
for users to create items and grant privileges for these items to other users. For

588 Administering Actuate iSer ver System

example, if UserA wants UserB always to have read and write privileges to
items that UserA creates, change UserA’s privilege template accordingly.
The following illustration shows an example of a privilege template for a user,
LThompson. In the example, the privilege template assigns all privileges to the
Encyclopedia volume administrator, read and write privileges to user BCarter,
and the read privilege to user DAdams. These privileges apply to all items
created by LThompson.
User User’s privilege template

LThompson Administrator BCarter DAdams

Read Read Read

Secure Write
Read
Write

Execute

Delete

Grant

Visible

For information about privileges, see “Working with privileges,” earlier in this
chapter.
For information about roles, see “Working with roles,” earlier in this chapter.
For information about file and folder access types, see “About file and folder
access types,” later in this chapter.
For information about managing users, privileges, and roles, see “Managing
users, privileges, and security roles,” later in this chapter.

Chapter 16, Managing Encyclopedia volume security 589

 About file and folder access types
To be able to grant other users privileges for a file or folder in an Encyclopedia
volume, the file or folder must have an access type of shared. A file or folder in
an Encyclopedia volume can be private or shared.

Access type Description

Private A file or folder with the private access type is
accessible only by the owner and by an
Encyclopedia volume administrator. The file can
not be shared with other users.
Shared A file or folder with the shared access type can be
shared with other Encyclopedia volume users.

The owner of a file or folder can set its access type. The volume administrator
can set the access type for any file or folder.
For information about privileges, see “Working with privileges,” earlier in this
chapter.
For information about roles, see “Working with roles,” earlier in this chapter.
For information about privilege templates, see “Working with privilege
templates,” earlier in this chapter.
For information about managing users, privileges, and roles, see “Managing
users, privileges, and security roles,” later in this chapter.

About RSSE
Using the Report Server Security Extension (RSSE), developers can create
applications that enhance the existing security model for the Encyclopedia
volume. Whether you are using Actuate’s internal security functionality or
using an RSSE application to use external security information, the use of
privileges to control access to the Encyclopedia volume’s information and how
privileges function remains the same.
Actuate provides sample RSSE applications that you can install and use with
an Actuate iServer System to access security information from an iPlanet
Directory Server, an LDAP server. These sample applications demonstrate
creating an interface between an external, third-party security system and
Actuate iServer System to provide the following functionality:
■ External authentication
You can control access to the Encyclopedia volume based on an external,
third-party security system. The sample of this type of application is in \
Actuate8\ServerIntTech\Report Server Security Extension\

590 Administering Actuate iSer ver System

 LDAP_Authentication_Example. See readme.doc in that directory for more
information about this application.
■ External user registration
You can control access to Encyclopedia volume items based on information
from an external security system. The sample of this type of application is
in \Actuate8\ServerIntTech\Report Server Security Extension\LDAP. See
readme.doc in that directory for more information about this application.
■ Retrieval of access control lists to control access to reports using page level
security
You can control access to data in an Actuate Basic report using page-level
security based on information from an external third-party security system.
The sample of this type of application is in \Actuate8\ServerIntTech\
Report Server Security Extension\Page_Security_Example. See
RSSEreadme.doc in that directory for more information about this
application.
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 4,
“Configuring Actuate iServer security,” and Chapter 13, “Working with
Actuate iServer utilities.”

Managing users, privileges, and security roles

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 Encyclopedia volume is using the Actuate Open Security feature, see
“About Actuate Open Security,” later in this chapter.

How to add a user

1 In the Volume Administration console, choose Users from the side menu.
2 On Users, choose Create User.
New User appears. New User has the following subpages:
■ New User—General specifies user log in information, e-mail address,
and home folder. New User—General also specifies whether the user’s
log in is disabled.
■ New User—Jobs specifies the user’s maximum job priority and how to
inform users when jobs complete.

Chapter 16, Managing Encyclopedia volume security 591

 ■ New User—Roles assigns the user to security roles.
■ New User—Groups assigns the user to notification groups.
■ New User—Privilege Template assigns privileges to other users and
security roles for items this user creates.
■ New User—Printing specifies a default printer and printer settings for
the user.
3 On New User—General:
1 Type a user name, description, and password for this user:
- 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.
- 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.
- 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 user’s password. Users can change their
own passwords.
2 Confirm the password.
3 Type the user’s e-mail address.
4 You can specify a path and a folder name as a home folder. The path
must be preceded by the Encyclopedia volume name. If you specify a
home folder, the user is granted all privileges for the folder.
If the Encyclopedia volume is using the Actuate Open Security RSSE
application, the Encyclopedia volume’s administrator must assign
privileges on the user’s home folder. The user’s home folder privileges
are not automatically updated.
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
Encyclopedia volume.
If you enter a path and folder name, the path and folder name must
exist in the Encyclopedia 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.

592 Administering Actuate iSer ver System

 5 To prevent the user from logging in, select Log in disabled.

4 Choose Jobs.
5 On New User—Jobs, you can set the user’s maximum priority level and
specify the user’s notification properties for both jobs that succeed and jobs
that fail. If a user can create a job, these settings specify how to notify the
user when the job completes.
If you select Send e-mail notification, Actuate iServer System sends e-mail
notices 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 Send e-mail notification on New
User—Jobs, you must type the appropriate e-mail address on New User—
General.
Selecting Send e-mail notification sends an e-mail notice to the user’s e-
mail address. The e-mail notice contains the location of completed reports.
If the user selects Attach document and has read privilege on the report,
Actuate iServer attaches the report to the e-mail notification. If the user
does not have read privilege, only the location of the report appears in the
e-mail notice. For more information about customizing the e-mail
notification template, see “Customizing the e-mail notice” in Chapter 2,
“Setting up Actuate iServer System hardware.”
If you select Place a job completion notice in the user’s Personal Channel, a
user can view job completion notices in his personal channel.
On New User—Jobs, you can select the notification options for successful
or failed jobs. You can also specify when to delete completion notices. Users
can change their own notification and e-mail address settings. The

Chapter 16, Managing Encyclopedia volume security 593

 following illustration shows the setting changes for notification that the
Encyclopedia volume administrator can make.

Choose Roles.

594 Administering Actuate iSer ver System

6 On New User—Roles, select the appropriate security roles for this user.
For more information about security roles, see “Working with roles,”
earlier in this chapter.

Choose Groups.

Chapter 16, Managing Encyclopedia volume security 595

 7 On New User—Groups, select the appropriate notification groups for this
user.
For more information about notification groups, see “Creating notification
groups” in Chapter 17, “Administering channels and notification groups.”

If you want to change the user’s privilege template and assign privileges to
other users or security roles for items this user creates, choose Privilege
Template.
8 On New User—Privilege Template, set the privileges for the users and
security roles. For more information about privileges, see “Working with
privilege templates,” earlier in this chapter.

596 Administering Actuate iSer ver System

 The following illustration shows New User—Privilege Template.

9 To specify a default printer and printer settings for the user, choose
Printing.

Chapter 16, Managing Encyclopedia volume security 597

 10 On New User—Printing, specify printer settings for the user.

To accept the settings, choose OK.

How to modify a user’s properties

1 In the Volume Administration console, choose Users from the side menu.
2 On Users, hover the pointer over the icon to the left of the user’s name and
choose Properties.
3 Modify the user’s properties.
For more information about user properties, see “How to add a user,”
earlier in this chapter.
Choose OK.

How to subscribe a user to channels

1 In the Volume Administration console, choose Users from the side menu.
2 On Users, hover the pointer over the icon to the left of the user’s name and
choose Channel Subscriptions.

598 Administering Actuate iSer ver System

3 On Users—Channel Subscriptions, move the appropriate channels from
Available to Selected.

Choose OK.
4 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 17, “Administering channels and
notification groups.”

How to clone a user

You can create a new user by cloning, or copying the properties of, an existing
user.
1 In the Volume Administration console, choose Users from the side menu.
2 On Users, hover the pointer over the icon to the left of the user’s name and
choose Clone.
3 On New User, modify the cloned user’s name and other properties as
necessary.
For more information about user properties, see “How to add a user,”
earlier in this chapter.

Chapter 16, Managing Encyclopedia volume security 599

 4 On Users, hover the pointer over the icon to the left of the cloned user’s
name and choose Channel Subscriptions.
5 On Users—Channel Subscriptions, modify the cloned user’s 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 user’s account

1 In the Volume Administration console, choose Users from the side menu.
2 On Users, hover the pointer over the icon to the left of the user’s name and
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:
■ How to modify security roles for more than one user at a time
■ How to modify notification groups for more than one user at a time
■ How to modify privilege templates for more than one user at a time
1 In the Volume Administration console, choose Users from the side menu.
2 On Users, select 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 pointer over Act upon selected users and choose Properties.
4 On Users—Properties, modify the properties and choose OK.

How to modify security roles for more than one user at a time
1 In the Volume Administration console, choose Users from the side menu.
2 On Users, select the names of the users whose security roles 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.

600 Administering Actuate iSer ver System

3 Hover the pointer over Act upon selected users and choose Properties.
4 On Users—Properties, choose Roles.
5 On Users—Properties—Roles:
■ To remove security roles, move the security roles from Available to
Remove these roles.
■ To remove all security roles from the selected users, select Remove all.
■ To add security roles, move the security roles from Available to Add
these roles.

Choose OK.

How to modify notification groups for more than one user at a time
1 In the Volume Administration console, choose Users from the side menu.
2 On Users, select the names of the users whose notification groups 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 pointer over Act upon selected users and choose Properties.
4 On Properties, choose Groups.

Chapter 16, Managing Encyclopedia volume security 601

 5 To remove notification groups, move the groups from Available to Remove
these groups.
To remove all notification groups from the selected users, select 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
1 In the Volume Administration console, choose Users from the side menu.
2 On Users, select the names of the users whose privilege templates 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 pointer over Act upon selected users and choose Properties.
4 On Properties, choose Privilege Template.
5 To remove privileges:

602 Administering Actuate iSer ver System

 1 Move the security role or user from Available to Remove these
privileges.
2 Deselect the privileges you do not want to remove.
3 Repeat substeps 1 and 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.
3 Repeat substeps 1 and 2 for the appropriate security roles and users.

7 Choose OK.

Chapter 16, Managing Encyclopedia volume security 603

 How to modify channel subscriptions for more than one user at a
time
1 In the Volume Administration console, choose Users from the side menu.
2 On Users, select the names of the users whose channel subscriptions 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 pointer 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.

604 Administering Actuate iSer ver System

 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 17, “Administering channels and
notification groups.”

How to delete more than one user account at a time

1 In the Volume Administration console, choose Users from the side menu.
2 On Users, select the names of the users whose accounts you want to delete.
3 Hover the pointer over Act upon selected users and choose Delete.
4 Confirm the deletion.

How to create a security role

1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, choose Create Role.
New Security Role appears.
3 On New Security Role—General, type the name of the security role and a
description.

4 On New Security Role—Parent Roles, select parent roles for this security
role.
For more information about parent roles, see “Working with roles,” earlier
in this chapter.

Chapter 16, Managing Encyclopedia volume security 605

 5 On New Security Role—Child Roles, select child roles for this security role.

6 On New Security Role—Channel Privileges, assign channel privileges for

this security role.
For more information about channel privileges, see “Creating and
maintaining channels” in Chapter 17, “Administering channels and
notification groups.”

606 Administering Actuate iSer ver System

7 Choose OK.

How to modify a security role’s properties

1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, hover the pointer over the icon to the left of the security
role’s name and choose Properties.
3 Modify the security role’s 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

1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, hover the pointer over the icon to the left of the security
role’s name and choose Users.
Users appears.

Chapter 16, Managing Encyclopedia volume security 607

 3 To add users:
1 Choose Add.
2 Move the user or users that you want to add from Available to Add.
3 Choose OK.
4 To remove users:
1 Select the users that you want to remove.
2 Choose Remove.
3 Confirm the removal.
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.
1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, hover the pointer over the icon to the left of the security
role’s name and choose Clone.
3 On New Security Role, modify the cloned security role’s name and other
properties as necessary.
For more information about security role properties, see “How to create a
security role,” earlier in this chapter.

608 Administering Actuate iSer ver System

4 On Security Roles, hover the pointer over the icon to the left of the cloned
security role’s name and choose Users.
5 On Users, modify the cloned security role’s 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

1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, hover the pointer over the icon to the left of the security
role’s 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:
■ How to modify parent roles for more than one security role at a time
■ How to modify child roles for more than one security role at a time
1 In the Volume Administration console, choose Security Roles from the side
menu.
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 pointer over Act upon selected Roles and choose Properties.
4 On Properties, modify the properties and choose OK.

How to modify parent roles for more than one security role at a
time
1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, select the names of the security roles whose parent roles
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 pointer over Act upon selected Roles and choose Properties.

Chapter 16, Managing Encyclopedia volume security 609

 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
1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, select the names of the security roles whose child roles
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 pointer over Act upon selected Roles and choose Properties.

610 Administering Actuate iSer ver System

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
1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, select the names of the security roles from which you
want to add or remove users.
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 pointer over Act upon selected Roles and choose Users.

Chapter 16, Managing Encyclopedia volume security 611

 Users appears.

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

1 In the Volume Administration console, choose Security Roles from the side
menu.
2 On Security Roles, select the names of the security roles you want to delete.
3 Hover the pointer over Act upon selected Roles and choose Delete.
4 Confirm the deletion.

How administrators assign privileges on a file or folder

1 In the Volume Administration console, choose Files and Folders.
2 On Files and Folders, hover the pointer over the icon to the left of the name
of the file or folder and choose Properties.
3 On Properties, choose Privileges.

612 Administering Actuate iSer ver System

4 On Properties—Privileges:
■ Select Share if necessary.
■ 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.

Choose OK.

How administrators assign privileges on the Encyclopedia

volume’s root folder
1 In the Volume Administration console, choose Volume from the side menu.
2 On Volume, choose Properties.
3 On Volume—Properties, choose Privileges.
4 On Volume—Properties—Privileges, assign the appropriate privileges for
the Encyclopedia volume’s root folder.
You can assign privileges for both users and security roles.

Chapter 16, Managing Encyclopedia volume security 613

 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.

About page-level security

Actuate report page-level security is available if you enable the e.Report
Option and the Page Level Security Option. With report page-level 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 enabled, the page-level security features of a report are disabled and
users are notified that the Page Level Security Option is required to read the
report.

614 Administering Actuate iSer ver System

Using report page-level security, the report developer creates a report that
defines a list of users and security roles associated with the report’s 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-level security, see Chapter 16,
“Controlling user access through page-level security,” in Developing Actuate
Basic Reports.

Viewing reports with page-level security

When the report is in the Encyclopedia volume and viewed, the View process
retrieves information about the user from the Encyclopedia volume. The
user’s 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-level 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 report’s 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 page’s ACL contains Demo.

Enabling report page-level security

To use page-level security in a shared Actuate Basic reports, administrators set
the following privileges for a user or security role:
■ The report object executable (.rox) file requires read and execute privilege.
■ The report object instance (.roi) file requires secure read privilege.
If the report document has read privilege, page-level 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 “Working with
privileges,” earlier in this chapter.

How to enable page-level security

To enable page-level security on a shared Actuate Basic report document,
apply the secure read privilege on the report document. Any user who wants

Chapter 16, Managing Encyclopedia volume security 615

 to run the report must also have read and execute privilege on the report
object executable (.rox) file.

How to disable page-level security

To disable page-level security on a report, apply the read privilege to the
report or set the report’s access type to do not share.
If you apply the read privilege, any user with read privilege can read the entire
report, even if the report uses page-level security.

About Actuate Open Security

Actuate Open Security is available with the iServer. 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, Actuate iServer
System retrieves information from the external security source to control
access to the Encyclopedia volume. Developers create an interface to the
Encyclopedia 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 user’s 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

616 Administering Actuate iSer ver System

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, Actuate iServer System
determines whether a user has the right to access a particular item in an
Encyclopedia volume.
Actuate supplies an Open Security application with the iServer. The Open
Security application uses security information from a Netscape Directory
Server, an LDAP server, to control logins into the Encyclopedia volume. The
Open Security application that ships with the iServer 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 4, “Configuring Actuate iServer security.”
Actuate Open Security can be configured for one of several levels of use. The
Open Security application that ships with the iServer uses the external user
registration level. The following table lists and describes all the available Open
Security levels.

Level Description
Open Security not This option is the default. All information about
used users, security roles, and notification groups is
specified and stored in the Encyclopedia volume.
All privilege information used for authorization is
stored in the Encyclopedia volume.
External user Users, security roles, and notification groups are
authentication specified and stored in the Encyclopedia volume.
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.

Chapter 16, Managing Encyclopedia volume security 617

 Level Description
External user Users, security roles, and notification groups are
properties specified and stored in the Encyclopedia volume.
Some or all user properties are specified in an
external security source.
External or internal user authentication can be used.
External user Users, security roles, and notification groups are
registration specified in an external security source. They are not
specified or stored in the Encyclopedia volume.
All user properties are obtained externally.
External user authentication must be used.

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, Actuate iServer
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
Encyclopedia volume. The security source determines whether the user
credentials are valid and what Actuate user account should be used to access
the Encyclopedia volume.
Actuate iServer System passes the user’s login credentials to the security
extension application. The application evaluates the credentials and
determines whether the user is allowed access to the Encyclopedia volume.
At this Open Security level, Actuate user accounts and Actuate security roles
are defined in the Encyclopedia volume. Each user must be defined in the
Encyclopedia 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:
■ E-mail address
■ Web viewing preference

618 Administering Actuate iSer ver System

■ Home folder
■ Privilege template
■ Maximum job priority
■ Security IDs (used for page-level security)
■ Notification preferences
■ Channels to which the user subscribes
If a property is specified externally, the property’s value in the Encyclopedia
volume is ignored. You cannot use the Volume Administration console to
update the property.
At this Open Security level, the following information is managed within the
Encyclopedia volume:
■ User name
■ Security role membership
■ Notification group membership
■ 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 user’s
properties.
At this Open Security level, the Encyclopedia volume passes the user’s log in
ID and credentials to the RSSE application. The application evaluates the
credentials and determines whether the user is allowed access to the
Encyclopedia volume and, if so, what the user properties are.
The following information about the user is maintained externally:
■ User name
■ E-mail address
■ Web viewing preference
■ Home folder
■ Privilege template
■ Maximum job priority
■ Security role membership

Chapter 16, Managing Encyclopedia volume security 619

 ■ Security IDs (used for page-level security)
■ Notification preference
■ Notification group membership
■ Channels to which the user subscribes
At this Open Security level, you do not specify or store the user in the
Encyclopedia 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
Encyclopedia volume.
You define privileges for folders and files using security roles or user names.
Use the Volume Administration console 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 Encyclopedia 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 Encyclopedia volume. Instead, the Encyclopedia volume uses the RSSE
application to retrieve lists of users, security roles, and notification groups and
their properties.
The Encyclopedia volume stores access control lists for each folder and other
items such as reports and other files in the Encyclopedia 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 Encyclopedia volume.
If the RSSE application enables the Encyclopedia volume’s All security role, a
security role with the name All can exist in the external security source, but
Encyclopedia volume administrators might not want to use the security role

620 Administering Actuate iSer ver System

name All as the Encyclopedia volume’s All security role. Developers can use
Open Security functionality to use a different security role name that is
assigned to all users.

About the anonymous user and external registration

When using external user registration, Actuate iServer does not support the
special user with the name anonymous. If no Open Security is used and the
user anonymous is present with no assigned password in the Encyclopedia
volume, the anonymous user is used as a default login into the Encyclopedia
volume.
When using external user registration, a developer must set up the external
security source and RSSE application to support connecting as anonymous. To
do so, the RSSE application must accept a login with the user name
anonymous and with no password.

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 Encyclopedia volume and can
perform administrative functions and can access any item in the Encyclopedia
volume.
A security role with the name Administrator can exist in the external security
source, but Encyclopedia volume administrators might not want to use the
administrator security role to administer the Encyclopedia 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 Encyclopedia volume.
The administrator user can access and administer any item in the
Encyclopedia volume.
When using external user registration, the administrator user stored in the
Encyclopedia volume is not available. For users to administer the
Encyclopedia volume, they must belong to the Administrator security role.

Chapter 16, Managing Encyclopedia volume security 621

 About the Operator security role and external
authentication
The Operator security role is a system security role. Members of the
Encyclopedia volume’s Operator security role can configure the Encyclopedia
volume into read-only mode for online backup and can return the
Encyclopedia volume to normal mode from read-only mode. When using
external registration, the Operator security role is defined in the Encyclopedia
volume. Users assigned to the security role named Operator have the same
capabilities in the Encyclopedia volume.
A security role with the name Operator can exist in the external security
source, but Encyclopedia volume administrators might not want to use this
security role for online backup in the Encyclopedia 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 Encyclopedia volume maintains a list of channels. The Encyclopedia
volume or an external security source maintains the list of channels to which a
user subscribes.

Using the Volume Administration console with open

security
This section describes the differences in the Volume Administration console
when using the Actuate open security application that ships with the iServer.

Log in with open security

Using the Active Portal Security Extension, developers can create a custom
login for use when a user accesses the Encyclopedia 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
Encyclopedia volume. The login application passes the login information from
the desktop product to the Encyclopedia volume for authentication.

622 Administering Actuate iSer ver System

About home folder privileges with externally
defined users
If the Encyclopedia volume uses the Actuate Open Security RSSE application
that ships with the iServer, the Encyclopedia volume’s administrator must
assign privileges on the user’s home folder. The privileges on a user’s home
folder are not automatically updated.

About printer properties for externally defined

users
Three levels exist for setting printer properties:
■ Default printer properties for the Encyclopedia volume
■ Default printer properties for a user
■ Printer properties for a specific job
If users are defined externally, the Volume Administration console disables 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, and home folder are defined externally. Each of
these fields is read-only.

Chapter 16, Managing Encyclopedia volume security 623

 About the wildcard character
You cannot use the wildcard character, an asterisk (*), in Filter on any page in
the Volume Administration console if the Encyclopedia volume uses open
security.

About information object pass-through security

An Actuate information architect can create an Actuate information object that
uses pass-through security when it connects to a data source. To connect to a
data source, an information object uses data connection definition (.dvd) file.
An Encyclopedia volume administrator configures a DCD to support pass-
through security. The DCD specifies what security information, such as a user
name and password, the information object uses to access data from the data
source. The information object developer specifies the security policy that an
information object uses, which controls the information that the DCD uses to
connect the data source.
The security policy for an information object is either proxy or pass-through:
■ With proxy security, the information object uses the proxy security
information that the DCD specifies when it connects to a data source.
■ With pass-through security, the information object uses the security
information of the Encyclopedia volume user who runs the information
object when it connects to the data source.

How to configure an information object to use pass-through

security
1 In the Volume Administration console, choose Files and Folders.
2 On Files and Folders, hover the pointer over the icon to the left of the name
of a DCD and choose Pass Through Security.
Pass Through Security appears.

624 Administering Actuate iSer ver System

3 To enable pass-through security for a user or role, select the user or role in
Available, and choose the right arrow to move the user or role to Selected.
Data source connection properties looks like the one in the following
illustration.

Chapter 16, Managing Encyclopedia volume security 625

 4 To add a property name and value for the selected users or roles, choose
Add.
In the following illustration, the properties UserID and Password are the
relevant data source connection properties for the Intermediate Actuate
Active Portal role.

5 To edit a property value for a user or role:

1 Choose the user or role in Selected to display the properties and values.
2 Select the property and choose edit.
6 To delete a property value for a user or role:
1 Choose the user or role in Selected to display the properties and values.
2 Select the property and choose delete.

626 Administering Actuate iSer ver System

 Chapter

Administering channels
Chapter17
17
and notification groups
This chapter contains the following topics:
■ About channels
■ Viewing channels and their contents
■ Creating and maintaining channels
■ Scheduling jobs for channels
■ Creating notification groups

Chapter 17, Administering channels and notification groups 627

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 channel’s 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:
■ 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 Creating Custom Web Applications using Actuate
Active Portal.
■ Channels are secure.
■ Channels have unique names.
■ Channels receive notifications when reports generated for the channel
complete.
■ Reports in channels can display headlines that describe the reports. This
headline appears when listing the contents of a channel.
■ Channel items expire after a given time period and are removed from the
channel.
A user can:
■ Retrieve the list of available channels.
■ Subscribe to a channel.
■ Drop a channel subscription.
■ View the list of reports in a channel.
■ View the reports in a channel.
■ Update a channel’s contents.
Users can subscribe to channels and drop channel subscriptions using Actuate
Active Portal. After connecting to an Encyclopedia volume, users can go to a
page that lists all channels to which the user has access.
Actuate Active Portal provides web pages that:

628 Administering Actuate iSer ver System

 ■ Display the contents of a channel. The contents are completed jobs that
appear in descending chronological order.
■ Enable the user to subscribe to or unsubscribe from a channel.
Actuate Management Console provides web pages that:
■ Enable the administrator to subscribe users to or unsubscribe users from a
channel.
■ Let an administrator create, delete, and modify channels.
■ 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 channel’s contents. The
following illustration shows Channels for a user in Actuate Active Portal.

Chapter 17, Administering channels and notification groups 629

 The following illustration shows Channels for a user in Actuate Management
Console.

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.
The following illustration shows a list of reports in Actuate Active Portal.
Actuate Active Portal displays read reports in a different color than new,
unread reports.

630 Administering Actuate iSer ver System

 The following illustration shows one report read in Actuate Management
Console.

Creating and maintaining channels

Only an Encyclopedia volume’s administrator can create, modify, or delete
channels. The Encyclopedia volume’s administrator has access to all channels
defined for the Encyclopedia volume. The administrator specifies which
security roles and users have access to which channels.

How to create a channel

1 In the Volume Administration console, choose Channels from the side
menu.
2 On Channels, choose Create Channel.
3 On New Channel, complete General.

Parameter Description
Name The channel name can be any length, but
must be unique.
Description A description of the channel.
Auto delete after The length of time the report is available in
the channel. After that, the Encyclopedia
volume deletes the report notice from the
channel. The default is 14 days.

Chapter 17, Administering channels and notification groups 631

 Parameter Description
Small (16x16) icon URL The full URL of an image file. If this URL is
not set, a default image is used to represent
the channel.
Actuate Management Console displays only
the small icon.
Large (32x32) icon URL The full URL of an image file. If this URL is
not set, a default image is used to represent
the channel.
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 also specify which security roles and users have which
privileges on a specific report. If a user has read privilege on a channel, the
user is subscribed to the channel. For information about assigning
privileges on a report, see “How administrators assign privileges on a file
or folder” in Chapter 16, “Managing Encyclopedia volume security.”

632 Administering Actuate iSer ver System

6 Choose OK.

How to update a channel

1 In the Volume Administration console, choose Channels from the side
menu.
2 On Channels, hover the pointer over the icon to the left of the channel’s
name and choose Properties.
3 Modify the channel’s 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

1 In the Volume Administration console, choose Channels from the side
menu.
2 Hover the pointer over the icon to the left of the channel’s name and choose
Show Subscribers.

Chapter 17, Administering channels and notification groups 633

 3 Choose Close.

How to clone a channel

You can create a new channel by cloning, or copying the properties of, an
existing channel.
1 In the Volume Administration console, choose Channels from the side
menu.
2 On Channels, hover the pointer over the icon to the left of the channel’s
name and choose Clone.
3 On New Channel, modify the channel’s 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 16, “Managing Encyclopedia volume
security.”
7 Modify the channel’s other properties as necessary.

634 Administering Actuate iSer ver System

 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

1 In the Volume Administration console, choose Channels from the side
menu.
2 Hover the pointer over the icon to the left of the channel’s name and choose
Delete.
3 Confirm the deletion.

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.
1 In the Volume Administration console, choose Channels from the side
menu.
2 On Channels, select the names of the channels whose properties you want
to modify.
To select all channels, choose Select all channels. To select all channels on
the current page, select the box to the left of the Name column heading.
3 Hover the pointer over Act upon selected channels and choose Properties.
4 On Properties, modify the properties and choose OK.

How to modify the privileges for more than one channel at a time
1 In the Volume Administration console, choose Channels from the side
menu.
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
current page, select the box to the left of the Name column heading.
3 Hover the pointer 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.

Chapter 17, Administering channels and notification groups 635

 2 Deselect the privilege you do not want to remove.
3 Repeat substeps 1 and 2 for the appropriate security roles and users.
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.
3 Repeat steps 1 and 2 for the appropriate security roles and users.

7 Choose OK.

How to delete more than one channel at a time

1 In the Volume Administration console, choose Channels from the side
menu.
2 On Channels, check the names of the channels you want to delete.
3 Hover the pointer over Act upon selected channels and choose Delete.

636 Administering Actuate iSer ver System

 4 Confirm the deletion.

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 “Working with
privileges” in Chapter 16, “Managing Encyclopedia volume security.”
When Actuate iServer 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 schedule’s
Properties page, as shown in the following illustration.

Report developers can also specify the headline. By default, the Encyclopedia
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

Chapter 17, Administering channels and notification groups 637

 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 In the Volume Administration console, choose Jobs from the side menu.
2 On Jobs, choose Scheduled.
3 Hover the pointer over the icon to the left of the job name and choose
Properties.
4 On Job Schedules—Properties, choose Channels.
5 On Job Schedules—Properties—Channels, select the appropriate channels.

Choose OK.

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 Encyclopedia volume notifies each member of the group when the job
completes, using the notification method specified for each user’s account.

638 Administering Actuate iSer ver System

Only administrators can create notification groups; users cannot create or
modify notification groups.
If the Encyclopedia volume is using the Actuate Open Security feature, see
“About Actuate Open Security” in Chapter 16, “Managing Encyclopedia
volume security.”

How to create a notification group

1 In the Volume Administration console, choose Notification Groups from
the side menu.
2 On Notification Groups, choose Create Group.
3 On New Group—Properties, type the name of the group and a description.

Choose OK.

How to add and remove users from a notification group

1 In the Volume Administration console, choose Notification Groups from
the side menu.
2 Hover the pointer over the icon to the left of the notification group’s name
and choose Users.
Notification Groups—Users appears.

Chapter 17, Administering channels and notification groups 639

 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 Select the users you want to remove.
2 Choose Remove.
3 Confirm the removal.
5 Choose Close.

How to rename or delete a notification group

■ To rename a notification group, hover the pointer over the icon to the left of
the notification group’s name and choose Properties. Then, type the new
name on the group’s 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.
■ To delete a notification group, hover the pointer over the icon to the left of
the notification group’s name and choose Delete. Confirm your intention to
delete the group when prompted.

640 Administering Actuate iSer ver System

 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.
1 In the Volume Administration console, choose Notification Groups from
the side menu.
2 On Notification Groups, hover the pointer over the icon to the left of the
group’s name and choose Clone.
3 On New Group, modify the cloned group’s name and description.
4 Choose OK.
5 On Notification Groups, hover the pointer over the icon to the left of the
cloned group’s name and choose Users.
6 On Notification Groups—Users, modify the cloned group’s 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
1 In the Volume Administration console, choose Notification Groups from
the side menu.
2 On Notification Groups, select the names of the groups whose description
you want to modify.
To select all groups, choose 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 pointer over Act upon selected groups and choose Properties.
4 On Notification groups—Properties, type the description.

Chapter 17, Administering channels and notification groups 641

 Choose OK.

How to add and remove users from more than one notification
group at a time
1 In the Volume Administration console, choose Notification Groups from
the side menu.
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
current page, select the box to the left of the Name column heading.
3 Hover the pointer over Act upon selected groups and choose Users.
Notification Groups—Users appears.

642 Administering Actuate iSer ver System

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

1 In the Volume Administration console, choose Notification Groups from
the side menu.
2 On Notification Groups, select the names of the groups you want to delete.
3 Hover the pointer over Act upon selected groups and choose Delete.
4 Confirm the deletion.

Chapter 17, Administering channels and notification groups 643

644 Administering Actuate iSer ver System
 Chapter

Managing printers and

Chapter 18
18
print jobs
This chapter contains the following topics:
■ About Actuate iServer System printers
■ About printer properties
■ Setting up printers
■ Managing print jobs as an administrator

Chapter 18, Managing printers and print jobs 645

About Actuate iServer System printers
The Encyclopedia volume recognizes and supports printers set up for Actuate
iServer System. You do not have to install printers specifically for the
Encyclopedia volume. You do, however, customize printer settings for each
printer available to the Encyclopedia volume.
As an Encyclopedia volume administrator, you need to prepare the Actuate
system printers so that users can use them to print reports in the Encyclopedia
volume. You typically perform this task immediately after the Actuate iServer
System is installed and whenever the system administrator adds an Actuate
iServer System printer. For more information about adding an Actuate iServer
System printer, see “Adding a printer” in Chapter 11, “Adding and
configuring an Actuate iServer System printer.” For information about setting
Actuate iServer parameters for printing, see “Specifying parameter values for
an Actuate iServer System printer” in Chapter 7, “Working with an
Actuate iServer System server.”
Preparing printers entails setting the Encyclopedia volume-level properties for
each printer. Once these are set, users can use the Encyclopedia 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 printer gets its printing options from three
sources, in the following order:
■ The printer properties the user sets for the print job.
■ The printer properties the Encyclopedia volume administrator or user sets
as the default settings for a specific printer. The user’s default settings take
precedence.
■ The printer’s Encyclopedia volume-level properties that the Encyclopedia
volume administrator sets.
If the Encyclopedia volume is using Actuate Open Security and users are
defined externally, the Encyclopedia volume disables the ability to modify
default printer properties for a user. For information about Open Security see
“About Actuate Open Security” in Chapter 16, “Managing Encyclopedia
volume security.”
The following diagram illustrates how a printer determines what printer
properties to use for a print job.

646 Administering Actuate iSer ver System

 Properties set for
the print job? Yes

No

Properties set for Yes Printer uses

the printer? these settings

No

Yes
Encyclopedia
volume defaults

Setting up printers
As Encyclopedia volume administrator, you need to set up printers before
users can print to them. For each printer available to the Encyclopedia volume,
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 user’s default
printer settings, see “How to add a user” in Chapter 16, “Managing
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 2, “Working with items in an Encyclopedia volume,” in Using Actuate
Management Console.

How to set Encyclopedia volume-level printer properties

1 In the Volume Administration console, choose Volume from the side menu.
2 On Volume, choose Properties.
3 On Volume—Properties, choose Printing.
4 On Volume—Properties—Printing, specify a default printer and printer
settings for the Encyclopedia volume.

Chapter 18, Managing printers and print jobs 647

 The following fields are read-only:
■ Manufacturer
■ Model
■ Description
■ Location

When you have finished setting the properties for a printer, you can set
properties for another printer by selecting a different printer.
Choose OK.

Managing print jobs as an administrator

All scheduled, pending, running, and completed print jobs for the
Encyclopedia volume can be viewed with the Jobs pages when you log in as
Administrator. To display Jobs, choose Jobs from the side 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
Encyclopedia volume.

648 Administering Actuate iSer ver System

To cancel a print job, cancel the job on Jobs—Pending or Jobs—Running.

Chapter 18, Managing printers and print jobs 649

650 Administering Actuate iSer ver System
 Chapter

Administering jobs
Chapter 19
19
This chapter contains the following topics:
■ Understanding job administration
■ About scheduled jobs
■ About job priorities and resource groups
■ About users’ job priorities
■ Administering open server jobs
■ Setting a maximum job priority
■ Setting the default job retry policy
■ Setting the Encyclopedia volume’s default job retry policy
■ Running scheduled jobs after a system restart
■ Converting output from an Actuate Basic report to other formats
■ Working with an Actuate Caching service (ACS) cache

Chapter 19, Administering jobs 651

Understanding job administration
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
Actuate iServer System by setting:
■ A job’s execution schedule
■ A user’s maximum job priority
■ A scheduled job’s priority
■ For scheduled jobs, a retry schedule for failed jobs
For more information about scheduling jobs, see Chapter 3, “Running a
report,” in Using Actuate Management Console.
A user must have execute privilege on a report executable (.rox) file to run it
and create a job to generate a report object instance (.roi) file. If the user creates
a report document using values from a parameter value (.rov) file, the user
must also have read access to the parameter value 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, Actuate iServer System incorporates a
flexible job scheduling model. The scheduled jobs appear on the Job Schedules
page. For more information about scheduling jobs, see Chapter 3, “Running a
report,” in Using Actuate Management Console.
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 user’s personal channel. At this point the job is
considered obsolete.

652 Administering Actuate iSer ver System

About job priorities and resource groups
Each job has a priority, which is an integer between 1 and 1000. Higher
numbers indicate higher priorities. If you configure asynchronous resource
groups, the priority also controls which Actuate iServer Factory process runs
the job.
A resource group specifies a set of Actuate iServer System Factory processes
reserved to only execute jobs assigned to the group. An asynchronous resource
group has priority range setting. The resource group handles jobs in within its
priority range unless the an Encyclopedia volume administrator specifies the
resource group when submitting the job.
For information about resource groups, see Chapter 10, “Adding and
configuring an Actuate iServer System resource group.”

About users’ job priorities

As the administrator, you set the user’s maximum job priority. For information
about assigning a user’s maximum job priority, see “How to set a user’s
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. Actuate iServer System uses the job’s 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 Actuate iServer 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 you configure Actuate iServer System to generate a Crystal
Reports report document, Actuate iServer System creates and handles the job’s
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

Chapter 19, Administering jobs 653

 server see “Configuring report viewing,” in Chapter 21, “Understanding
Actuate iServer options.”

Setting a maximum job priority

As the Encyclopedia volume’s administrator, you control a user’s 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 user’s maximum job
priority is defined in an external security source, it cannot be changed from the
Volume Administration console. For information about Open Security, see
“About Actuate Open Security” in Chapter 16, “Managing Encyclopedia
volume security.”

How to set a user’s maximum job priority

1 In the Volume Administration console, choose Users from the side menu.
2 Hover the pointer over the icon to the left of the user’s name and choose
Properties.
3 On Users—Properties, choose Jobs.
4 On Users—Properties—Jobs, set the user’s maximum job priority.

654 Administering Actuate iSer ver System

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:
■ The Encyclopedia volume’s default job retry settings are the default
settings for scheduled jobs.
■ For a scheduled job, the scheduled job settings override the Encyclopedia
volume’s default settings. For information about setting scheduled job
retry options, see Chapter 3, “Running a report,” in Using Actuate
Management Console.

Setting the Encyclopedia volume’s default job retry

policy
As Administrator, you can configure the Encyclopedia 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 Encyclopedia volume’s default job retry policy.
■ Retry settings do not apply to jobs that are not scheduled. Reports are set to
run using the Right now option.
■ 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 Encyclopedia volume resubmits the job
immediately after a failure.
■ 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 Encyclopedia volume’s default job retry policy

1 In the Volume Administration console, choose Volume from the side menu.
2 On Volume, choose Properties.
3 On Volume—Properties, choose General.
4 On Volume—Properties—General, specify the default job retry policy, and
choose OK.

Chapter 19, Administering jobs 655

Running scheduled jobs after a system restart
If Actuate iServer System is down at the time a job is scheduled to run, the job
runs when Actuate iServer System restarts.

Converting output from an Actuate Basic report to

other formats
Actuate iServer supports converting the report object instance (.roi) file from
an Actuate Basic report to one of the following formats:
■ PDF
■ Excel Display
■ Excel Data
■ RTF
■ Fully Editable RTF
Actuate iServer supports converting Actuate Basic report output for only
asynchronous report generation jobs. You cannot use Actuate iServer to
convert the following types of output:
■ Synchronous Actuate Basic report generation output
■ An Actuate Basic report that uses report bursting

656 Administering Actuate iSer ver System

■ An Actuate Basic report that uses page-level security
■ Actuate Query output
After running an Actuate Basic report and creating an ROI, Actuate iServer
sends the request to an Actuate iServer node that has the View service enabled.
Then, a View process on the Actuate iServer node converts the ROI. Actuate
iServer System stores the output in the Encyclopedia volume that runs the job.
Actuate Active Portal and Management Console display the job detail
information when you convert Actuate Basic output. Actuate Active Portal
and Management Console do not support creating a job that converts Actuate
Basic output. You must use IDAPI to convert Actuate Basic output. For more
information about IDAPI, see Programming with Actuate iServer APIs.

Understanding the conversion process for

Actuate Basic output
When Actuate iServer runs a job that converts Actuate Basic output from a
report object instance (.roi) file to another format, Jobs—Running displays
information about the conversion process in the job’s detail information.
As part of the job message, the Format flag for the job specifies the format to
which to convert the output. The properties of the converted output are the
same as the properties of the ROI. To specify the properties of the output file,
specify the properties of the ROI. File properties include:
■ Name
■ VersionName
■ ReplaceExisting
■ MaxVersions
■ Description
■ ArchiveRule
■ ACL
■ AccessType
If the job request is invalid, Actuate iServer sets the state of the conversion to
Failed and logs the reason for the failure in the job’s status file and the error
log.
After the job completes, Actuate iServer displays information about the
success or failure of the job and the output conversion on Jobs—Completed in
the detailed information about the job.

Chapter 19, Administering jobs 657

 Actuate iServer does not retry a job if the conversion fails. If a user submits a
retry request, Actuate iServer runs a new job, generates a new ROI, and
converts the new ROI.
A user can cancel a job that converts Actuate Basic output. If the user cancels
the job after Actuate iServer generates the ROI and during the conversion
process, the View process completes the conversion and returns the converted
output to the Encyclopedia volume. The Actuate iServer node that manages
the Encyclopedia volume deletes the generated output, and changes the state
of the job to Cancel.
Using the Actuate IDAPI, specify whether Actuate iServer keeps the ROI after
converting the output by setting one or both of the following the IDAPI flags:
■ KeepROIIfFailed
■ KeepROIIfSucceeded
For more information about IDAPI, see Programming with Actuate iServer APIs.

Working with an Actuate Caching service (ACS)

cache
Using an ACS cache with an information object or a Record Matcher
application requires that am Encyclopedia volume administrator complete the
following tasks:
■ Installing and configuring the external database that manages the
information object cache database and Record Matcher database. For a list
of supported DBMS, see “About DBMS platforms for Actuate Caching
service (ACS) databases,” later in this chapter. For information about
configuring the external database, see “Configuring an Actuate Caching
service (ACS) database,” later in this chapter.
■ Configuring the Encyclopedia volume to connect to the database. An
Encyclopedia volume administrator specifies an ACS database for each
Encyclopedia volume. Multiple volumes can use a single database. For
more information about configuring an Encyclopedia volume to use an
ACS database, see “Configuring an Encyclopedia volume to use an Actuate
Caching service (ACS) database,” later in this chapter.

Configuring an Encyclopedia volume to use an

Actuate Caching service (ACS) database
Actuate iServer can store data for multiple information object caches and
multiple Record Matcher applications within the ACS database. An

658 Administering Actuate iSer ver System

Encyclopedia volume can use separate databases to cache information object
data and Record Matcher data. The following illustration shows an
Encyclopedia volume’s information object cache connection configuration on
Volume—Properties—Cache Connection.

The following illustration shows Volume—Properties—Record Matcher

Connection.

Chapter 19, Administering jobs 659

 The following table describes the parameters that appear on Volume—
Properties—Cache Connection and Volume—Properties—Record Matcher
Connection.

Parameter Description
Database type Type of database to which to connect.
Admin user name Encyclopedia volume administrator name.
Admin password Encyclopedia volume administrator
password.
User name User name to use to access the database.
For more information, see “Configuring an
Actuate Caching service (ACS) database,”
later in this chapter.
Password Password to use to access the database. For
more information, see “Configuring an
Actuate Caching service (ACS) database,”
later in this chapter.
Server DSN Database DSN on the server.
Server Name of the server that hosts the database.
Database Name of the database to which to connect.
Port Port number to use to access the database.
SID Oracle only. Security ID to connect to the
database.

After you configure connection information for one Encyclopedia volume, you
can import and export connection information for the information object cache
database and Record Matcher database to another Encyclopedia volume.
When you create an information object cache, Actuate iServer creates an
empty cache in the ACS database. To populate the cache, you must run the
cache as a job in the Encyclopedia volume. When you populate and update a
cache with data from the data source, Actuate iServer runs the information
object that depends on the cache. Actuate iServer assumes that the information
object retrieves the data that is consistent with the data Actuate iServer stores
in the data cache. For information about updating an information object cache,
see “Running or updating an Actuate Caching service (ACS) cache,” later in
this chapter.
If you update the information object, Actuate iServer deletes the dependency
between the cache and the information object. The information object does not
use the information object cache data.
You can also create a dependency between a new information object and the
cache. Before you use the cache, ensure that the new information object uses

660 Administering Actuate iSer ver System

the same data, such as column names and data types, as the original
information object.

Configuring an Actuate Caching service (ACS)

database
For information about configuring an Encyclopedia volume to use an ACS
database, see “Configuring an Encyclopedia volume to use an Actuate
Caching service (ACS) database,” earlier in this chapter.
To enable the Actuate Caching service (ACS) to automatically install caches,
configure the database with a special user name and password to be used for
installing caches.
This user name and password should not be stored in any connection objects
or any other ACS metadata or configuration. A user must supply it when
necessary.
Also, set up a separate user name and password for creating connection
objects.

About DBMS platforms for Actuate Caching

service (ACS) databases
The following table lists the DBMS platforms that Actuate supports for ACS
databases.

DBMS Operating System

SQL Server 7 Microsoft Windows
SQL Server 2000, including Microsoft Windows
Service Pack 3 and Service
Pack 4

About database connections for Actuate

Integration service (AIS)
Both an Actuate iServer Factory process and an Actuate desktop application
access an information object and AIS using the ODA interface. The AIS ODA
driver supports both the design-time and run-time interfaces of ODA:
■ For an Actuate desktop application, the ODA driver requests an Actuate
iServer that has AIS enabled. The ODA driver then creates a connection to
that host.

Chapter 19, Administering jobs 661

 ■ For a Factory process, the ODA driver uses the AIS server that its
configuration identifies. The default configuration specifies that all Factory
processes use the AIS that is on the machine where the Factory process
runs.

Working with an information object cache

The following sections describe how to work with an information object cache
using the Volume Administration console of Actuate Management Console:
■ About information object cache creation and configuration
■ Creating and configuring an information object cache
■ Enabling an information object cache
■ Replicating an information object cache
■ Deleting an information object cache
For information about updating an information object cache, see “Running or
updating an Actuate Caching service (ACS) cache,” later in this chapter.

About information object cache creation and

configuration
An Encyclopedia volume administrator performs the following cache
management tasks for an information object cache:
■ Specify the DBMS installation that contains the cache databases. For
information about supported databases, see “About DBMS platforms for
Actuate Caching service (ACS) databases,” earlier in this chapter.
■ Configure databases to store information object and Record Matcher data.
For information, see “Understanding Actuate Record Matcher” in Chapter
5, “Actuate iServer System administration overview.”
■ Enable and disable cache usage, specify whether to use cached or source
data when running an information object job. For information, see
“Enabling an information object cache,” later in this chapter.
■ Set caching options and default parameters for cache updates. For
information, see “About information object cache creation and
configuration” and “Enabling an information object cache,” later in this
chapter.
■ Update a cache with data from one or more data sources. For information,
see “Running or updating an Actuate Caching service (ACS) cache,” later
in this chapter.
■ Review cache updates. For information, see “Reviewing cache update
information,” later in this chapter.

662 Administering Actuate iSer ver System

■ Replicating a cache. For information, see “Replicating an information object
cache,” later in this chapter.
■ Delete cache data and the cache database schema from the Actuate Caching
service (ACS) database. For information, see “Deleting an information
object cache,” later in this chapter.
For a general introduction to information objects, see “Working with
information objects and caching” in Chapter 5, “Actuate iServer System
administration overview.”

Creating and configuring an information object cache

Using Properties—General for an information object, an Encyclopedia volume
administrator can create an information object cache. After you create an
information object cache, you can use the information object in the
Encyclopedia volume to create an information object cache definition (.icd)
file.

On Properties—General for an information object (.iob) file, an Encyclopedia

volume administrator can choose Create Cache to create an information object
cache.

Chapter 19, Administering jobs 663

 The following table describes the parameters that appear on Properties—
General for an information object.

Parameter Description
Name Name of the file.
File type Encyclopedia volume file type. For
complete descriptions of all Actuate
Encyclopedia volume file types, see Actuate
8 Glossary.
Version number Version number of the file.
Version name Optional name of this version of the file.
Size Size of the file.
Description Optional description of the file.
User Name of the user that owns the file.
Created Date on which Actuate iServer created the
file.
Replace the latest version If selected, indicates that Actuate iServer
replaces the latest version of this file when
it generates a new version.
Create a new version If selected, indicates that Actuate iServer
creates a new version of this file when it
generates the file again.
Keep only the latest n versions If selected, indicates that Actuate iServer
retains the specified number of versions of
a file, where n is the number of versions to
retain. When the specified number of
versions exist in the Encyclopedia volume,
Actuate iServer replaces the oldest version
of the file with the newest version when it
generates the file again.

When you create an information object cache, Actuate iServer performs the
following functions:
■ Executes SQL data definition language (DDL) in the specified Actuate
Caching service (ACS) database to create data structures for the cache.
■ Creates an ICD that contains information about the cache. This information
includes information such as the schema name and indexing constraints
also contains information object dependency information.

664 Administering Actuate iSer ver System

Enabling an information object cache
On Properties—Configure for an information object cache, an Encyclopedia
volume administrator can enable or disable the cache.
After you create the information cache, as described in “About information
object cache creation and configuration,” earlier in this chapter, you can enable
the information object cache.

The following table describes the information object configuration parameters

that appear on Properties—Configure for an information object cache.

Parameter Description
Cache State The cache is in one of the following states.
Enabled Information object uses
cached data.
Disabled Information object uses
data from the data source.
You can continue to run
and schedule jobs to
update the cache data.

Chapter 19, Administering jobs 665

 Parameter Description
Replicated Information object cache is
a copy of an information
object cache.
For information about
information object cache
replication, see
“Replicating an
information object cache,”
later in this chapter.
In Use If selected, indicates either the cache is enabled
and the last update of the cache was after the last
modified date of the information object, or the
cache is replicated.
Last Updated Most recent date and time at which Actuate
iServer updated the cache.

How to enable an information object cache

To enable an information object cache, select Enable cache on Properties—
Cache for the information object cache.

Replicating an information object cache

A copy of an information object cache can use the same cache data as the
original information object cache. The following restrictions apply to a
replicated cache:
■ You cannot use the replicated cache to update the cache data. Use the
original cache to update the cache data.
■ The Encyclopedia volume’s cache connection information must be identical
on the Encyclopedia volume that contains the original information object
cache and on the Encyclopedia volume that contains the copy.
■ Deleting a replicated cache does not delete the cache data in the original
cache database.
To replicate an information object cache, complete the following tasks:
■ Copy the information object and its information object cache to another
Encyclopedia volume.
■ Create a dependency between the copies of the information object and the
information object cache on the cache definition Properties—
Dependencies.

666 Administering Actuate iSer ver System

■ Set the cache’s Cache State to Replicated. For information about changing
the state of a cache, see “Enabling an information object cache,” earlier in
this chapter.

Deleting an information object cache

Deleting an information object cache deletes the cache data and database
schema from the Actuate Caching service (ACS) database (DBMS). If you
delete an information object that uses a cache, Actuate iServer displays a
warning to delete the cache first.

Working with a Record Matcher definition file

In an Encyclopedia volume, you create a Record Matcher definition file that an
information object and Record Matcher application uses to retrieve data from
data sources. The Record Matcher file associates an information object with a
Record Matcher application and specifies the user name and password to the
Record Matcher database.
The following sections describe how to work with a Record Matcher cache:
■ Creating a Record Matcher definition file
■ Viewing the configuration of a Record Matcher definition file
■ Running a Record Matcher definition job

Creating a Record Matcher definition file

The following illustration shows Record Matcher definitions on Files and
Folders.

On Files and Folders, choose Create Record Matcher to create a Record

Matcher cache.

Chapter 19, Administering jobs 667

 The Record Matcher file properties appears similar to the ones in the following
illustration.

The following table describes the parameters that appear on Create Record
Matcher—Configure when you create a new Record Matcher definition file:.

Parameter Description
Information Object / Specify the Record Matcher application’s
Data Source Map information object or data source map files.
Matcher Select the Record Matcher application.

Viewing the configuration of a Record Matcher definition

file
The following illustration shows the configuration for an existing Record
Matcher file.

668 Administering Actuate iSer ver System

On the record matcher definition file’s Properties—Configure, an
Encyclopedia volume administrator can view or modify the configuration of
an existing Record Matcher definition file.

Running a Record Matcher definition job

Actuate Caching service (ACS) supports running and scheduling a Record
Matcher definition as a job to update a Record Matcher cache. When you run a
Record Matcher job, Actuate iServer runs the Record Matcher application and
updates the Record Matcher database cache as a single operation. For
information about running or updating a Record Matcher file, see “Running or
updating an Actuate Caching service (ACS) cache,” later in this chapter.

Running or updating an Actuate Caching service

(ACS) cache
To update an information object cache or a Record Matcher cache, run or
schedule the cache as a job. Actuate iServer System runs an ACS cache update
as an asynchronous job. When Actuate iServer updates the cache data, it
updates all of the data from the data source, not just new or changed data. An
information object can access updated information object cache data when the
job completes. Until the job completes, the information object uses the existing
cache data. If Actuate iServer cannot access the data source, the job fails.
An Encyclopedia volume administrator chooses New Background Job from
the cache definition file’s drop-down menu to schedule an ACS cache job New
Background Job—Schedule appears similar to the following illustration:

Chapter 19, Administering jobs 669

 The following table describes the information object schedule parameters that
appear on New Background Job—Schedule for an ACS cache job.

Parameter Description
Job name Name of the job.
Time zone Time zone to use when running the job.
Run job Time at which Actuate iServer runs the job. The
following list describes the options.
Right now Run an immediate job.
Once Run the job once at the
specified time.
Recurring Run the job on the
specified schedule.
Advanced Specify a more complex
rule for running the job.

670 Administering Actuate iSer ver System

Parameter Description
Priority Priority, as a value between 1 and 1000, of the job.
Low Use value of 200.
Medium Use value of 500.
High Use value of 800.
Other Specify a value.
Resource group Resource group to which the job belongs.
Executable version Specify which cache to use.
Always use latest Use the latest version file.
version
Always use version Use the specified cache
n version, where n is the
version number.
Retry failed jobs
Use volume default Use the default job retry
settings for the
Encyclopedia volume.
Retry Retry the job on the
specified schedule.

Reviewing cache update information

Actuate iServer runs a cache update as an asynchronous job in the
Encyclopedia volume. You can view the information about the cache update
job in the same manner as you view information for a report generation job on
Jobs—Completed for the Encyclopedia volume.
On Properties—Configure for the information object cache, an Encyclopedia
volume administrator can view information about the last cache update.

Chapter 19, Administering jobs 671

 For more information about the parameters that appear on Properties—
Configure, see “Enabling an information object cache,” earlier in this chapter.

672 Administering Actuate iSer ver System

 Chapter

Archiving files and

Chapter20
20
backing up an
Encyclopedia volume
This chapter contains the following topics:
■ Archiving files and removing empty folders
■ Backing up the Encyclopedia volume

C hapter 20, Archiving files and backi ng up an Encycl opedia volume 673
Archiving files and removing empty folders
Using the Encyclopedia volume’s 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
Encyclopedia volume. Actuate iServer also supports removing empty folders.
■ Encyclopedia volume administrators can set autoarchive rules for the
entire Encyclopedia volume and on specific folders and files.
■ System administrators can specify the archive library used to archive files.
A single archive library is specified for the Encyclopedia volume.
■ Non-administrator users can set autoarchive rules on folders and files. A
user must have delete and write 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, “Working with items in an Encyclopedia volume,” in Using
Actuate Management Console.
The following autoarchive rules can be set on folders or files:
■ Do not automatically delete files or empty folders based on an autoarchive
rule.
■ Delete files or empty folders older than a specified age.
■ Delete files or empty folders after a specified date.
■ Archive files before deleting if an archive library is specified.
Use the Auto Archive tab to view autoarchive rules for files and folders:
■ The Auto Archive tab on a folder’s or file’s Properties page indicates the
autoarchive rule used.
■ Users can see autoarchive information by choosing View Policy on the
Auto Archive tab of the file’s or folder’s Properties page.
The following autoarchive rules can be set for jobs:
■ Do not automatically delete the output document based on an autoarchive
rule.
■ Delete the output document if it is older than a specified age.
■ Delete the output document after a specified date.
■ Archive the output document before deleting if an archive library is
specified.

674 Administering Actuate iSer ver System

 The following list describes the scope of autoarchive rules:
■ An autoarchive age or date rule set using a folder’s Properties applies to all
files and folders contained in subfolders within the starting folder. Only
empty folders are. An autoarchive rule on a file overrides any rule
inherited from a folder that contains the file.
■ Dependent files are also aged.
■ From a folder’s Properties, a user can specify a rule for a particular file type
such as .roi or .rox or empty folders.
■ From the Encyclopedia volume’s Properties, the Encyclopedia volume
administrator can specify a default rule for a particular file type such as .roi
or .rox or empty folders.
■ If a system administrator specifies an archive application for the
Encyclopedia 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.
■ If a user changes between a date-based rule and an age-based rule, the
Encyclopedia 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 Actuate iServer System does during the
autoarchive process:
■ When performing autoarchive, Actuate iServer System uses the most
specific autoarchive rule. Actuate iServer System uses autoarchive rules in
the following order:
■ The setting on the file or folder itself
■ The setting for the specific file type or folder from the file’s folder
setting
■ The folder’s default setting
■ The file type or folder setting from the containing folder
■ The containing folder’s default setting
■ The settings for the folders in the hierarchy.
■ The Encyclopedia volume’s settings
■ By default, Actuate iServer System performs aging once during the day.
The system administrator can specify when and how many times a day
aging is performed.
When Actuate iServer System performs auto-archiving, it starts from the
Encyclopedia volume’s root folder. For each file that meets the age criteria,

C hapter 20, Archiving files and backi ng up an Encycl opedia volume 675
 it deletes the file. If the Archive files before deletion option is enabled,
Actuate iServer System calls the archive application specified for the
Encyclopedia volume, and then deletes the file if the archive process is
successful. If the archive process is not successful, the file is not deleted.
For more information about autoarchiving, see “Understanding Actuate
iServer System online archive functionality” in Chapter 5, “Actuate iServer
System administration overview.”

Understanding archiving with autoarchive

As part of autoarchive, a system administrator can specify an archive
application that the system uses to archive files in the Encyclopedia volume
before they are deleted. The archive application is software that is the interface
between Actuate iServer System and an external archiving tool. Actuate
supports an archive application that uses the Actuate online archive SOAP-
based API or the Actuate autoarchive C-based API.
■ Actuate iServer ships with a configurable, Java-based Encyclopedia
volume autoarchive application that uses the SOAP-based autoarchive
API. Using the application requires an Actuate iServer System license with
the Archive Option enabled. For information about the application and
configuring Actuate iServer to use the application, see “Understanding
Actuate iServer System online archive functionality” in Chapter 5,
“Actuate iServer System administration overview.”
■ Actuate supports a C-based autoarchive API. On Windows systems, the C-
based archive library is a DLL. On UNIX systems, the C-based archive 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 application, see Chapter 12, “Aging
and archiving Encyclopedia volume items,” in Programming with Actuate
iServer APIs.
When Actuate iServer 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.

676 Administering Actuate iSer ver System

 Archive Actuate
software software

Archive
Actuate Encyclopedia
location
iServer volume
System

External
archive Archive
software application

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 Encyclopedia volume’s autoarchive

rules
Administrators can set the autoarchive policy for files in the Encyclopedia
volume. The Encyclopedia volume’s administrator can:
■ Set the autoarchive rule for all the files and empty folders in the
Encyclopedia volume.
■ Set an autoarchive rule for a specific file type or folder.
Administrators set the autoarchive rules for the Encyclopedia volume on the
Archiving and Purging tab of the Volume Properties page. Only an
administrator can set the Encyclopedia volume’s autoarchive rules.
The Encyclopedia volume’s autoarchive rules are overridden by setting an
autoarchive rule on a folder, file, or job. A user can set the autoarchive rule on
a file or folder if the user has read and write privileges on the file or folder.

Configuring autoarchiving and purging

In the Volume Administration console, Volume—Properties—Archiving and
Purging displays the default user notice purging settings.

C hapter 20, Archiving files and backi ng up an Encycl opedia volume 677
 The following table describes the user notice purging properties that appear
on Volume—Properties—Archiving and Purging.

Property Description
Purge success notices Enable deleting report generation notices for
after successful report generation.
Purge failure notices Enable deleting report generation notices for
after failed report generation.

If a volume administrator logs into an Encyclopedia volume using the Volume

Administration console, Users—Properties—Jobs displays the default user
notice purging settings.

678 Administering Actuate iSer ver System

 The notification options for a user apply to jobs that the Encyclopedia volume
administrator or other users submit and to which the user has access. For a
user’s notification, the user’s settings for deleting job notices from the user’s
personal channel override the Encyclopedia volume settings. If a user logs into
an Encyclopedia volume using the Volume Administration console, Personal
Settings—Jobs displays the user’s purging settings for notices.

C hapter 20, Archiving files and backi ng up an Encycl opedia volume 679
 How to set the Encyclopedia volume’s autoarchive rules
1 In the Volume Administration console, choose Volume from the side menu.
2 On Volume, choose Properties.
3 On Volume—Properties, choose Auto Archive.
4 On Volume—Properties—Auto Archive, specify the autoarchive policy for
the Encyclopedia volume.
You can specify a default autoarchive policy and an autoarchive policy for
each file type known to the Encyclopedia volume, including open server
file types. For information about open server file types, see “About
predefined open server file types” in Chapter 21, “Understanding Actuate

680 Administering Actuate iSer ver System

 iServer options.” If you do not specify an autoarchive policy for a file type,
the Encyclopedia volume uses the default autoarchive policy.

Choose OK.

How to start an aging cycle

1 In the Volume Administration console, choose Volume from the side menu.
2 On Volume, choose Auto Archive Now and confirm.

Scheduling an aging cycle

The Archive Schedule button is on Volume. Operators use this button to
schedule an aging cycle on a regular basis.

C hapter 20, Archiving files and backi ng up an Encycl opedia volume 681
 The Duration is not used. The Start date and the End date specify the duration
of the schedule.

Stopping an archive cycle

When Actuate iServer runs an archive cycle for an Encyclopedia volume, Stop
Auto Archive displays on Volume similar to the following illustration:

682 Administering Actuate iSer ver System

 Choose Stop Auto Archive to stop the currently running aging cycle.

Backing up the Encyclopedia volume

Use the Actuate online backup feature to create a backup of an Encyclopedia
volume without taking the volume offline. If you do not use the online backup
feature, you must take the volume offline to create a backup of the volume.
Using online backup, a user who is a member of the Operator role can place
the Encyclopedia volume into online backup mode or return it to normal
mode from online backup mode. Once the Encyclopedia volume is in online
backup mode, an Encyclopedia volume administrator can use a third-party
utility to back up a snapshot, which is a consistent image of the Encyclopedia
volume. As the backup is going on, users continue to access and view reports
from the Encyclopedia volume. Using the snapshot of the Encyclopedia
volume, Encyclopedia volume administrators can restore a consistent, usable
version of the Encyclopedia volume.
The Encyclopedia 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 Encyclopedia volume.
In online backup mode, users cannot create, update, or delete Encyclopedia
volume file types. All other operations are supported in online backup mode.
Placing the Encyclopedia volume in online backup mode ensures the snapshot
taken during the backup can be used to restore the Encyclopedia volume. To
restore a snapshot after retrieving the Encyclopedia volume from the backup
media, see “Restoring an Encyclopedia volume snapshot” in Chapter 9,
“Working with an Actuate iServer System volume.”

C hapter 20, Archiving files and backi ng up an Encycl opedia volume 683
 When backing up an Encyclopedia volume, do not back up the Encyclopedia
volume’s 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
“Modifying Actuate iServer parameter values for an Encyclopedia volume” in
Chapter 9, “Working with an Actuate iServer System volume.”
A user assigned to the Operator role can place the Encyclopedia volume in
online backup mode using either the Volume Administration console or
command line utilities that ship with Actuate iServer. For more information
about Actuate iServer utilities, see Chapter 13, “Working with Actuate iServer
utilities.”
If you restore the Encyclopedia volume using a snapshot, the Encyclopedia
volume restores to the state it was in before online backup mode was invoked.
Changes made to the Encyclopedia volume between the time you placed the
Encyclopedia volume in online backup mode and the time when you last
backed up the Encyclopedia 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 Encyclopedia volume’s current mode, Normal or

Online backup.
Choosing Switch to online backup mode enables operators to initiate the
online backup mode for the Encyclopedia volume.
Choosing Switch to normal mode changes the Encyclopedia volume’s mode of
operation to normal from online backup.

684 Administering Actuate iSer ver System

 Scheduling online backups
The Online Backup Schedule button is on the Volume page. Operators 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.

C hapter 20, Archiving files and backi ng up an Encycl opedia volume 685
686 Administering Actuate iSer ver System
 Chapter

Understanding Actuate
Chapter 21
21
iServer options
This chapter contains the following topics:
■ About Actuate open server
■ Administering Actuate Basic reports
■ Working with Actuate Query
■ Administering Actuate Analytics files
■ Administering spreadsheet reports
■ Administering Formula One reports

Chapter 21, Understanding Actuate iSer ver options 687

About Actuate open server
Using Actuate iServer without any options enabled, users can manage report
executable files and reports from third-party vendors, such as Crystal and
SQRIBE.
Actuate iServer 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 11, “Working with Actuate open server
technology,” in Programming with Actuate iServer APIs.
The Crystal report extensions defined by Actuate iServer are:
■ RPX, defined as Crystal executable file RPT
■ RPW, defined as Crystal web report file RPW
■ RPT, defined as Crystal report file RPT
The SQRIBE report extensions defined by Actuate iServer are:
■ SPF, defined as SQRIBE report file SPF
■ SQR, defined as an uncompiled SQRIBE report file SQR
■ SQT, defined as SQRIBE report file SQT
Encyclopedia volume administrators can:
■ Manage the various open server report generation tools that are used with
Actuate iServer System. These include such administration server-related
tasks as adding, removing, and editing properties and settings for these
tools.
■ Access external files using open server functionality. These might include
files that are external to the Encyclopedia volume but are accessible to
Actuate iServer System.
■ Handle the generation and printing of open server reports.
■ 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:
■ Import open server reports. For information about importing open server
reports, see Chapter 2, “Working with items in an Encyclopedia volume,”
in Using Actuate Management Console.

688 Administering Actuate iSer ver System

■ Schedule jobs to generate and print open server reports. For information
about scheduling jobs, see Chapter 3, “Running a report,” in Using Actuate
Management Console.
To use the Actuate open server functionality, you must install the following
software:
■ The Actuate iServer
■ Open server report files such as third-party report executable or report
document files
■ The appropriate open server driver
The open server driver must be installed on all reporting engines.
■ A third-party report generation engine and any required supporting
software, such as Crystal Decisions Crystal Reports or the SQRIBE SQR
Server
In the Encyclopedia volume, you must specify the parameters and settings for
the open server report executable and documents, including:
■ Location of the open server driver and the third-party report generation
engine
■ Parameters and settings required to generate the open server reports
■ 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 open server

After Actuate iServer System is configured to handle open server reports,
users can submit jobs to run or print open server reports from the
Encyclopedia volume. When the Encyclopedia 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 Actuate iServer System and the third-party report
generation tool to generate or print a report document, and signals to Actuate
iServer System that the report is complete. Actuate iServer System can import
the completed report document into the Encyclopedia volume.

Chapter 21, Understanding Actuate iSer ver options 689

 The following illustration shows the interaction of the components.
Non-Actuate Actuate
software software

Third-party
support Actuate Encyclopedia
software iServer volume
System

Third-party
report Open
engine server
driver

Open
server
report files

About predefined open server file types

Actuate iServer defines a set of open server file types:
■ HTML files
■ Crystal report files
■ SQR report files
■ Text files

Specifying open server file types

With Actuate iServer, Encyclopedia 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:
■ Location of the open server driver and report generation engine
■ Parameters and settings required for open server report generation
■ 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.

690 Administering Actuate iSer ver System

Understanding the File Types page
By default, the file types listed in the following table are defined in the
Encyclopedia volume. The volume administrator can delete file types and
create new file types.

File type Description

bas Actuate Basic source file
cb4 Actuate Analytics cube
cvw Actuate Analytics cube report
dcd Data connection definition
doi Actuate data object instance
dov Actuate data object value
dox Actuate data object executable
dp4 Actuate Analytics cube profile
htm HTML document
html HTML document
icd Information object cache definition
iob Information object
jod Formula One report design
joi Formula One report design
jox Formula One report executable
odp Actuate Analytics parameters for Analysis
Services
pdf Adobe PDF file
rod Actuate Basic report design
roi Actuate Basic report document
rol Actuate Basic design library
rop Actuate parameter template
ros Actuate search definition
rov Actuate report parameter values
row Actuate HTML report document
rox Actuate Basic report executable file
rpt Crystal report
rpw Crystal web report

Chapter 21, Understanding Actuate iSer ver options 691

 File type Description
rpx Crystal report executable file
rtf Rich text format
sma Data source map
spf SQRIBE report
sqt SQRIBE report executable file
sqw SQRIBE web report
txt Text file
vtf Actuate e.Spreadsheet template package
vtx Actuate e.Spreadsheet template
xls Microsoft Excel Spreadsheet
xrd Record matcher definition

For full descriptions of the file types listed here, see the individual file type
entries in Actuate 8 Glossary.

Defining 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. If the file type is executable or printable,
the system administrator must add the file type on the Factory Service tab of
the Servers Properties page for every Actuate iServer machine in the cluster.
For more information about the Factory Service tab, see “Setting server
parameter values for an Actuate iServer System resource group” in Chapter 7,
“Working with an Actuate iServer System server.”
How to define an open server file type
1 In the Volume Administration console, choose File Types from the side
menu.
2 On File Types, choose Create File Type.
3 On New File Type, type the following information:
■ File type
■ File extension
File extension is the file extension that the operating system uses.
■ Content Type
Content Type is the mime type for the file type.

692 Administering Actuate iSer ver System

 ■ Short description
■ Long description
4 In Category, choose Document or Executable.
If you choose Document:
■ 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.
■ To indicate that Actuate iServer System can print this file type, select
Printable.
If you choose Executable:
■ Select a default file type for output documents of the executable file.
The drop-down list displays all the non-native file types in the
Document category.
■ To indicate that Actuate iServer System can print the output documents
of this executable file type, select Can print output document.
■ To enable automatic parameter collection, select Enable automatic
parameter collection.
Select Enable automatic parameter collection if you want the driver to
extract report parameters from the executable file and display them to
the report user when he submits a job.
5 In Driver:
1 Type the name of the driver to use for this file type.
If you specify a relative path for an open server driver, the path is
relative to the driver directory for Actuate iServer.
2 If only a single instance of this driver can run at one time, type a name
for the mutual exclusion class that enforces this rule.
Actuate iServer System uses the mutual exclusion class to serialize open
server processes. Normally, Actuate iServer System schedules 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 run only one job at a
time.
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, Actuate iServer System runs only one
RPT-TYPE1 job at a time. If, however, users create both RPT-TYPE1 and
RPT-TYPE2 jobs, both jobs can run simultaneously.

Chapter 21, Understanding Actuate iSer ver options 693

 6 In Web Images:
1 Type the URL for a 16x16 pixel image that represents the file type.
2 Type the URL for a 32x32 pixel image that represents the file type.
Actuate Management Console displays the small icon. Actuate Active
Portal displays either the small icon or the large icon.
3 Choose Display Images to display the images on New File Type.

7 Choose OK.

How to modify an open server file type’s properties

You cannot modify the descriptions of 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 user’s locale. To revert to the default
description, enter an empty string in the description field. The default
descriptions are localized for the user’s locale.
1 In the Volume Administration console, choose File Types from the side
menu.
2 On File Types, hover the pointer 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 “Defining an open
server file type,” earlier in this chapter.

694 Administering Actuate iSer ver System

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:
■ Add, edit, and delete parameters.
■ Import parameters from an ROP or ROV file.
■ 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.
All parameters whose names start with "AC_" are reserved for Actuate’s use.
When you define file-type parameters or report-specific parameters do not use
names that start with "AC_".
1 Choose File Types from the side menu.
2 On File Types, hover the pointer over the icon to the left of the file type and
choose Parameters.
File Types—Parameters appears.

Chapter 21, Understanding Actuate iSer ver options 695

 The following table describes the tasks you can perform on File Types—
Parameters.

To perform this task Follow these steps

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.
Edit a parameter. 1 Choose Edit.
2 Complete the Edit Parameter dialog and
choose OK.
Delete a parameter. 1 Select a parameter to delete.
2 Choose Delete.
3 Confirm the deletion.
Import parameters 1 Choose Import from File.
from a file. 2 Enter the name of the ROP or ROV file and
choose Upload.
Export parameters to a 1 Choose Export to File.
file. 2 In File Download, choose Save this file to
disk and choose OK.
3 In Save As, enter the name of the file and
choose Save

Choose OK.

How to add a parameter

1 In Add Parameter:
■ Parameter name is the name of your parameter.
■ Type of data can be:
- Currency
- Date
- Double
- Integer
- String
- Boolean
■ Default value is the parameter’s value.

696 Administering Actuate iSer ver System

2 Select Required.

Choose OK.

How to upload images

You can upload images to represent a file type in Actuate’s desktop products
and in ReportCast.
1 In the Volume Administration console, choose File Types from the side
menu.
2 On File Types, hover the pointer over the icon to the left of the file type and
choose Upload Legacy Images.
3 On File Type—Upload Legacy Images:
1 Type the name of the Windows icon file that represents the file type in
Actuate’s desktop products.
The file must have the .ico file-name extension.
2 Type the name of the web image file (large web icon) that represents the
file type in ReportCast.
3 Type the name of the web image file (small web icon) that represents the
file type in ReportCast.

Choose OK.

Chapter 21, Understanding Actuate iSer ver options 697

 How to delete a file type
1 In the Volume Administration console, choose File Types from the side
menu.
2 On File Types, hover the pointer over the icon to the left of the file type and
choose Delete.
3 Confirm the deletion.

Using the web server file system for viewing open

server files
Some web server viewing technologies require direct access to a file on the
web server’s file system. When Actuate iServer System manages files, Actuate
iServer System stores the files in the Encyclopedia volume and not on the web
server.
To use the web server viewing technologies, Actuate iServer System must
copy the corresponding reports from the Encyclopedia volume to the web
server’s file system. If you enable Use web server file system for the open
server file type, and a user opens the file for viewing, Actuate iServer System
temporarily transfers the file to the web server associated with Actuate Active
Portal.
Using the System Administration console of Actuate Management Console, a
system administrator configures the following items:
■ The directory in which to store the files temporarily.
■ The length of time the files to keep the files in the directory.
■ The maximum size of the directory.
Copying the file to the web server directory means the Encyclopedia volume’s
security does not apply while the report is on the web server. There are two
security issues:
■ Anyone 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 to that machine reduces that
security risk.
■ 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, a system administrator
should disable directory listing. To further reduce the risk, Actuate iServer
System uses a unique file name for the temporary file. The unique file name
is unique for each viewing instance.

698 Administering Actuate iSer ver System

About open server for SQRIBE
The Actuate open server driver for SQRIBE reports handles only SQRIBE
compiled executable (.sqt) files, which are analogous to Actuate Basic report
object executable (.rox) files. Actuate’s 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:
■ Output file type SPF, a proprietary SQRIBE output format, similar to an
Actuate Basic report object instance, or .roi.
■ Output file type SQW, a web output format. This file type is not printable.
■ Output file type TXT, a plain text file.
To run a SQRIBE report, the database connection parameter is required. The
open server parameter is SQR_DB_CONNECT. It is a string parameter.

Setting the SQRIBE report printing parameter

Using the SQRIBE software, the open server driver cannot redirect output to
different printers. Actuate iServer System uses the default Encyclopedia
volume printer. To print a SQRIBE report (.spf) file, Actuate iServer System
assumes that the Sqrwp.exe program is at the default 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, you can set this parameter as a file
type parameter for the SPF file type definition.
You can print an SPF on a Windows system, but not on a UNIX system. You
cannot print a SQRIBE report executable (.sqt) file 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 the separation of the SQRIBE web
report into multiple, linked HTML files using the SQRIBE burst mode option.
The Actuate parameter for burst mode is a string parameter called
SQR_BURSTING. SQR_BURSTING accepts either P<n> or S<n>, where n is an
integer:
■ Pn bursts the report output with n pages in each HTML file.
■ Sn bursts the report output with n symbolic or logical group sections in
each HTML file.

Chapter 21, Understanding Actuate iSer ver options 699

 Working with report-level parameters
SQRIBE does not provide a way for other applications to read parameters from
a SQRIBE report executable (.sqt) file. A report developer must supply the
parameter information to the Encyclopedia volume administrator or the
person who uploads the SQRIBE report.
For SQRIBE reports, the order of parameters is important. Users who upload
reports must specify SQRIBE report parameter names in a special format. The
format for a SQRIBE report parameter is SQR<n>_<parameter_name>, where
■ n is an integer that specifies the order of the parameter from lowest to
highest in the parameter file.
■ parameter_name is the name of the parameter 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:
■ Crystal reports with an .rpt file extension
■ Crystal web reports with an .rpw file extension
The Actuate open server driver does not support Crystal parameters that use
ranges of values.

Using Crystal reports with an .rpt file extension

Crystal reports use the .rpt file extension for both report executable files and
report documents. When importing a Crystal RPT file, you specify whether the
RPT is one of the following Encyclopedia volume file types:
■ Crystal report executable with an .rpx file extension
From the Encyclopedia volume, users can run the RPX by submitting a job.
■ Crystal report with an .rpt file extension
From the Encyclopedia volume, users can open and print the RPT on a
Windows system.
The open server driver for Crystal can generate the following output file types
from a Crystal report executable file:
■ Crystal report with an .rpt file extension
■ Crystal web report with an .rpw file extension
■ Plain text file with a .txt file extension

700 Administering Actuate iSer ver System

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 that Actuate iServer System does not
run Crystal reports simultaneously, specify a mutual exclusion class for the
Crystal report executable open server file type. For more information about
mutual exclusion classes, see “Defining an open server file type,” earlier in this
chapter.
Crystal Reports 8 can run multiple Crystal reports simultaneously in Actuate
iServer system.

Setting parameters for Crystal reports executable files

When you specify parameters to use with a Crystal report executable (.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 a Crystal report, you can specify the following parameters that the
Actuate-supplied open server driver uses when it generates a Crystal report.
All parameters in the following table use string values.

Parameter Use
CRYSTAL_DB_DLL Location of the Crystal reports DLL
CRYSTAL_DB_NAME Database name
CRYSTAL_DB_PASSWORD Database user name’s password
CRYSTAL_DB_SERVER Database server machine name
CRYSTAL_DB_USER Database user name

Using Crystal web reports with an .rpw file extension

Crystal web report (.rpw) files are the RPW file type in an Actuate
Encyclopedia volume. A user can open and print an RPW. To print an RPW,
open the file in a web browser and choose File➛Print.

Printing a Crystal report

You can print a Crystal report (.rpt) file on a Windows system. You cannot
print an RPT on a UNIX system. You cannot print a Crystal report executable
(.rpx) file on either a UNIX or a Windows system.
Using the Crystal reports software, the open server driver uses the default
Encyclopedia volume printer. Use the AC_PRINTER_NAME parameter to
specify a different printer name. Enter the parameter as an open server file

Chapter 21, Understanding Actuate iSer ver options 701

 type system parameter. The printer must be available to the Encyclopedia
volume.
When printing a Crystal report file, the open server driver also uses the
number of copies parameter.

Administering Actuate Basic reports

The following sections discuss how to administer Actuate Basic reports in the
Encyclopedia volume environment using the Volume Administration console
of Actuate Management console:
■ Configuring report viewing
■ Setting web browser page caching options

Configuring report viewing

When you view an Actuate Basic report in a web browser in DHTML format,
Actuate iServer System uses the Actuate View process and Actuate Active
Portal. The View process converts pages and other Actuate Basic report
document data to DHTML. The Encyclopedia volume stores and manages
report documents as report object instance (.roi) files and uses the
Encyclopedia volume security functionality. Because the Encyclopedia volume
does not store the Actuate Basic reports as separate DHTML files, the
Encyclopedia volume does not retain separate files in DHTML and ROI
formats.
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 requiring any client software other than a standard web
browser that supports JavaScript and DHTML.

702 Administering Actuate iSer ver System

 The following illustration shows the interaction of the components when
using the View process to view Actuate Basic reports.
Internet

User Server software

Web Actuate
browser Web server Active
Portal

Encyclopedia Actuate View

volume iServer process
System

For information about using a DHTML report, see Working with Actuate Basic
Reports.

Setting web browser page caching options

On Volume—Properties—General in the Volume Administration console, an
administrator can enable or disable caching of DHTML reports by a web
browser. Selecting Allow browser-side caching of DHTML reports enables a
user’s browser to store Actuate Basic reports in DHTML format on the user’s
local machine. An administrator can specify the length of time before the
cached pages expire.

Working with Actuate Query

When you license and enable Actuate Query option for Actuate iServer
System, you can use information objects in an Actuate Encyclopedia volume to
retrieve and display data from data sources. Actuate information objects
contain database connection and data column information. Actuate Query
supports Actuate Basic information object (.dox) files, information object (.iob)
files and data source map (.sma) files.
To run an information object IOB that connects to more than one data source,
requires licensing the Actuate iServer Data Integration Option. For
information about licensing Actuate iServer options, see “Working with
Actuate iServer System licensing,” in Chapter 1, “Actuate iServer architecture
overview.”

Chapter 21, Understanding Actuate iSer ver options 703

 When you use Actuate Query with an information object IOB or data source
map SMA to retrieve data from data sources, Actuate iServer uses the
following files:
■ An Actuate ODA driver to retrieve data from data sources.
■ An information object template file, a DOX, to format data the information
object retrieves. For more information, see “About the Actuate Query
template file,” later in this chapter.

About the Actuate information object ODA driver

Actuate iServer uses the Actuate Integration service (AIS) ODA driver to
connect to data sources when you use an information object with Actuate
Query. Actuate iServer also uses the ODA driver when you run an Actuate
reports that use an information object as a data source.
When running an information object, an Actuate Factory process uses the
ODA driver to communicate with Actuate Integration Service.
An Actuate report developer uses the ODA driver to create an Actuate Basic
executable file, either a report object executable (.rox) file or a data object
executable (.dox) file, that uses an information object as a data source.

About the Actuate Query template file

Actuate iServer uses the Actuate query template data object executable (.dox)
file to format and display data retrieved using an information object with
Actuate Query. If you save the query data as a data object instance (.doi) file,
Actuate iServer creates a dependency between the DOI and the template file.
A developer can customize the query template. The DOX name is
AQTemplate<release ID>.dox, where <release ID> is the release identifier, for
example, 80A040701. Actuate ships the report object design (.rod) with
e.Report Designer Professional.
The template file is a special DOX used only with IOB and SMA files. You
cannot run the DOX file using Actuate e.Report Designer Professional. You
cannot run the DOX file from an Encyclopedia volume.

Actuate query template report design

The Actuate Query template report design AQTemplate.rod ships with
Actuate e.Report Designer Professional. An Actuate Basic report developer
can customize this report design to create an Actuate Query template data
object executable (.dox) file. For example, a developer can change the report
design’s Auto Contents properties and create a custom DOX template. The
template’s report design contains a connection and data source components
for use with information objects and the Actuate Integration service (AIS). Do

704 Administering Actuate iSer ver System

 not change the connection and data source classes in the AQTemplate.rod
report design.

Using a customized Actuate Query template

After you create a customized template data object executable (.dox) file, you
can upload the template to an Encyclopedia volume and configure Actuate
iServer to use the template using one of the following methods:
■ Use Management Console System Administration to specify the template
file in the Volume Actuate Query template file parameter. The parameter is
on Volume—Properties—Advanced—Actuate Query Generation for the
Encyclopedia volume. The DOX you specify becomes the default template
file for all new queries using an IOB or MAP. For information about the
parameter, see “Specifying the default Actuate Query template file,” in
Chapter 9, “Working with an Actuate iServer System volume.”
■ Set the dependency of an information object to the DOX. Actuate iServer
uses the DOX as the template file for data from that information object or
map file.
■ Use Actuate IDAPI to create an Actuate Query and specify the DOX as the
template file. You can specify the template file in a GetQuery( ),
CreateQuery( ), or ExecuteQuery( ). For more information about specifying
a template file, see Programming with Actuate iServer APIs.

Administering Actuate Analytics files

With an Actuate iServer license file that enables the Actuate Analytics Option,
Actuate iServer System supports running or scheduling an Actuate Analytics
cube profile to generate multidimensional data cubes for analysis. Actuate
iServer retrieves data, structures the data in an Actuate Analytics cube, and
adds the cube to the Encyclopedia volume.
You analyze the cube data using the Analytics Cube Viewer distributed as a
component of Actuate Active Portal and Actuate Management Console. When
you analyze a cube, you can aggregate or categorize data, summarize data,
and create graphs based on the data. You can save your analysis of the data as
a cube view in the Encyclopedia volume. You can store and manage multiple
views in an Encyclopedia volume. For information about using Actuate
Analytics, see Working with Cube Reports. For information about designing
Actuate Analytics cubes, see Designing Cubes using Actuate Analytics.
When you enable the Actuate Analytics Option for Actuate iServer System,
you can:
■ Run and schedule cube profiles in an Encyclopedia volume.

Chapter 21, Understanding Actuate iSer ver options 705

 ■ Generate a transient or persistent cube in an Encyclopedia volume.
■ Create a new cube view and save the view in an Encyclopedia volume.
If you do not enable the Actuate Analytics Option:
■ You can upload a cube profile, a cube, or a cube view to the Encyclopedia
volume.
■ You can view or access existing cubes in the Encyclopedia volume.
■ You cannot run or schedule cube generation. Scheduled jobs run and fail.

About Actuate Analytics file types

The following table describes the Encyclopedia volume file types for Actuate
Analytics cube profiles, cubes, views and Microsoft Analytic Service Access
parameters.

File type Description

DP4 Cube design profile is a binary file that contains
information about the data source connection,
the data to retrieve, and how to organize the data
as a multidimensional cube. Defined as an
executable file type.
CB4 Cube data file generated from profile. Defined as
a document file type.
CVW Cube view for a specific cube. Defined as a
document file type. The cube view is dependent
on the cube profile that generates the cube view.
ODP Microsoft Analytic Services OLAP cube access
parameters for a Microsoft SQL database. This
file contains parameters that identify and access
the cube that Microsoft Analytic Services stores
and manages. Defined as a document file type.

About Actuate Analytics data source support

Actuate iServer supports the following types of data source access:
■ ODBC data sources
■ JDBC data sources
■ Text files
■ XML files
■ Executable files

706 Administering Actuate iSer ver System

By default, Actuate iServer System looks for a text file or XML data source in
the Actuate iServer drivers directory. On a Windows system, the default
directory is:
C:\Program Files\Actuate8\Server\drivers
On a UNIX system, the drivers directory in the directory specified by the
AC_SERVER_HOME environment variable:
$AC_SERVER_HOME/drivers

Accessing a Microsoft Analysis Services data

cube
Actuate Analytics Option supports viewing and manipulating data from a
multidimensional data cube stored in an MS SQL database with Microsoft
Analytics Services. Access to data cubes stored in a Microsoft SQL database
with Microsoft Analytics Services is available only with Actuate iServer
running on Windows. You can view and manipulate cube data using Actuate
Cube Viewer. For information about Actuate Cube Viewer, see Working with
Cube Reports.
To access data from a multidimensional cube stored in an MS SQL database
using Actuate Cube Viewer, create an ODP parameter file in an Encyclopedia
volume. When you use Actuate Cube Viewer with the ODP parameter file,
Actuate iServer retrieves data from the cube specified in the ODP parameters.

Chapter 21, Understanding Actuate iSer ver options 707

 How to create an ODP parameter file
1 From the Encyclopedia volume File types, display the ODP file type
parameters on File Types—Parameters.

2 Choose Save File To Server.

Create Parameter Values File appears.

708 Administering Actuate iSer ver System

3 Type the parameters to access the multidimensional data cube stored in an
MS SQL database.
For information about the ODP parameters, see “About Microsoft Analytic
Services parameters,” later in this chapter.
4 Enter the Encyclopedia volume file name and folder of the ODP file.
5 Choose OK to save the file.

About Microsoft Analytic Services parameters

The following table lists the parameters for the Microsoft Analytic Services
(.odp) file type.

Display name Parameter name and description

Microsoft Analysis cubename
Service Cube Name Name of the cube in the Micorosoft SQL Server
that the Microsoft Analytic Service manages.
Value is required.
Data Source Name datasourcename
Micorosoft SQL Server database name. Value is
required.
Data Source Provider datasourceprovider
Name Name of the Micorosoft SQL Server database.
Default value is MSOLAP. Value is required.
Description description
Description of the cube. The text appears in the
About box of Actuate Cube Viewer. Value is
optional.
OLAP Server Name olapserver
Name of the OLAP server that connects to the
Micorosoft SQL Server database. Value is
required.
Username for ODBO userid
Data Source The user ID used to log in to the Microsoft SQL
Server. Value is optional.

Chapter 21, Understanding Actuate iSer ver options 709

Administering spreadsheet reports
With an Actuate iServer license file that enables the Actuate e.Spreadsheet
Option, Actuate iServer System supports running or scheduling spreadsheet
reports created using Actuate e.Spreadsheet Designer.
Using e.Spreadsheet Designer, a report developer creates a spreadsheet report
that performs the following functions:
■ Connects external data to a worksheet range
■ Manipulates and formats the data
■ Provides the data to users as an Excel spreadsheet
In e.Spreadsheet Designer, the developer:
■ Creates the workbook (.vts) file
■ Optionally, creates an XSL stylesheet to change the layout and style of the
incoming data
■ Provides a report parameters (.rop) file
Actuate iServer assigns the following file types to spreadsheet reports:
■ VTF to the e.Spreadsheet template (.vtf) files that comprise the report.
■ VTX to e.Spreadsheet template package (.vts) files.

Understanding how Actuate iServer System

handles spreadsheet files
The following conditions describe which e.Spreadsheet Designer files Actuate
iServer System adds to the Encyclopedia volume:
■ VTS, if the spreadsheet report uses no stylesheet or graphics and the file
name does not contain multibyte characters
■ 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.
■ VTF, if the spreadsheet report file name includes multibyte characters
The developer uses Jar to compress the workbook or the workbook with
associated stylesheet and graphics files into a VTF.

710 Administering Actuate iSer ver System

In all cases, you import the ROP file after you add the VTS or VTF. When you
use a VTF, the files that compose the VTF (.vts, .xsl, and graphics files) must be
in the same directory or in a subdirectory of the directory that contains the
VTF. Actuate iServer System must have access to the VTS or VTF and the ROP.
When you run the spreadsheet report on Actuate iServer with the Actuate
e.Spreadsheet Option enabled, Actuate iServer System performs the following
tasks in this order:
■ Reads in the workbook that the report developer created in e.Spreadsheet
Designer
■ Sets the parameters attached to the workbook
■ Executes the callback class, if one exists
■ Refreshes the data from data sources such as databases, XML files, and text
files in the workbook
■ Applies the stylesheet formatting
■ Saves the report as an Excel file, which is viewable from the Encyclopedia
volume

Setting parameters for spreadsheet reports

The e.Spreadsheet factory process generates spreadsheet reports. When you
administer spreadsheet reports in Actuate iServer System, you can encounter
run-time errors due to environment settings. If so, review the following table
to select a parameter that can correct the problem. To ensure that Actuate
iServer System always uses these settings, you must supply these parameters
with both e.Spreadsheet VTF and VTX file types. To duplicate these settings on

Chapter 21, Understanding Actuate iSer ver options 711

 another file type, 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.

To perform this task Use this parameter

Resolve the following AC_ JDRV_LAUNCH_WAIT
message: Unable to Supply an integer indicating the number of
connect to Java helper. seconds for the timeout.
If you receive this message or the system is too
busy, increase the launch time-out value beyond
the default setting of 10 seconds to provide more
time for the e.Spreadsheet factory to start.
Resolve the following AC_JRE_HOME
message: Couldn’t find Provide a string as the full path to set the JAVA
Java runtime Runtime (JRE) installation directory.
environment.
If you set the JRE_HOME environment variable
on UNIX, this parameter is optional.
If JRE_HOME appears in Actuate iServer System
registry keys on Windows, this parameter is
optional. Actuate iServer System uses the value
in the Windows Registry.
Tune the performance of AC_JVM_PARAMETERS
the Java Virtual Provide a string for parameters to pass to the
Machine. 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, see the following URL:
http://java.sun.com/j2se/1.3/docs
/tooldocs/win32/java.html#options

In the Sun Windows JVM, you can set the

maximum heap size using the -Xmx parameter
and the minimum heap size using -Xms. Adapt
the JVM options as your system requires. For
example, you can change the maximum heap size
to ensure that the JVM has enough memory to
run the largest report.
Ensure that the Actuate iServer machine has
enough free memory to accommodate the
maximum heap size. Actuate recommends not
setting it to more than 256MB.

712 Administering Actuate iSer ver System

To perform this task Use this parameter
Resolve a message AC_JDRV_CLASSPATH
similar to: Driver or file Supply a string for the location of the spreadsheet
not found. population class, database drivers, or alternate
XML or XSL processors. Separate multiple entries
in Windows using a semicolon (;) and in UNIX
using a colon (:).
e.Spreadsheet uses an internal class loader, not
the system CLASSPATH.
Decrease the system AC_ JDRV _TIMEOUT
resources used. Provide an integer that indicates the number of
seconds to wait after the last completed report
request runs before timing out.
Use this parameter to consume fewer resources.
Using this parameter may result in a longer
initial report generation time.
Changes to this parameter take effect only when
you restart Actuate iServer System.
The default value (-1) keeps the e.Spreadsheet
factory up and does not exit. If you use a value of
0, the e.Spreadsheet factory process exits
immediately after it completes each report
request.
Set the debugging AC_JDRV_LOG_LEVEL
options. You can change the debugging level by
supplying an integer for the logging level:
■ 1 logs errors.
■ 2 logs warnings.
■ 3 logs status information (the default setting).
■ 4 logs debug messages.
Control spreadsheet AC_SS_DPI
report DPI. Add AC_SS_DPI as a file type parameter to
specify the DPI for all spreadsheet reports. To
specify the DPI for a report, add AC_SS_DPI as a
report parameter.
Actuate e.Spreadsheet Designer creates the
parameter AC_SS_DESIGNDPI as a hidden
report parameter when deploying a spreadsheet
report to an Encyclopedia volume.
AC_SS_DESGINDPI specifies report design DPI
if you do not specify AC_SS_DPI.

Chapter 21, Understanding Actuate iSer ver options 713

 To perform this task Use this parameter
Control caching of AC_SS_BOOKCACHESIZE
spreadsheet books. Specify the number of spreadsheet books cached.
The default is 8 books. A a value of 0 disables
caching. For improved performance, Actuate
iServer stores generated spreadsheet reports in a
cache, to access and run again if needed.
Control creation of a AC_RUNNING_HEADLESS
graphics port.
When running a spreadsheet report Actuate
iServer creates a graphics port. Use
AC_RUNNING_HEADLESS to control the
creation of the graphics port.
The value is either yes or no. The default is no,
create a graphics port. Set this value to yes to
disable creation of a graphics port.
On systems without a graphics card or graphics
port set this value to yes.
For better performance, set this value to yes if the
spreadsheet report does not use the adjust
column width property on any of the report
ranges.

If a port conflict exists, and another process listens on the port to which the
e.Spreadsheet factory process is assigned, unpredictable results can occur,
such as error messages 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 Option

1 From the side menu of the System Administration console, choose Servers.
2 On Servers, select the server with the port conflict.
3 On Servers—Properties, choose Advanced.
Servers—Properties—Advanced appears.

714 Administering Actuate iSer ver System

 4 In Properties settings, choose Factory Service➛ Process
Communication➛eSpreadSheet.
Actuate iServer displays a dialog box with the e.SpreadSheet server port
number parameter.
5 Change the value to the correct port number. Choose OK.
This change takes effect when you restart the server.
6 On Servers—Properties, choose OK.

Administering Formula One reports

With an Actuate iServer license file that enables the e.Report Option, users can
import a Formula One report object design file (.jod) file to the Encyclopedia
volume and run the report.
Actuate iServer System generates the following types of files from a Formula
One report:
■ ROW
ROW is an Actuate HTML report document. ROW is the default format.

Chapter 21, Understanding Actuate iSer ver options 715

 ■ HTML and DHTML
■ JOI
■ PDF
■ Text in character-separated values (.csv) format
■ XML
■ XLS
For Formula One reports that require access to external data, you must
configure the proper environment. For example, if the Formula One report
accesses data using Java database connectivity (JDBC), you must configure the
environment on Actuate iServer System.
The following table lists the supported data sources that you can embed in a
Formula One report.

Data source Connectivity information required

Text 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
Application data source Connector class and application data classes in
CLASSPATH environment variable
XML Path to XML data specified in the report or
configured as report parameter

About Formula One report data source connection

requirements
A report developer creates Formula One reports (.jod) files using Formula One
e.Report Designer. If the report contains a data field for which data must be
extracted from a data source, the report developer must embed the type and
connectivity information for the data source 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. For information about adding data source information
to a Formula One report, see “How to embed data source information in a
Formula One report,” later in this chapter.
Actuate iServer System does not support Formula One reports that extract
data from a Java application using the application data source. One alternative

716 Administering Actuate iSer ver System

for a report with this type of connection is to transform the report design to
use an EJB data source with the connectivity information, the JNDI name,
embedded in the report.
If the Formula One report contains only static labels or forms that do not
extract data from any data source, the report does not require embedded data
source type and connectivity information.
For a Formula One report to connect to an EJB data source, list client stubs and
any Application Server EJB Connectivity (JNDI) client classes in the report’s
DCP_OTHER_LIBS parameter if the library is not in the CLASSPATH. For
information about Formula One e.Report parameters, see “Using parameters
with Formula One reports,” later in this chapter.

How to embed data source information in a Formula One report

To embed the data source information in a report, the report developer must
complete the following tasks in Formula One e.Report Designer:
1 Choose Tools➛Designer Options.
2 In Designer Options, choose Template.
3 Select Save Datasource In Template.
4 Choose OK.
5 Choose File➛Save.
To confirm that data source information is in a report, open the report in any
text editor and ensure that an EmbeddedDataSource_* block exists.

Using parameters with Formula One reports

For a Formula One report, use the parameters that appear in the following
table to control the JVM environment and output format. The driver control
parameters specify the JVM environment settings.

Name Data type Values

DCP_BUILD String Location of tools.jar that the
_CLASSPATH Formula One engine uses to
compile code in a Formula
One report.
DCP_DEBUG_LEVEL Integer 0 for no debugging
information, 1 for summary,
and 2 for detailed
information. 0 is the default.

Chapter 21, Understanding Actuate iSer ver options 717

 Name Data type Values
DCP_ESPRESSO_LIB String Location of ACJRuntime.jar
that runs a Formula One
engine and generates the
output. If left blank, the
Actuate iServer System
driver determines the
location.
DCP_JRE_HOME String Location of the JRE used
with the ACJRuntime.jar. If
left blank, the Actuate
iServer System driver
determines the location
using PATH environment
variable.
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.

The following output property parameters specify output settings.

Name Data Type Values

OPP_DHTML_BROWSER String IE or NS. Specifies the
browser-specific output. IE
is the default.

718 Administering Actuate iSer ver System

Name Data Type Values
OPP_HTML_OUTPUT String DHTML or HTML. This
_TYPE property specifies the type
of HTML output generated
if the output file name’s
extension is .htm or .html.
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.
NO is the default.

When running a .jod file with report-specific parameters from Actuate iServer
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 report’s parameters in the Encyclopedia volume.
Actuate iServer supports the following parameters when running a .joi file:
■ DCP_DEBUG_LEVEL
■ DCP_ESPRESSO_LIB
■ DCP_JRE_HOME
■ OPP_DHTML_BROWSER
■ OPP_HTML_OUTPUT_TYPE
■ OPP_TOC_ENABLED

Locating fonts with ACJFontLocator.properties

To generate Formula One e.Reports with the correct fonts, you may have to
modify ACJFontLocator.properties. ACJFontLocator.properties is located in
%AC_SERVER_HOME%\servletcontainer\f1ereosi\WEB-INF\lib on
Windows platforms and $AC_SERVER_HOME/servletcontainer/f1ereosi/
WEB-INF/lib on UNIX platforms. ACJFontLocator.properties lists the
directories containing the TrueType Font files that describe the font metrics of
fonts used in a report. For more information about mapping your fonts, see
Chapter 3, “Working with controls,” in Designing Formula One Reports.

Chapter 21, Understanding Actuate iSer ver options 719

 Specifying a port number to run a Formula One
e.Report
To generate a Formula One e.Report, Actuate iServer uses the Actuate iServer
application container on the Actuate iServer machine. To communicate with
the application container, Actuate iServer requires the port number for the
application container. The Actuate iServer installation routine configures the
port number that Actuate iServer uses. If you change the port number of the
Actuate iServer application container, you must also update the port number
for the JOI, JOX, and JOD file types.
Update the port number information for the JOI, JOX, and JOD file types on
Servers—Properties—Advanced—NetOSI file types in the System
Administration console of Actuate Management Console. For information
about the NetOSI file type properties, see “Adding a NetOSI file type,” in
“Working with an Actuate iServer System server.”

720 Administering Actuate iSer ver System

 Index
Symbols
* wildcard 624
Numerics
32-bit drivers 411
A open security and 31, 104
About page 151
AC_ JDRV _LAUNCH_WAIT parameter 712
AC_ JDRV _LOG_LEVEL parameter 713
AC_ JDRV _TIMEOUT parameter 713
AC_ JVM_PARAMETERS parameter 712
AC_DBC_ENCODING variable 413
AC_DBMS_INFORMIX_MAXVARLEN
variable 408, 549
AC_DBMS_ODBC_MAXVARLEN
variable 413, 549
AC_DBMS_ORACLE_MAXVARLEN
variable 422, 549
AC_DBMS_PROGRESS_MAXVARLEN
variable 549
AC_JAVA_HOME variable 48
AC_JDRV _CLASSPATH parameter 713
AC_JRE_HOME parameter 48, 712
AC_JRE_HOME variable 48
AC_JVM_HOME parameter 48
AC_JVM_HOME variable 48
AC_PMD_WINDOWS_CPUS variable 73
AC_PRINTER_NAME parameter 54, 701
AC_RCBF_WRITE_BUFFER_SIZE
variable 90
AC_ROOT_FOLDER variable 71, 72
AC_RUNNING_HEADLESS parameter 714
AC_SERVER_HOME variable 42, 43, 549
AC_SERVER_UNIX_FD_MAX variable 35
AC_SS_BOOKCACHESIZE parameter 714
AC_SS_DESIGNDPI parameter 713
AC_SS_DPI parameter 713
AC_SS_POPULATION_CLASS parameter 50
AC_THREAD_STACK_SIZE variable 35
acacfconvert utility 438–439
access control lists (ACLs)
building applications for 105
generating 615
getting 361
retrieving 591
setting length 361
storing 620
access permissions. See privileges
access restrictions
page-level security and 105
access types 590
access types (privileges) 590
accessing
Actuate-specific Java files 47
administration information 22
data sources 31
Encyclopedia volumes 20
example archive driver 71
external applications xxiii
external security sources 31, 104, 107, 618
iServer clients 28
Java objects xxvii, 51
locale maps 54
multi-language databases 400
online documentation xxxiii
remote servers 28
reports 628
security information 590
system resources 32–34, 175
third-party reports 4
accounts
caution for automatic startup and user 32
changing iServer 29
creating dedicated 28, 29
deleting user 600, 605
external security sources and 31
external user authentication and 618
ODBC data sources and 412
registering e-mail 56, 57, 58
setting up database 407, 410, 420, 433
setting up e-mail 29, 57, 59
setting up iServer 28–31
setting up non-administrator 30, 31
setting up Process Manager 28
setting up user 575
Index 721
accrpdrv.exe 54 AcProgressSQL92Connection class 422, 424
AcExport log file 440 ACS. See Caching service
acexport utility ACS database 658, 661
command-line options for 442 acserverlicense.xml 13
file dependencies 441 acsqrdrv.exe 53
getting information about 458 Activate parameter 544
restrictions for 123 active jobs 146, 648
running 440–445 active partitions 362
acextern utility Active Portal xxiv
changing security type and 107 accessing reports from 628
command-line options for 446 changing default ports and 36
converting security information 124, 125 cluster configurations and 14
running 446–447 configuring View process for 45
updating administration information 124 enabling e-mail notifications from 343, 350
AcGraph class 68 integrating with open security
AcImport log file 448 applications 111
acimport utility load-balancing routers and 19
command-line options for 450 predefined web pages for 628
creating volumes with 449 running View process and 97
getting information about 458 sending reports to 60
maintaining file dependencies and 449 streaming zipped files to 81
resolving conflicts 449 viewing job information from 657
restrictions for 123 Active Portal Administrator role 587
running 447–454 Active Portal Advanced role 587
ACINFX240.dll 407 Active Portal Intermediate role 587
acintern utility Active Portal option 702
changing security type and 107 Active Portal roles 587
command-line options for 454 Active Portal Security Extension (APSE) 622
converting security information 125, 126 active state 330
running 454–456 ActivePortalForDotNETURLPrefix
updating administration information 124 parameter 499
ACJFontLocator.properties file 51, 719 ActivePortalURLPrefix parameter 499
ACJRuntime.jar 718 ActiveX controls xxiv
ACLs. See access control lists activity logs 217
ACLTimeout parameter 297, 516 actoc utility 457
acmanagemc.jar 40 Actuate Active Portal
acmode utility online help for xxxiii
command-line options for 456 Actuate Basic
running 456–457 accessing Java objects from 51
acnotification.xml 60 Actuate Caching Service. See Caching service
AcOracleConnection class 417, 418 Actuate home page xxviii
acorcl81 library 418 Actuate Integration Service. See Integration
acpmdconfig.xml 36 service
acprg9.dll 424 Actuate product suite xix, xxiii, xxiv
AcPrg9.sl 426 See also specific product
AcPrg9.so 426 Actuate product updates xxviii
AcProgressConnection class 425 Actuate Query Generation page 370

722 Administering Actuate iSer ver System

Actuate technology xx
ActuServer account 57
acupgrade utility
command-line options for 461
running 458–463
acverify utility
command-line options for 464
moving Encyclopedia and 87
performance problems and 87
running 463–466
ad hoc queries xxvii
Add Partition page 332
Add Printer page 395, 396
Add resource group option 386
Add Server option 166
add-in function classes 49
adding
anonymous users 575
archive drivers 71, 72
clusters 19
connection components 400
e-mail accounts 57, 59
e-mail message templates 61–65
Encyclopedia volumes 20, 339–345
Factory processes 92
failover services 20
folders 227
hyperlinks 64, 343, 350, 351
memory 95
multiple cluster nodes 16
notification groups 225, 602, 638, 639
partitions 21, 331–332
printers 395, 396
resource groups 384–386
resources 91, 92
roles 224
security roles 584, 605
servers 92, 164
SMTP servers 240, 241
URLs 60
users 591, 639, 642
virtual IP addresses 14
Additional Volume Option (licensing) 10, 11
–admin option (actoc) 458
ADMIN_ROLE_NAME parameter 126
–admindata option 123
AdminEmail parameter 253, 472
administration information
converting security 125
Encyclopedia volumes and 22, 23, 82
managing 96
mapping to LDAP information 109, 110–
112
updating 107, 124
administrative databases
exporting 442, 458
importing 450
administrative events 222
Administrative fail over option 357
administrative tasks
changing partition configurations 21
controlling jobs 652
creating clusters 161
maintaining backups 354, 683
maintaining report archives 554, 674, 676
managing configurations 133
managing Encyclopedia 20, 23, 557
managing information object cache 662
managing iServer nodes 22–23
managing iServer System 4, 132, 133
managing printers 394
monitoring iServer System 139
monitoring partitions 330
overview 22–23
reconfiguring clusters 16
restoring Encyclopedia 456
restructuring Encyclopedia 83
running stand-alone servers 9, 22
setting up e-mail accounts 55–60
setting up printers 647–648
upgrading Encyclopedia volumes 458
working with Formula One reports 716
administrator (defined) 586
Administrator role 112, 567, 586, 621
administrator user role 586
administrators
externalizing user information for 22
receiving CPU licensing messages 78
receiving shutdown messages 77
AdminLogEnabled parameter 479
AdminLogLevel parameter 479
–adminRole option (acextern) 446
AdminRole parameter 112, 126
–adminUser option (acextern) 446
Index 723
–adminUser option (acintern) 454
advanced parameter categories 287
Advanced properties page 156
Advanced Server Properties page 283, 287
AFM files 67, 467
age-based rules 675
aggregate reports 91
aging cycle 681
See also archiving
aging interval 675
See also archiving
AIS. See Integration service
AIS events 229
AIX servers
accessing shared libraries for 34
configuring JVM for 52
configuring open server drivers 52
DB2 clients and 404
Formula One reports and 50
increasing stack size for 35
Informix clients and 405, 407
installing/uninstalling fonts 466
ODBC connections and 412
printing from 33
Progress9 clients and 426, 427
Red Brick databases and 416
running iServer on 33
setting language variable for 69
setting up environments 402
Sybase databases and 431
–all option (acexport) 443
–all option (acimport) 451
–all option (actoc) 458
All role 112, 587, 620
ALL_ROLE_NAME parameter 126
allocating memory 94–95
allocating resources 91–92, 99
–allRole option (acextern) 446
AllRole parameter 112, 126
analysis tools xxiv
Analytics Cube Designer xxiii
Analytics Cube Viewer xxiii
Analytics Option xxv, 11, 416
analyzing data xxvi
anonymous users 575, 621
ANSI drivers 413
ANSI to OEM Conversion option 409
724 Administering Actuate iSer ver System
AppContainerPort parameter 261, 491
AppContext parameter 315, 542
application programming interfaces
(APIs) xxv
backward compatibility for 7
dispatching requests from 5
application servers
See also servers
configuring as cluster 14
configuring as stand-alone 13
configuring Formula One reports for 717
e.reporting solutions for xxii
setting iServer ports for 35, 134
application service providers 21
application-level partitioning 21
applications
allocating memory for 94
building custom login 104
configuring Encyclopedia volumes for 21
controlling stack size for 35
customizing xxiv
deploying from xxvii
designing 21
developing 575
dispatching requests for 5
e.reporting solutions for xx, xxii
extracting data from Java 716
generating XML data for 97, 99
installing sample RSSE 106
managing iServer from 22, 23
messaging protocol for 6
running open security sample 105
Apply Filter option 565
Archive before deletion option 675
archive driver xxv
creating 71–72
displaying current settings for 342, 350
specifying 342, 350
archive library 675, 676
Archive library name parameter 342, 350
Archive Option (licensing) 10
Archive Schedule button 681
archive.dll 71
Archive.log file 72
ArchiveServiceCmd parameter 495
archiving
administrative tasks for 554
archiving (continued)
open server reports 674
preserving file dependencies 182
report files 71, 179, 674–683
retaining file attributes and 181
setting rules for 674, 675, 677, 680
viewing information for 674
Archiving and Purging page 365, 677
archiving application 179, 182, 183
archiving libraries 342, 350
archiving software 71
archiving tools xxv
arrays 424
ASCII data sources 716
ASCII files 716
assigning privileges 97, 111, 632
See also privileges
assigning roles 620
See also roles
Asynchronous Job Retries page 289
asynchronous jobs 8
asynchronous resource groups 653
attachments 593
See also e-mail
AttachReportInEmailAttr parameter 116, 127
AttachReportInEmailDefault parameter 117,
127
attributes
See also properties
adding to e-mail templates 62
defining LDAP 110, 111
information logs 233
retaining file 181
setting values of 46
specifying error log 233
specifying system usage information 217
system usage information 217
authentication
external users 616, 618, 622
open security functionality for 104
third-party security systems and 590
authorization 111, 617
Auto Archive page 680
autoarchive application 179, 183
autoarchive rules 674, 675, 677, 680
autoarchiving. See archiving
automatic startup 39
caution for network printers and 32
B
background jobs 5
backing up Encyclopedia
administrative tasks for 554
assigning nodes for 278
assigning servers for 354
command-line utility for 456
move operations and 87
online feature for 683–685
backup cluster master 19, 175, 210
Backup Master Assignment page 210
backup mode 456
backup nodes 19, 169, 170, 210
backup servers 175, 278, 354–356
backup utility 456
backward compatibility 7
banner 557
Base socket number for reply setting 325
Base socket number for RPC setting 324
BaseSocketNumForReply parameter 491
BaseSocketNumForRPC parameter 492
batched printing requests 5
benchmarks 80, 94
–bf option (acexport) 443
biometric data 617
bitmaps 632
body element 62
BookModelCallback interface 49
bound processor checks 76
Branding page 300
browsers. See web browsers
browser-side caching 80
buffer pool
resizing 276
resource requirements for 94
setting 88, 277
Buffer pool size setting 277, 279, 355
BufferPoolSize parameter 500
buffers 424
bundling report files 82
bursting 699
C
–C option (acmode) 456
Index 725
C locales 44, 54
C shell scripts (UNIX) 42, 548
cache
ACS database for 658
automatically installing 661
configuring Record Matcher 202
controlling external security 108
creating information object 663, 664
deleting information object 667
displaying information about 671
enabling for web browsers 80, 703
enabling/disabling information
object 665, 666
increasing size 266, 269
invalidating view session 101
replicating information object 666
setting for PDF files 81
setting for View processes 99, 100, 101
setting open security 122
setting parameters for 295, 297
synchronizing 101
updating information object 669
updating Record Matcher 669
Cache Connection page 659
caching
DHTML report pages 80, 703
external security information 107
information objects 193, 658, 662
report files 100, 101
temporary reports 80, 269
caching options (web pages) 703
Caching service
configuring 658
described 6
displaying information for 671
overview 193, 658
running Record Matcher jobs 669
scheduling jobs for 669
setting parameters for 271, 313, 660, 670
setting up external database for 661
Caching Service Load Information property
group 271
Caching Service page 271
Caching Service Port Information property
group 271
calculations
caution for running time-based 42
726 Administering Actuate iSer ver System
CPU binding and 73
CPU resources and 91
calendar. See dates
callback classes 49
cancelling jobs 652
capacity planning 42, 87
cascading style sheets 298
case sensitivity 592
C-based RSSE application 104, 109
CDATA sections (e-mail templates) 62, 64
CenturyBreak parameter 55, 322, 488
changing
channel subscriptions 604
cluster configurations 16
cluster master 325–326
CPU binding 76
database configurations 38
default locales 44, 145
default ports 36, 135
diagnostic logging 285, 286
Encyclopedia volume owner 351
font executable files 70
home folder location 580
iServer accounts 29
licensing information 246, 247
licensing options 247
notification groups 601
passwords 592
printers 648
privilege templates 223, 588, 596, 602
property values 566
role properties 607, 609, 610
security roles 600
security type 107
SMTP configurations 239
start-up parameters 177
system properties 160
system time 42
time zones 145
transaction log partitions 89
user attributes 223
user names 223
user properties 598, 600
channel attribute 112
channel membership information 110
Channel Privileges page 606
Channel Subscriptions command 598
channels
administrative tasks for 554
attaching images to 632
changing privileges for 226
changing properties for 226
changing subscriptions 604
creating 226, 631–633
deleting 226
disabling notifications for 45, 46
displaying contents 599, 629
exporting information for 441
external authentication and 622
importing 450
naming 631
open security mappings for 112
overview 628
scheduling jobs for 637–638
setting page caching options 703
specifying LDAP server 114, 115
subscribing to 598, 628
updating 226
viewing available 629
Channels page 629
ChannelSubscriptionListAttr parameter 114,
126
ChannelSubscriptionListDefault
parameter 115, 126
char data types 411, 418
character lengths 411, 418
character sets 54, 400, 411, 413
character strings. See strings
Chart JVM parameter string setting 319
Chart Server 319
Chart Server cache 81
Chart server IP address setting 319
Chart server max heap size setting 320
Chart server port number setting 320
ChartJVMParameterString parameter 487
charts
creating 319
printing 67
rendering for PDF reports 81
setting fonts for 67–69
setting parameters for 304, 307
ChartServerIPAddress parameter 487
ChartServerMaxHeapSize parameter 487
ChartServerPort parameter 488
–check option (acverify) 87, 464
checking disk space 41, 87
checking free disk space 498
Child Roles page 606
CJK languages 67, 68
classes
enabling spreadsheet reporting and 49
CLASSPATH variable 50, 549
Clear Filter option 566
client classes 717
client configuration program 432
Client Configuration Utility 409
Client Integration Technology xxiv
Client Network Utility 409
client stubs 717
CLIENT_LOCALE variable 406
clients
accessing iServer 28
bundling reports for 82
determining locales for 404
dispatching requests for 5
Informix databases and 405
MS/SQL support for 409
ODBC data sources and 412, 414
open server reports and 53
Oracle databases and 417, 418, 419
Progress databases and 425
client-side caching 80
clock 42
Clone command 599
cloning
notification groups 641
roles 608
users 599
cluster configuration option 9
cluster master
allocating resources for 92
backup nodes for 169, 170, 210
changing 325–326
configuring backup 210
controlling configurations from 9
creating 160
enabling services for 9, 16, 19
failing 19
managing cluster configurations from 19
restarting iServer and 175
specifying 141
Index 727
cluster master (continued)
starting 155
cluster master failover 209
cluster nodes
accessing Encyclopedia volumes and 89
adding iServer machines to 92
administrative support for 8
configuring iServer for 6
configuring resource groups for 383
creating multiple 16
deleting 23, 171
displaying resource groups for 273
enabling iServer services for 16, 19, 237
failing 20, 174
installing iServer on multiple 9
making partitions available to 332, 333
message routing for 6, 23
overview 164
reordering display settings for 146
reporting status of 6
restarting 55, 169, 174
running on UNIX systems 31
setting up 138
specifying as backup volume 278
starting 16
taking offline 171
viewing primary Encyclopedia volume
for 276
ClusterName attribute 217, 233
clusters xxiv
accessing locale maps 54
adding Factory processes for 92
adding printers 394
adding servers 92, 164
administrative tasks for 132, 133
communications protocol for 19
configuring 14, 16, 17–19, 138
CPU binding and 73, 76
creating 9, 19, 160–162
customizing resource groups and 96
designating partition space for 280
dispatching requests to 5
displaying system options for 145, 147,
149, 151
enabling services for 16
failing 172
file system I/O and 88
728 Administering Actuate iSer ver System
getting system information for 208, 258
load balancing service for 6
managing 19, 22, 175
multiprocessor support for 7
multi-server configurations and 9
networking requirements for 175
overview 21
removing nodes from 23, 171
resetting iServer ports for 134
restarting nodes 55, 174
routing requests to 14
running servers from 168–171, 176
setting iServer ports for 35
setting up e-mail notifications for 56, 237
setting up open server drivers for 52
setting up UNIX accounts for 31
specifying Factory processes for 45
stand-alone configurations and 9
starting nodes in 16
system configurations and 6
cn attribute 111
code pages
database encoding and 400, 409, 423, 426
detecting 413
specifying default 245
column length
Informix data sources and 408
ODBC data sources and 413
Oracle data sources and 422
Sybase data sources and 431
command-line arguments
getting current server version 44
setting acacfconvert 438
setting acexport 442
setting acextern 446
setting acimport 450
setting acintern 454
setting acmode 456
setting actoc 458
setting acupgrade 461
setting acverify 464
setting fontutils 467
setting UNIX environments 403
testing connections 405, 410, 421, 433
testing UNIX e-mail notifications 59
Commandline parameter 315, 541
command-line utilities
overview 437
running acacfconvert 438–439
running acexport 440–445
running acextern 446–447
running acimport 447–454
running acintern 454–456
running acmode 456–457
running actoc 457
running acupgrade 458–463
running acverify 463–466
comma-separated text files 716
comments xxxvi
communications 134
compiling 717
completed jobs
creating notification groups for 638
customizing messages for 60
disabling notifications for 46
displaying 648
importing 450
setting URL prefix for 60
Completed page 46, 652
completion notices
adding to personal channels 593
creating persistent 86
customizing 60
deleting 118
determining recipient of 86
disabling 46
sending over LDAP servers 117, 119, 120
Compress PDF Content parameter 81
CompressDHTML Content parameter 82
compressing
DHTML reports 81
exported volumes 442
PDF files 81
compression levels 82
concurrent I/O operations 90
concurrent requests 6, 91, 100
–config option (acafcconvert) 438
–config option (acexport) 443
–config option (acextern) 446
–config option (acimport) 451
–config option (acupgrade) 461
–config option (acverify) 464
confighome.lnk file 138
ConfigHomePartition parameter 472
Configuration File For Connections
setting 37
configuration files
See also configurations
adding restart intervals to 40, 41
creating 160
default location for 137
overview 137
parameters missing in 110
read failures and 173
setting connections in 37
setting string length values in 419
setting up open security 112
shared locations and 138
specifying default 37
specifying location for 138
start-up parameters in 179
updating 36, 38
viewing font information in 66
Configuration Home Partition setting 209
configuration options 9
configuration parameters 470
configurations
adding cluster 19
administrative tasks for 133
changing 239
changing database 38
CPU binding and 72, 73
database clients and 401
default 16, 17, 56
displaying parameters for 284, 364
displaying Record Matcher 668
examples for 13, 14
managing cluster 19
managing iServer 4, 8, 22
messaging protocol for 6
multiprocessor support for 7
secondary partitions and 136
setting logging properties for 214, 231
setting up iServer 6, 9
specifying regional settings for 245
user accounts and local 29, 33
viewing licensing options for 246
Configure page (Properties) 665
configuring
autoarchiving 677
Index 729
configuring (continued)
backup cluster master 210
Caching service 658
clusters 138
consolidator application 190
custom login applications 104
default locales 54
e.Spreadsheet Designer 49
Encyclopedia volumes 19–22, 340
example archive driver 71
external security sources 106
Factory processes 92
failover services 20
Formula One reports 50–52, 717
iServer 16, 28
iServer clusters 14, 16, 17–19, 138
iServer ports 35
iServer processes 44–46
LDAP servers 121, 122
multicast clusters 163, 178, 208, 209
open security applications 109–112
open server drivers 52–54
open server reports 690, 692
partitions 20, 330–331
Record Matcher applications 200
regional settings 245
resource groups 45
RSSE web service 108, 126
SMTP servers 238
stand-alone servers 13, 136, 138
system error logging 232
ConnConfigFile parameter 321, 488
ConnConfigSearchPath parameter 321, 488
connection components 400, 422
connection parameters 37
connection strings 413, 419, 420
connections
adding to configuration files 37
changing default ports and 36
checking database 405, 410, 416, 421, 433
DB2 databases 402–405
defining environment variables for 402
embedding 716
Encyclopedia volumes 555–557
Informix databases 405–408
MS/SQL databases 409–411
ODBC data sources 411–416
730 Administering Actuate iSer ver System
Oracle databases 417–422
overview 400
PeopleSoft databases 414
Progress9 databases 422–427
Red Brick databases 415
running multiple view processes and 100
SAP data sources 427–430
setting default 37
Sybase databases 430–433
ConnectOptions parameter 37, 38
console applications. See Active Portal;
Management Console
consolidator application 186, 189, 190
content management systems xxii
content types (e-mail) 63, 64
Context string property 360
context-sensitive help xxxiv
controller processes (Oracle tables) 421
conversion utilities 446, 454
conversions
dates 322
default date 55
image files 81
converters 99
cookies 144
coprocessors. See CPUs
–copy option (acupgrade) 461
copying
Encyclopedia volumes 442
executable files 83
information object cache 666
JAR files 49
report files 373, 698
shared libraries 52
template files 343, 350
corruption 463
CPU binding 72–78
CPU-intensive tasks 91
CPUs
adding 92
allocating resources for 91–92
assigning IDs to 73
cluster configurations and 18
configuring Factory processes for 92
estimating memory for 94
estimating resources for 93
logging information for 77
CPUs (continued)
restricting processes to specific 72
running multiple 7
testing View process performance for 99
crashes
assigning backup servers for 354
configuring restart parameter for 40, 41
creating failover service for 20
default configurations and 17
file systems and 172
transaction logs and 88
Create Cache option 663
Create Channel option 631
Create Cluster page 162, 163, 164
Create Completion Notice option 86
Create Group option 639
Create Record Matcher option 667
Create User option 591
creating
anonymous users 575
archive drivers 71, 72
backup servers 278
channels 226, 631–633
cluster master 160
clusters 19, 160–162
completion notices 60, 86
diagnostic logs 284
e-mail accounts 57, 59
e-mail message templates 61–65
failover services 20, 278, 279
folders 83, 227
Formula One reports 716
headlines 637
hyperlinks 64, 343, 350, 351
iServer accounts 28, 29
multiple cluster nodes 16
multiple volumes 176
notification groups 225, 638, 639
open server reports 692
partitions 21
PDF files 81, 97, 99
Record Matcher files 667
registry entries 548
report documents 652
report files 228, 652, 715
report-specific online help xxxvi
resource groups 384–386
roles 224, 584, 605
RSSE applications 104, 105, 615, 620
security roles 581
specific file types 691
URLs 60
users 223
virtual IP addresses 14
credentials 104, 618, 619
cross-platform reporting xxiii
Crystal Report Engine 54
Crystal report extensions 688
Crystal reports
accessing 4
configuring open server drivers for 52, 53
printing 54
running 31, 700–702
CRYSTAL_DB_DLL parameter 701
CRYSTAL_DB_NAME parameter 701
CRYSTAL_DB_PASSWORD parameter 701
CRYSTAL_DB_SERVER parameter 701
CRYSTAL_DB_USER parameter 701
cshrc files 42
CSS files 298
CSSFileLocationJSPRC parameter 299, 517
CSSFileLocationRC parameter 299, 517
CSV formats 716
ctlib connections 430
cube reports xxiii, 221
current status 146, 148, 150
custom login applications 104
customer profiles xx
Customer Support xxviii
customized_fonts.rox 39, 45, 69, 70
customizing
applications xxiv
e.Spreadsheet reports xxvii
e-mail notifications 60–65
fonts 70
printer settings 646
reports xxiv
resource groups 96
D
–D option (acmode) 456
Daemon IP Address parameter 135
Daemon Port parameter 135
Index 731
DaemonSOAPPort parameter 135
daemonURL parameter 141
DAT files 137
data
analyzing xxvi
caching 101
default location for 20
displaying 558
e.reporting solutions for xxii
extracting from Java applications 716
importing 123, 448, 449
merging 197
outputting to spreadsheets 38, 39
retrieving
from data stores 564
from databases 400, 409, 422, 424
from information objects 5
from XML data sources 405
data connection definition files 196
Data Connector options (licensing) 11
data cubes
designing xxiii
Encyclopedia file types for 706
generating xxiv
licensing option for xxv
data filters
applying 564
limiting items returned with 83
Data Integration Option (licensing) 12
data object instance files 5
data sets 401
data source map files 196
data sources
accessing 31
connecting to 37, 411–416
e.reporting solutions for xxvii
embedding 716, 717
merging 197
non-administrator accounts and 31, 32
overview 706
PeopleSoft databases and 414
setting up iServer clients and 28
stored procedures as 401
supported 716
data stores 95, 564
data types
MS/SQL databases and 411
732 Administering Actuate iSer ver System
Oracle databases and 418, 421
Database Connection Configuration
page 320
database connectivity software 28
Database Log Directory Minimum Space
parameter 41
Database property 424
database servers
accessing remote databases from 425
connecting to 400
running ODBC data sources 412
specifying as SQL-specific 409
databases
accessing external drivers 49
accessing multi-language 400
accessing security 106
caching information objects and 658
checking disk space for transactions 41
connecting to 37, 400
CPU resources and 91
defining environment variables for 402
e.reporting solutions for xxii
exporting administration 442
getting client information for 401
importing administration 450
listing export information 458
logging onto multiple 424
merging data from multiple 197
ODBC drivers and 411
running multiple reports on 92
searching large 122
setting locales for 406
setting up accounts for 407, 410, 420
DataDirect Connect ODBC drivers 411
date-based operations 55
date-based rules 675
dates 322, 631
See also schedules
Dates page 322
DateTimeAsString parameter 251, 482
db directory 137
DB2 databases
connecting to 402–405
getting connection information for 405
setting up environments 403
testing connections 405
DB2 Factory server 404
db2 utility 405
DB2CLI.sl 404
DB2CLI.so 404
DB2CODEPAGE variable 403
DB2COMM variable 549
DB2DIR variable 403, 549
DB2INSTANCE variable 403, 549
db2set command 404
DB-Library interface 409, 411
DBMS module 404
DBNLS variable 406
DCD files 196
DCP_AC_DEBUG_LEVEL parameter 717
DCP_BUILD_CLASSPATH parameter 717
DCP_ESPRESSO_LIB parameter 718
DCP_OTHER_LIBS parameter 717, 718
debugging 96
debugging information 717
default aging interval 675
default configurations 9, 16, 17, 72
default Encyclopedia volume 209
Default expiration time of failure notices
setting 365
Default expiration time of success notices
setting 365
default fonts 66, 68
default locales 44, 54, 144
default ports 36, 135
default privileges 588
default regional settings 245
default volume directory 137
DefaultEncoding parameter 471
DefaultFailureNoticeExpiration
parameter 495
DefaultLocale parameter 471
DefaultQueryTemplate parameter 370, 506
DefaultSuccessNoticeExpiration
parameter 494
Delay After Creating Operation Process
parameter 93
Delay Between Contacting Operation Process
parameter 93
delays 93
delete privilege 577
deleting
channels 226
cluster nodes 23, 171
completion notices 118
Encyclopedia volumes 20, 374–375
folders 227, 675
information object cache 667
jobs 652
notification groups 225, 602, 640, 643
notifications 342, 348
partitions 20, 21, 335–336
persistent completion notices 86
report files 228
roles 224, 601, 609, 612
specific file types 691
temporary files 43
user accounts 600, 605
users 223
deletion logs 217
DeletionLogEnabled parameter 476
DeletionLogLevel parameter 476
dependencies. See file dependencies
dependency information 72
deploying reports xxvii
Description parameter 489, 498, 507, 543
design tools xxiii, xxiv
designing
applications 21
e.Spreadsheet reports xxiv
reports xxiii
desktop reporting 29, 104, 661
detail reports 91
detailed information (debugging) 717
developers xxxvi
developing
e.Spreadsheet reports xxvii
reports xxiv, xxxvi
developing applications 575
development languages xxiv
development tools xxiv, xxv, xxvii
DH_PASSWD variable 426
DHTML Compression Level parameter 82
DHTML formats 82
DHTML Generation parameters 298
DHTML reports
caching output for 80, 703
compressing 81
converting XML data for 99
creating PDF files for 81
displaying 6, 80, 97
distributing 82
generating 716, 719
Index 733
DHTML reports (continued) tracking usage 95
getting font information for 45 disk I/O speed 87, 89
optimizing 80–82 disk partitions. See partitions
searching 81 disk space
setting fonts for 34 buffer pool and 88
setting page caching options for 703 checking 41
setting parameters for 298 monitoring 87, 363
viewing 702 partitions and 21, 330, 342, 348, 498
DHTMLGeneratorInfo parameter 299, 517 disk striping 90
DHTMLLong formats 82 disk writes 87, 90, 91
DHTMLRaw formats 82 dispatching requests 5, 19, 20
diagnostic logs 244, 284, 285, 286 display options 558–560
digital certificates 617 DISPLAY variable 33, 550
directories displaying
See also paths; search paths active jobs 146
allocating temporary 438 available channels 629
archive driver and 72 bundled reports 82
changing paths 333, 334 cache information 671
displaying paths 333 channel contents 629
locating home 42 charts 67
open security libraries and 360 completion notices 46
partitions as 20 data 558
setting file cache size for 101 data cubes xxiii
setting JDK installation 423 DHTML reports 6, 80, 97, 702
specifying Excel output 39 images 81
specifying home 549 installed fonts 66
structuring Encyclopedia volume 136–137 job information 657
transaction logs and 342, 348 jobs 648
Disabled parameter 544 licensing information 10, 246
DisableFailureJobs parameter 46 online documentation xxxiii
DisableProgramManagerCache open server reports 698
parameter 530 partition information 330, 333
DisableSuccessJobs parameter 46 PDF files 81
disabling purging settings 679
archive logging 72 release information 43
diagnostic logging 285 reports xxvii
information object cache 665 in web browsers 45, 702
job notifications 45 on UNIX systems 33
logins 593 resource groups 273, 383
page-level security 616 search results 562
resource groups 385 server properties 165, 260
disabling iServer services 9, 19 system partitions 150
disabling job notifications 46 system printers 394
disk drives system properties 206, 284, 364
connecting to remote 32 system servers 145
partitions and local 88 system status 141, 143, 152
recovering from I/O failures 173 version information 146

734 Administering Actuate iSer ver System

displaying (continued) running PeopleSoft ODBC 414
volume information 338 running SQL ODBC Server 411
volume status 148 drives (remote) 32
distinguished names (LDAP) 110, 112, 114 DTDs 405
distributing reports 82 DummyToLine parameter 255, 475
DLC variable 423, 426, 550 dynamic hypertext markup language. See
DLLPath property 407, 408, 412, 424 DHTML
DLLs dynamic text controls 44
Informix connections and 407 dynamic-link libraries. See DLLs
MS/SQL connections and 410
open server reports and 52, 53 E
Oracle connections and 418, 419, 420 e.Analysis
Red Brick databases and 415 branding parameters for 300
system logging and 216, 232 chart parameters for 304
document files. See data object instance files; general parameters for 301
report object instance files histogram parameters for 302
Document Type Definitions 405 labels parameters for 303
documentation xxxi, xxxiii, xxxiv, xxxvi, table view parameters for 305
xxxvii e.Analysis Option xxvi, 12
overview xxviii e.Business applications xxii
documents e.Report Designer xxiii
See also reports e.Report Designer Professional xxiv
converting to XML 97, 99 e.Report Option xxvi, 12, 50
creating 652 e.reporting server. See iServer
displaying 5 e.reporting solutions xxii
enabling page-level security for 615 e.Reporting System. See iServer System
optimizing 80 e.reporting tasks 4
storing 4, 21, 87, 405 e.Spreadsheet API 49
viewing 4 e.Spreadsheet Designer xxiv, xxvi, 49
.doi files. See data object instance files e.Spreadsheet Engine See Formula One
domain servers 29 e.Spreadsheet Engine
domains 57 e.Spreadsheet file types 710
dos2unix utility 467 e.Spreadsheet Option xxvi, 12, 49
download files 5 e.Spreadsheet reports
download files handled by View service 262 accessing external drivers for 49
downloading PDF files 81 copying JAR files for 49
downloading reports 99 customizing xxvii
.dox files. See data object executable files default output directory for 39
driver files 49 designing xxiv
drivers generating xxvi
accessing external 49 logging system usage information for 221
configuring open server 52–54 setting parameters for 290, 291, 711
configuring Red Brick 415, 416 storing in Encyclopedia 4
creating archive 71, 72 –eadmin option (acexport) 442
displaying current settings for 342, 350 eAnalysisAutoResizeVerticalAxis
finding open server 52 parameter 306, 520
running DataDirect Connect 411

Index 735
eAnalysisCubeSizeLimit parameter 301, 518
eAnalysisDecimalPoint parameter 302, 518
eAnalysisDisableMeasuresTotal
parameter 306, 520
eAnalysisHideCalculate parameter 308, 522
eAnalysisHideHelp parameter 308, 522
eAnalysisHideHome parameter 308, 522
eAnalysisHideHorizontalBarChart
parameter 308, 522
eAnalysisHideHorizontalFitToPage
parameter 309, 522
eAnalysisHideLineGraph parameter 309, 522
eAnalysisHidePieChart parameter 309, 522
eAnalysisHidePreferences parameter 309,
523
eAnalysisHidePrint parameter 309, 523
eAnalysisHideSave parameter 309, 523
eAnalysisHideSaveAsMicrosoftExcel
parameter 309, 523
eAnalysisHideSaveAsMicrosoftWord
parameter 309, 523
eAnalysisHideTableView parameter 309, 523
eAnalysisHideVerticalBarChart
parameter 309, 523
eAnalysisHideVerticalFitToPage
parameter 310, 523
eAnalysisHideWorkOffline parameter 310,
523
eAnalysisHorizontalAxisColor
parameter 306, 520
eAnalysisMainTitle parameter 301, 518
eAnalysisPathJSPRC parameter 302, 518
eAnalysisPieChartCombineMinimum
parameter 304, 519
eAnalysisShowColumnLevels
parameter 306, 520
eAnalysisShowColumnTotals parameter 306,
520
eAnalysisShowColumnTotalsLeading
parameter 306, 520
eAnalysisShowDrillControls parameter 306,
521
eAnalysisShowEmptyColumns
parameter 307, 521
eAnalysisShowEmptyRows parameter 307,
521
eAnalysisShowGridLines parameter 307, 521
736 Administering Actuate iSer ver System
eAnalysisShowHistogramIn3D
parameter 302, 519
eAnalysisShowHistogramPercent
parameter 303, 519
eAnalysisShowHistogramValues
parameter 303, 519
eAnalysisShowLineLabels parameter 303,
519
eAnalysisShowLinePercent parameter 303,
519
eAnalysisShowLineValues parameter 303,
519
eAnalysisShowPieChartIn3D parameter 304,
519
eAnalysisShowPieChartLabels
parameter 304, 520
eAnalysisShowPieChartPercent
parameter 305, 520
eAnalysisShowPieChartValues
parameter 305, 520
eAnalysisShowRowLevels parameter 306,
521
eAnalysisShowRowTotalLeading
parameter 306, 521
eAnalysisShowRowTotals parameter 306,
521
eAnalysisShowZeroColumns parameter 307,
521
eAnalysisShowZeroRows parameter 307, 521
eAnalysisShowZeroVariables parameter 307,
521
eAnalysisSortDimension parameter 307, 522
eAnalysisVerticalAxisColor parameter 307,
522
eAnalysisWatermark parameter 301, 518
eAnalysisWindowTitle parameter 301, 518
–echannels option (acexport) 442
editors 407
–ef option (acexport) 443
–efiles option (acexport) 443
–efiletypes option (acexport) 442
–egroups option (acexport) 443
–eprinters option (acexport) 443
EiiLogEnabled parameter 480
EiiLogLevel parameter 480
EJB data sources 716, 717
–ejobs option (acexport) 444
e-mail
adding attachments 593
adding hyperlinks 343, 344, 350, 351
adding subject lines to 62
changing maximum size for 239
changing number of recipients for 241
cloning notification groups for 641
configuring for licensing problems 78
creating 343
customizing notifications for 60–65
formatting content 62
iServer accounts and 29
load-balancing for 242–243
notification options for 56, 343
open security applications and 111, 116,
117, 118
registering accounts 56, 57, 58
resending 243, 244
sending 343
setting up accounts for 29
setting up notices for 593
setting up notifications for 55–60, 237
testing notifications for 57, 59
e-mail message templates
accessing 60
creating 61–65
default location for 343
embedding HTML in 64
Email Notification dialog 58
E-mail notification template partition
parameter 343, 350
EmailAddressAttr parameter 117, 127
email-content-type attribute 63
EmailURLType parameter 499
embedded fonts 67
Embedded SQL-92 (ESQL) 422
embedding data source information 717
Enable open security option 359
Enable SMTP option 238
EnableCachingService parameter 485
EnableGenerationService parameter 528
EnableIntegrationService parameter 483
EnableOpenSecurity parameter 501
EnableRequestService parameter 539
EnableRSSEFailover parameter 368, 504
EnableRSSEService parameter 503
EnableViewingService parameter 509
–encoding option (acupgrade) 439, 461
encoding
custom locales and 54
databases and 400, 413
supported 54
UNIX systems and 66, 432
zip formats and 82
Encoding parameter 245
Encyclopedia service
configuring as failover service 20
enabling 19, 345
managing multiple volumes 20
overview 4
volume-related requests and 19
Encyclopedia volumes
access types for 590
accessing 20
adding 20, 339–345
adding users 591
administrative tasks for 22, 23
allocating across multiple disk volumes 90
archiving objects in 71, 72
assigning backup servers to 354–356
assigning partitions to 331–332, 339, 362
assigning privileges 111, 612, 613
assigning privileges to 576, 579
assigning resource groups to 385, 388, 390
backing up 354, 683–685
command-line utility for 456
binding to specific CPUs 73, 77
caching DHTML reports and 80
capacity planning for 42, 87
changing display settings for 148
changing location for 20
changing owner 351
changing printer properties and 646
changing security type for 107
checking disk space for 41
checking user names for 125
cluster configurations and 14
configuring 19–22, 340
configuring security sources for 106, 109
configuring storage devices for 89
connecting to 555–557
controlling access to 31, 104, 105
copying 442
creating failover services for 20, 278, 279
Index 737
Encyclopedia volumes (continued)
creating from import utility 449
creating multiple 176
defining file types for 275
determining buffer pool size for 94
determining number of licenses for 10
disabling job notices for 45
displaying information for 338
displaying items in 98
displaying list of 147
displaying primary 276
displaying properties for 346
exporting information only 441
exporting objects 440
failing 169, 170, 280, 353
failover policy for 354, 356
file types supported 13, 196
filtering data in 564–566
Formula One reports in 51
generating documents for xxiv
importing administrative information 447
importing/exporting data for 123
installing example archive driver for 71
integrating external security sources
with 124, 125
limiting number of objects in 83
logging in to 100, 110, 556
managing content 4, 22, 96, 554, 557
managing notifications for 86
managing remotely 4
mapping administration information 110–
112
moving 20, 87, 372, 373
naming 345
open server applications and 689
optimizing performance for 82–90
overview 338, 339
partitioning 20–21, 330
putting online 345
read or write failures and 174
registering e-mail accounts for 56, 57, 58
removing 20, 374–375
resetting defaults 570–656
restoring 88, 371, 456
restructuring 82–85
running multiple 20, 22
searching 560–564
738 Administering Actuate iSer ver System
securing 106, 574, 615
sending requests to 5
setting autoarchive rules 677, 680
setting buffer pool for 277
setting parameters for 347, 351, 363
setting printer properties for 647
setting properties for 566
setting up user accounts for 575
specifying buffer pool size for 95
specifying default setup for 338
specifying system default 209
stand-alone configurations and 13
storing data for 4, 20
storing user information for 22
structuring 136
synchronizing cache with 101
taking offline 87, 345
temporary reports and 5
updating 88, 124
upgrading 458
validating 463
viewing available partitions for 330, 333,
362
viewing bundled reports and 82
End User Desktop xxiii
enhancements 10
enterprise reporting xix, xxi, xxii
ENU locales 44
environment variables
configuring Formula One 50
DB2 databases and 403
defining for database connections 402
Informix databases and 406
installing archive driver with 71
MS/SQL databases and 410
Oracle databases and 420
overview 547
Progress9 databases and 423, 426, 427
Red Brick databases and 415
setting 548
shared library search paths and 34
Sybase databases and 432
system vs. user 402
–erequests option (acexport) 444
error codes 233
error log configurations 232
error log consolidator application 190
error logging extension 232
Error Logging page 231
error logs 186, 212, 233
error_log.csv 230
ErrorDescription attribute 233
ErrorID attribute 233
ErrorLogEnabled parameter 476
ErrorLogFileName parameter 251, 482
ErrorLogFileSize parameter 251, 483
ErrorLoggingExt parameter 232
ErrorLoggingExtensionName parameter 477
ErrorLogLevel parameter 477
errors 233
checking e-mail notification 56
getting information for server 233
increasing stack size and 35
sending e-mail 243, 244
tracking 286
ErrorSeverity attribute 234
eSpreadSheetServerPort parameter 291, 530
ESQL utility (Informix) 407
etc directory 60
–eusers option (acexport) 443
Excel Data formats 656
Excel Display formats 656
Excel Generation parameters 288
Excel spreadsheets
controlling output for 38
designing for xxiv
generating xxvi, 266
getting font information for 39
setting output directories for 39
Exchange profiles (Microsoft) 57, 58
.exe files. See executable files
executable files
assigning to volumes 275
bundling 82
changing configuration files and 38
configuring for spreadsheets 38, 39
connecting to databases from 37
copying 83
enabling page-level security for 615
exporting 440
getting current server version 43, 44
getting font information in 39, 45, 69, 70
multi-language databases and 400
overriding font information in 44
providing extra storage for 21
required privileges for 652
setting cache size for 100, 101
specifying external libraries for 33, 34
execute privilege 577, 652
executing Actuate Basic reports 31, 384
executing Formula One reports 719
execution requests 5
Expiration date parameter 247
expiration dates 631
Expiration time of failed jobs setting 366
Expiration time of Success Job setting 366
export directory 440, 442
export files 438, 442, 458
export utilities 440, 457
exporting
objects in Encyclopedia 440
volume information 441
expressions 55, 561
extended credentials 104
ExtendedViewingCache parameter 512
ExtendedViewingCacheTimeout
parameter 513
Extensions directory 49
–external option (acafcconvert) 438
–external option (acupgrade) 461
external applications xxiii
external archiving tools 676
external authentication 590
External Authentication security level 107
external drivers 49
external files 38
external libraries 33, 34
External Registration security level 107
external security application 107
external security sources
accessing 107, 618
anonymous users and 621
authenticating users 616, 618, 622
centralizing user information in 22
configuring 106
converting administrative information
for 454
creating interfaces for 104
integrating with RSSE applications 124
registering users 617, 619, 621
running iServer and 29, 31
Index 739
external security sources (continued)
running sample application for 106
storing user properties 618
external user registration 591
externalized Encyclopedia volumes 123
externalized fonts 70
externalizing user information 22
F Failover Volumes page 279
Factory logs 217
Factory process
adjusting timing for 93
binding to specific CPUs 73, 77
changing configurations and 38
configuring 92
CPU management and 91
executing requests and 5
file system I/O and 88
generating reports and 44
getting font information for 44
memory usage and 94
optimizing 92
resource groups and 8, 96
restarting 95
running 91, 92
setting default locales for 44
setting up resource groups for 45
Factory server installations
ODBC data sources and 412
Red Brick databases 416
UNIX-specific platforms 434
Factory service
defining file types for 275
enabling 262
managing 165
overview 5
processing requests and 5
setting parameters for 270, 288
setting properties 267–274
Factory Service page 267
FactoryIdleTimeout parameter 293, 531
factsrvr database 434
factsrvr.redbrick 416
Fail over option 326
failed job notices 46, 118
failed jobs 60, 652
failed state 153
740 Administering Actuate iSer ver System
failover
file system failures and 172–175
setting up cluster master 209
setting up Encyclopedia 354
setting up iServer node 174
setting up system 172
failover nodes 20
failover service 20, 278, 279
FailoverIOFailureDelay parameter 254, 473
FailoverRetryPeriod parameter 254, 473
FailureJobExpiration parameter 494
failureMessage element 62
FailureNoticeExpirationAttr parameter 118,
127
FailureNoticeExpirationDefault
parameter 118, 127
failures
assigning backup servers for 354
configuring restart parameter for 40, 41
creating failover service for 20
default configurations and 17
file systems and 172
transaction logs and 88
Fatal DiskSpace Level parameter 41
fctsrvr6 server 435
fetching data 424
FetchRowBufferCount property 424
file attributes 181
File Caching parameters 295
file dependencies
archive drivers and 72
export utilities and 441
import utilities and 449
preserving 182
file descriptors (UNIX) 34
file directory 137
file name extensions 691
file names 37
file system directory 20
file system failures 172
file system I/O 87
File type attribute 218
file types
Actuate 13
Actuate Analytics 706
Crystal reports 700
information objects 196
file types (continued) FinishRequestProcessing attribute 217
open server reports 690, 691 –folders option (actoc) 458
SQRIBE reports 699 folders
FileCacheTimeout parameter 295, 509 access types for 590
files assigning privileges for 576, 579
See also specific types assigning privileges to 97, 111
access types for 590 changing privileges for 227
archiving 71, 179, 674–683 changing properties for 227
assigning privileges for 576 creating 83, 227
assigning privileges to 97, 111, 450 deleting 227, 675
bundling report 82 exporting 440
caching 100, 101 filtering items in 83
changing privileges 228 importing 449, 450
changing properties 228 limiting number of items in 83
checking disk space for 41 managing 23
copying 373, 698 open server file types and 691
creating 228, 652, 715 searching for items in 83
deleting 43, 228 setting access types for 590
directory structures for 136 setting LDAP home 119
downloading PDF 81 setting privileges for 612, 613
enabling page-level security for 615 setting up home 592
exporting 440, 441 specifying home 580
generating temporary 43 updating 227
importing 449 font files 39, 51, 67, 69
installing font 67 font information
managing 23 getting 44, 45, 69
moving 21 overview 34, 69
overview 691 searching for 70
predefined open server report 691 spreadsheets and 39
removing temporary 43 UNIX systems and 66
setting access types for 590 font metrics files 467
setting location for 13 FontName parameter 67
setting privileges for 612 Fontographer 467
specifying default configuration 37 fonts
storing 4, 21, 82, 137 applying to Formula One reports 51, 719
updating 228 applying to spreadsheets 39
zipping 81 converting 467
fileType directory 137 customizing 70
Filetype driver information settings 317, 318 displaying installed 66
Filetype parameters 317 embedding 67
FileTypeList parameter 544 getting for View processes 45
filtering data 564–566 installing for UNIX servers 67
filters installing language-specific 67
applying 564 installing/uninstalling PostScript 466, 467
limiting items returned with 83 mapping for charts 67–69
finding data. See searching overview 34
fingerprints 617 setting search paths for 69–70

Index 741
fonts (continued)
shipped with iServer 66
specifying dynamic text control 44
fonts.supported directory 66
FontUsedForSearchResultToExcel
parameter 313, 527
fontutils (UNIX) 466, 467
–force option (acimport) 452
–force option (acupgrade) 461
–forceGroup option (acintern) 455
–forceRole option (acintern) 455
–forceUser option (acintern) 455
formats
predefined locales and 54
specifying output 656
variable length text and 45
formatting
e-mail messages 62
Formula One e.Report Designer xxvii
Formula One e.Report Engine xxvii
Formula One e.Report Engine Option xxvi
Formula One e.Report Option (licensing) 12
Formula One e.Spreadsheet Engine xxvii
Formula One reports
configuring 50–52, 717
managing 715–720
free disk space 41, 87, 342, 348, 363, 498
Fully Editable RTF formats 656
functions
date conversions and 55
DB2 databases and 403
fundamental data types. See data types
G H
garbled data 413
General page (New Security Role) 605
General page (New Users) 592
generating
DHTML reports 719
e.Spreadsheet reports xxvi
HTML reports 719
log files 96
open server reports 52, 54
PDF files 97, 99, 716
Record Matcher files 667
report object instance files 652
reports xxiv, 44, 87, 91
742 Administering Actuate iSer ver System
spreadsheets 266
temporary reports 5, 262, 268
generation events (reports) 221
generation jobs 5
generation options (reports) 46, 47, 656
generation requests
memory usage and 94
tracking 648
GenerationLogEnabled parameter 477
GenerationLogLevel parameter 477
Global Search Path for Files used
parameter 38
grace periods 358
grant privilege 577
granting privileges. See privileges
graph controls 68
graphics
displaying in PDF files 81
increasing resolution for 81
graphics files. See image files
greeting attribute 241
Greeting parameter 546
GROUP_BASE_DN parameter 126
GROUP_OBJECT parameter 126
GROUP_TO_NOTIFY parameter 126
GroupBaseDN parameter 112, 126
GroupObject parameter 112, 126
Groups page 595
groups. See notification groups; resource
groups
GroupToNotify parameter 113, 126
GZIP-compressed DHTML format 81
–H option (acextern) 446
–H option (acintern) 455
–H option (acmode) 456
hardware devices 28
headlines 64, 637
heap 47
heartbeat
monitoring responses and 163, 178, 208
setting for cluster nodes 163, 178
Heartbeat failure period field 163, 178, 208
Heartbeat send period field 163, 178, 208
HeartbeatFailurePeriod parameter 473
HeartbeatSendPeriod parameter 473
–H option (consolidator) 192
–help option (acafcconvert) 438
–help option (acexport) 443
–help option (acimport) 452
–help option (actoc) 458
–help option (acupgrade) 461
–help option (acverify) 464
help
accessing online xxxiv–xxxvi
help files xxxiii
help system xxxiii
help topics xxxiv
Histogram page 302
–home option (acexport) 444, 452
home directory 42, 549
home folder
external users and 623
setting up 592
specifying LDAP 119
home folders
specifying 580
home page (Actuate) xxviii
home partition 209
HomeFolderAttr parameter 119, 127
Host property 424
Hostname or IP Address parameter 240
hosts
application service providers and 21
assigning to clusters 167
database-specific 400
OBDC drivers and 412
Oracle connections and 419
Sybase connections and 432
HP-UX servers
accessing Red Brick databases 416
accessing shared libraries for 34
accessing Sybase databases 431
configuring JVM for 52
configuring open server drivers 52
connecting to ODBC data sources 412
connecting to Progress databases 422
Formula One reports and 50
increasing stack size for 35
installing/uninstalling fonts 466
printing from 33
running iServer on 33
running Veritas file system on 90
setting language variable for 69
setting up CPU binding for 75
setting up DB2 clients 404
setting up environments 402
setting up Informix clients 405, 407
setting up Progress9 clients 426, 427
specifying database information for 404
HTML files xxxiii
HTML formats 45
HTML reports
generating 716, 719
getting font information for 45
HTML tags 62, 64
HTTP server 107
Hummingbird portmapper 30
hyperlinks
adding to e-mail messages 343, 344, 350,
351
adding to message templates 64
hyperthreading 74
I
I/O failures 173
I/O. See input; output
–iadmin option (acimport) 450
–iallf option (acimport) 451
IBM AIX systems
accessing shared libraries for 34
configuring JVM for 52
configuring open server drivers 52
Formula One reports and 50
increasing stack size for 35
Informix clients and 405, 407
installing/uninstalling fonts 466
ODBC connections and 412
printing from 33
Progress9 clients and 426, 427
Red Brick databases and 416
running iServer on 33
setting language variable for 69
setting up environments 402
Sybase databases and 431
IBM DB2 tables. See DB2 databases
ICD files 195, 196
–ichannels option (acimport) 450
icons 558, 632
Index 743
ICU_DATA environment variable
acacfconvert utility and 438
acexport utility and 440
acextern utility and 446
acimport utility and 448
acintern utility and 454
acmode utility and 456
actoc utility and 457
acupgrade utility and 460
acverify utility and 464
setting 550
–if option (acimport) 451
–ifiletypes option (acimport) 450
–igroups option (acimport) 450
–ijobs option (acimport) 452
image files
creating for PDF files 81
setting search paths for 38
images
adding to channels 632
displaying in PDF files 81
increasing resolution for 81
import utilities 447
importing
administrative information 447
data 123, 448, 449
inactive partitions 21
index (online documentation) xxxiv
indexed searches 81, 122
information application platform xx
Information Delivery API xxv, 5, 6, 22, 23
information delivery solutions xxii
information delivery systems xxi
information object cache definition files 196
Information Object Caching Option
(licensing) 12
information objects xxiv
caching 193, 658, 662
caching service for 6
copying cache for 666
creating cache for 663, 664
deleting cache 667
enabling cache for 665, 666
file types for 195
integration service for 6
overview 662
querying 5
744 Administering Actuate iSer ver System
retrieving data from 5
retrieving data with 198
setting parameters for 664, 665
updating cache 669
Informix Connect 407
Informix databases
connecting to 405–408
determining version 407, 408
ODBC drivers and 412
setting up locales for 406
Informix ESQL utility 407
INFORMIXDIR variable 406, 550
INFORMIXSERVER variable 406, 550
Inherits the Desktop and Window Station
parameter 52
–input option (acafcconvert) 438
–input option (acimport) 452
–input option (actoc) 458
input
disk write operations and 87, 91
optimizing 89
input files
exporting 441
importing 450
input parameters 425
insert element 63
installation
Actuate HTTP server 107
custom login applications 104
example archive driver 71
Factory servers 412, 416, 434
iServer 6, 29
Java SDK 47, 48, 50
Management Console 4, 22, 40
online documentation xxxiv
portmapper services 30
PostScript fonts 466–467
Record Matcher 200
Record Matcher applications 200
RSSE application 106
RSSE web service 108
security application 106
stand-alone servers 135
system printers 646
installation scripts (UNIX) 406
INSTHOME variable 550
Integration service
database connections and 661
described 6
logging events for 229
overview 194
setting parameters for 272, 273
Integration Service page 272
interfaces
See also application programming
interfaces
Internal server IP field 162
Internal server port field 162
internalized Encyclopedia volumes 123
Internet Explorer 99
IOB files 196
IP addresses
creating virtual 14
setting iServer System 134
setting Message Distribution service 167,
178, 263
setting multicast cluster 163, 178, 208
setting Process Manager 167, 261
setting stand-alone servers 162
–iprinters option (acimport) 450
–irequests option (acimport) 452
IsAttachment parameter 315, 541
iServer
accessing clients for 28
accessing example archive driver 71
accessing external drivers 49
adding CPUs for 91, 92
adjusting process timing for 93
administrative tasks for 22–23
architecture described 4–7
assigning Encyclopedia volumes to 19,
339
assigning to resource groups 274
backward compatibility for 7
caution for network printers and 32
changing JRE for 48
checking bound processors for 76–77
cluster failover and 172
configuring 6, 9, 16, 28
configuring for open server reports 689,
690, 692
controlling stack size for 35
CPU resource requirements for 91–92
customizing resource groups for 96
default heap size for 47
default location for temporary files 43
default portmapper service for 30
determining memory usage for 94
determining number of licenses for 10
displaying current version 146
displaying release information for 43
distributing requests to 14
enabling open security functionality
for 361
enabling services for 6, 9, 16, 19
estimating resources for 93
file system I/O and 87
finding home directory for 42
installing 6, 29
managing processes for 8
message routing for 22
messaging protocol for 6
non-administrator accounts and 30, 31
not starting 41
operations affecting performance 96
optimizing performance 80, 90–97, 400
overview xxi, 4
partitioning 281
removing partitions 335–336
restarting 17, 39, 160, 258
restricting processes for 72
running as stand-alone server 16
running Informix databases 405, 407
running MS/SQL databases 409
running multiple xxiv
securing 28, 29, 31, 104, 616
sending e-mail notifications and 29, 59, 60
service configurations for 261
setting cluster master for 16
setting configuration parameters for 470
setting IP addresses for 134
setting report generation options for 46–47
setting search paths for 38
setting up accounts for 28–31
setting up clusters for 17–19
setting up CPU binding for 72–78
setting up default locales for 54
setting up e-mail notifications for 55–60,
237, 343
Index 745
iServer (continued)
setting up Formula One environments
for 50–52
setting up open server environments
for 52–54
setting up ports for 35, 134
setting up processes for 44–46, 99, 100
starting 16, 39
stopping 154
system states for 153, 168
temporary reports and 5
tracking object relationships 83
viewing available partitions for 330, 333
iServer Integration Technology xxv, 72, 105
iServer System xxiv, xxv
accessing resources 32–34
adding printers for 395, 396
administrative tasks for 132–133
changing diagnostic logs for 286
changing licensing information for 247
changing properties for 160
configuration options for 9
controlling jobs for 652
displaying information about 151
displaying licensing information 246
displaying properties 206, 284, 364
fonts shipped with 66
installing Java SDK for 47, 48, 50
installing JRE for 47, 48
installing JVM for 47
job scheduling model for 652
licensing options 9–13
managing 4
monitoring 139, 163, 178, 208
output formats for 656
removing printers 398
report generation options for 656
setting e-mail notification preferences
for 343
setting logging properties for 214, 231
specifying regional settings for 245
states listed 153, 168
updating licenses for 247
validating licenses for 16
viewing status 141, 143, 152
volume security capabilities for 574
installing JVM for 51
746 Administering Actuate iSer ver System
isql program 433
isqlw program 410
–iusers option (acimport) 450
J
jar directory 47
jar files 47, 49, 718
Java 2 Standard Edition (J2SE) 49, 50
Java applications 716
Java Database Connectivity. See JDBC
Java files 47
Java Naming and Directory Interface
(JNDI) 717
Java Native Interface (JNI) 51
Java Object Interface page 322
Java objects xxvii, 51
Java report documents 4
Java Report Generation option 715
Java Runtime Environment (JRE)
caution for earlier releases 48
changing 48
upgrading 47
Java Software Development Kit (SDK) 47, 48,
50
Java tools xxvii
Java Virtual Machine (JVM)
configuring for Formula One
environments 51, 717
default fonts and 68
default heap size for 47
running Formula One reports and 50
JavaDataSourceLogLevel parameter 291, 530
JavaScript files 300
JDBC data sources 716
JDBC drivers 49
JDK installations 423, 425
JDKHOME variable 423, 426
JNDI client classes 717
Job name attribute 219
Job priority attribute 219
Job Schedules page 652
Job type attribute 219
jobCompletion value 64
jobDetailedStatus value 64
jobHeadline value 64
jobName value 64
jobs
administrative tasks for 652
archiving 674
cancelling 652
configuring iServer processes for 44, 45
creating notification groups for 638
date-based operations and 55
deleting 652
disabling notifications for 45, 46
dispatching requests for 5
dispatching temporary 5
displaying 146, 648
displaying information about 657
exporting 441
Factory service processes and 5
generating for channels 637–638
importing 450
managing notifications for 86
notification options for 679
open server reports and 653
overview 652–653
purging 341, 348
resource groups and 8, 275
running 8, 656
scheduling 652
sending e-mail notifications for 60, 64
sending status of 64
setting priorities 593, 653, 654
setting retry options 655
stopping resource groups for 390
submitting 653
Jobs page 593, 679
jobStatus value 64
jobSubmitter value 64
jobType value 64
.jod files 719, 715, 716
.joi files 716, 719
join key 197, 198
JPG files 81
jre_home directory 50
JSFileLocationJSPRC parameter 300, 517
JSFileLocationRC parameter 300, 517
jvm.dll 50
JVMMaxHeapSize parameter 323, 489
JVMs. See Java Virtual Machine
K
kerning 467
L
Labels page (e.Analysis) 303
LANG variable 69, 406, 550
language-specific fonts 67, 68
large report files 34, 82
–latest option (acexport) 443
Latin character sets 411
Latin fonts 66
LD_LIBRARY_PATH variable 34, 50, 52, 402,
550
LDAP classes 120
LDAP directory information 110
LDAP Directory Manager 123
LDAP objects 110, 111
LDAP security databases 106
LDAP servers
accessing 104, 616
assigning privileges for 115, 116
associating with specific channels 112
communicating with 123
configuring 121, 122
mapping administration information
to 110–112
optimizing performance 122
running queries on 113, 122
running sample application for 105
setting active port for 113
setting up open security for 109, 112
setting viewing preferences 121
specifying 114
storing user information on 22
ldap.conf 111
ldapconfig_.xml 108, 110, 112, 121
LeftImageHeightForActuateQueryOutput
parameter 289, 528
LeftImageNameForActuateQueryOutput
parameter 289, 528
LeftImageWidthForActuateQueryOutput
parameter 289, 528
libacprg9.sl 427
libacprg9.so 427
libacprg9_share.a 427
libdb2.so 404
Index 747
libjvm.a 50
libjvm.sl 50
libjvm.so 50
LIBPATH variable
Formula One reports and 50
open server reports and 52
UNIX environments and 34, 402, 550
libraries
creating symbolic links to 404
DB2 databases and 404
Informix connections and 407
location of archive 342, 350
MS/SQL connections and 410
open server reports and 52
Oracle connections and 418, 419, 420
Progress databases and 426
Red Brick databases and 415
setting search paths for 34, 38
specifying archival 675
specifying external 33, 34
specifying location of 718
specifying open security 360
library paths 550
license file 246, 247
License page 10, 247
licensing information 10, 13, 247
licensing options xxv, 9–248
Lightweight Directory Access Protocol. See
LDAP
links xxxiv
links (Active Portal) 628
links (Management Console) 630
Linux systems 400
Listen port parameter 240
listeners 421
load balancing 14, 96, 242, 400
load balancing routers 19
load balancing service 6
load-balancing weights 237, 241
local configurations 29, 33
local database connections 425
local printers 32
locale maps 54, 55
Locale parameter 245
Locale setting 144
localemap.xml 54, 55
748 Administering Actuate iSer ver System
locales
accessing multi-language databases 400
changing default 44, 145
configuring defaults for 245
detecting character sets for 413
e.reporting solutions for xxi
getting client information for 401, 404
installing fonts for 67
naming conventions for 54
rendering charts for specific 68
resetting Progress database 424, 426
setting database 406, 420
setting default 44, 54
specifying default 144
specifying time zones for 139, 144
localized fonts 67, 68
locating data. See searching
lock files 43
–log option (acverify) 464
log directory 137
log files
archiving reports and 72
command-line utilities 440, 448, 460
configuring diagnostic 284
examining sample usage 230
generating 96
optimizing transaction 88
setting properties for 286
setting up 139, 213
storing 137
writing processor information to 77
Log in disabled option 593
Log on as service privilege 30
LogDirectory parameter 484, 486, 489, 517,
529
logging
archival information 72
diagnostic information 284, 285
message errors 244
server errors 233
system errors 231
system usage 214, 216, 230
transaction information 342, 348
logging in to Encyclopedia 100, 110, 555
logging in to multiple volumes 556
logging levels 233
LoggingOn parameter 484, 486, 491, 517, 529
login applications 104
login events 223
login names 110
login scripts (Oracle tables) 420
logins
failing 556
multiple Progress databases and 424
open security and 622
setting system defaults for 144
system administrator 140
verifying user information for 616
LogLevel parameter 485, 486, 490, 518, 529
logout events 223
LogSize parameter 485, 486, 490, 518, 529
look-through limit 122
lost&found folder 459
lost_found folder 466
low partition disk space threshold 41
LowFreeSpaceMB parameter 507
M updating licenses with 247
–M option (acmode) 456
mail. See e-mail
Mailing weight setting 241
MailingWeight parameter 547
mailinst program 58
Management Console xxv
accessing external security sources
and 106
adding URLs with 60
adjusting buffer pool size from 88
administering system from 152
banner for 557
changing default ports 36, 135
cluster configurations and 14, 23
configuring View process for 45
controlling startup and shutdown of 8
CPU binding messages in 77
creating persistent notifications with 86
displaying information about 151
displaying job information 657
displaying licensing information 10, 246
displaying server information 259, 260
displaying system information from 43
displaying system properties 206, 284, 364
displaying system status 141, 143, 152
enabling services from 16
filtering data in 564
installing 4, 22
load-balancing routers and 19
logging in to 141, 555
managing Encyclopedia with 22
managing iServer nodes with 4, 22, 23
managing resource groups 8
overview 557
predefined web pages for 629
Process Manager and 6, 37
putting iServer nodes online 174
registering e-mail addresses with 56
running View process and 97
searching from 560
setting cluster master from 141
setting display options 558–560
specifying buffer pool size from 95
starting 40, 555
stopping 40
manual startups 39
Manuals directory xxxiv
MAPI configurations 56
MAPI formats 243
mapping server partitions 374
markup languages 62
Master fail over setting 326
master state 168
master_fonts.rox 39, 45, 69
MasterBackupList parameter 473
Max cache size property 266
Max cache timeout property 266
Max concurrent requests property 265
Max concurrent SOAP requests property 263
Max Excel pages property 266
Max view processes property 265
MaxAutoConfigPrinters parameter 252, 472
MaxConcurrentRequests parameter 509
MaxConnections parameter 484, 485
MaxEndpointThreads parameter 539
MaxExtendedViewingCacheSizePerProcess
parameter 514
MaxFactory parameter 544
MaxFileCacheEntriesPerProcess
parameter 296, 510
Index 749
MaxFileCacheSizePerProcess parameter 296,
511
Maximum Cached Sessions Per Process
setting 101
Maximum File Cache Size Per Process
setting 101
Maximum Heap Size setting 47
Maximum Number of File Descriptors
settings (UNIX) 34, 35
Maximum Number of Worker Threads
setting 99
Maximum Timeout for Cached ROX Files
setting 101
Maximum Total Size of Cached ROX Files
setting 101
MaximumStringLength property 418, 431
MaxJobPriorityAttr parameter 119, 127
MaxJobPriorityDefault parameter 120, 127
MaxMailMessageSize parameter 239, 474
MaxMailRecipients parameter 242, 255, 475
MaxPagesConvertibleToExcel parameter 524
MaxPriority parameter 544
MaxProcesses parameter 526
MaxQueryInputRows parameter 484
MaxQueryMemory parameter 484
MaxQueryRunTime parameter 484
MaxROXCacheSizePerFactory
parameter 530
MaxROXCacheSizePerProcess
parameter 515
MaxROXCacheSizeTimeout parameter 515
MaxSoapEndpointThreads parameter 37
MaxSyncJobRuntime parameter 532
MaxThreads parameter 484, 486
MaxThreadsPerProcess parameter 312, 527
MaxUserPort 93
MaxVarLen argument 408, 413, 422
memory
adding additional 91
allocating 94–95
determining e.reporting usage for 94
image resolution and 81
report generation and 91
setting buffer pool size for 88
tracking 95
memory blocks 94
menus 558
750 Administering Actuate iSer ver System
Message Distribution IP Address
property 263
Message Distribution Port property 263
Message Distribution service
adding multiple cluster nodes and 16
cluster configurations and 9, 23
communications protocol for 19
enabling 16, 19, 161, 262
managing 165
overview 5
printing requests and 5
setting IP addresses for 167
setting parameters for 264
setting properties 263
temporary jobs and 5
Message Distribution Service page 263
message routing 19, 22
Message too large error 244
messages
See also e-mail; notifications
formatting e-mail 62
logging archival 72
sending CPU licensing 78
shutdown 77
messaging protocol 6
metadata 20, 88, 95, 136
metadata directories 136
–mf option (acimport) 451
Microsoft Active Directory servers 104
Microsoft Analysis Services data cube 707
Microsoft Analytic Services parameters 709
Microsoft Exchange 29, 56, 57, 58, 243
Microsoft Internet Explorer. See Internet
Explorer
Microsoft SQL databases. See MS/SQL
databases
Microsoft SQL Server 409, 411, 414, 661
Min view processes property 265
MinFreeSpaceMB parameter 508
Minimum Partition Disk Space setting 41
MinPriority parameter 545
MinProcesses parameter 526
Modify Start Parameters option 177
monitoring disk space 87
monitoring iServer System 139, 163, 178, 208
monitoring resources 95
moving
Encyclopedia volumes 20, 87, 372, 373
files 21
partitions 20, 372
MS/SQL databases
connecting to 409–411
driver compatibility for 411
running as Caching service 661
testing connections to 410
mulitcast configurations 19
Multi-Application Option xxv
multicast clusters 163, 175, 178, 208
Multicast TTL field 163, 178, 208
MultiCastIPAddress parameter 473
MulticastPort parameter 473
MulticastTTL parameter 473
multi-language databases 400
multilingual reporting xxi
multiple partitions 137
multiprocessor support 7
multiprocessor systems 91
multithreading 91
N nodes. See cluster nodes
Name parameter 315, 317, 540, 541, 543, 545
named users 10
names
changing user 223
custom locales and 54
finding user 120
getting notification group 112
getting role 114
validating 125
NameSearch Option (licensing) 13
naming
channels 631
Encyclopedia volumes 345
partitions 332
resource groups 383, 385
naming conflicts 449
naming conventions 54
nesting roles 97, 111
NetOSI File Type settings 314, 316
NetOSIHostName parameter 316, 542
NetOSIVersion parameter 315, 541
Netscape Directory Server 106, 109
Netscape LDAP servers 122
Netscape Navigator 99
network administrators. See administrators
network file systems 172
network routers 14
networks
cluster communications protocols for 19
connecting to Oracle databases 419, 420,
421
displaying bundled reports and 82
managing clusters on 175
printing from 32
testing connections for 421
new features 10
New Resource Group page 386
New Security Role page 605
New Server page 166
New SMTP Server page 240, 241
New User page 591
New Volume page 340, 344
NLS_LANG variable 420
NobleNet portmapper for TCP 30
–nocheck option (acupgrade) 461
–nodisplay option (acupgrade) 461
non-administrator accounts 30, 31, 52
notices. See notifications
notification groups
adding users 111, 596, 639, 642
changing 601
cloning 641
converting security information for
RSSE 124
creating 225, 638, 639
deleting 225, 602, 640, 643
exporting 441
external users and 620
getting names 112
importing 449
open security mappings for 111
removing users 640, 643
renaming 640
resetting properties for 641
specifying 113
updating properties for 225
notification options 56, 679
Notification page 239, 366
Index 751
notification templates 343, 350
NotificationConfigPartition parameter 497
notifications
See also notification groups
adding headlines 637
customizing e-mail 60–65
deleting 342, 348
disabling 45, 46
displaying purging settings for 679
formatting e-mail 62
load-balancing for 242–243
managing 86
purging 677
reducing number of persistent 86
sending 86, 637
setting options for 343, 593
setting properties for 678
setting up e-mail 55–60, 237, 593
setting up open server 116, 117, 118
testing e-mail 57, 59
notificationTemplate element 62
ntext message can’t be sent error 411
NTWDBLIB MS/SQL library 410
Number of Copies setting 54
Number of Requests Before Recycling
Processes setting 95
Number of RPC sockets setting 324
Number of sockets for reply setting 325
NumberOfErrorLogFiles parameter 251, 483
NumberOfPagesGenerated attribute 217
NumberOfPagesPrinted attribute 217
NumberOfPagesViewed attribute 217
NumberOfUsageLogFiles parameter 250, 481
NumLogs parameter 485, 486, 490, 518, 529
NumRequestRetries parameter 290, 370, 506
NumSocketsForReply parameter 492
NumSocketsForRPC parameter 492
NWPPort parameter 314, 484, 485
O Open Data Access Framework xxiv
Object attribute 219
object cache definition files 663
ObjectArchiveDLL parameter 495
–objects option (actoc) 458
objects
accessing Java 51
752 Administering Actuate iSer ver System
creating view session 100, 101
tracking relationships among 83
ociw32.dll 420
ODA drivers xxiv, 661
odaconfig.xml 433
ODBC data sources
connecting to 400, 411–416
iServer accounts and 29
non-administrator accounts and 31, 32
ODBC databases 413
ODBC driver managers 413
ODBC drivers
configuring Red Brick 415, 416
running DataDirect Connect 411
running PeopleSoft 414
SQL servers and 411
ODBC interface 414
ODBC Server 411
odbc.ini 412, 413, 416
offline backups 683
offline state 153, 168
offline systems 155
–oldhome option (acupgrade) 461
OLE Automation software 29
Online Archive application 11
online archive application 182
Online Archive Option (licensing) 11
online backup 554, 683–685
Online Backup Schedule page 685
online backup utilities 87, 456
online documentation xxxi, xxxiii, xxxiv,
xxxvi, xxxvii
overview xxviii
online help xxxiii, xxxiv–xxxvi
online reports. See reports
online state 153, 168
online systems 153
Open Client mechanism 430
Open Data Access driver 433
open database connectivity. See ODBC
open security applications
caching external information for 107
centralizing user information in 22
configuring 109–112
configuring for LDAP servers 121
open security applications (continued)
integrating with external security
sources 125
LDAP mappings for 110–112
logging in to Encyclopedia from 110
managing 622–624
overview 104, 106
performance considerations for 122
running sample 105, 617
searching 122, 123
setting up iServer accounts for 31
setting viewing preferences for 121
open security environments 358, 616–622
open security feature 31
Open security IP address property 360
open security levels 617
open security libraries 360
Open Security page 106, 359
open security parameters 112, 121, 360
Open security port property 360
open security utilities 123–126
open server drivers
availability 688
default search paths for 52
setting up 692, 701
Open Server processes 5
open server reports
administrative tasks for 555
archiving 674
creating 692
defining jobs for 653
for Crystal reports 700–702
for SQRIBE 699–700
overview 688–698
predefined file types for 690, 691
printing 53, 54
required software 689
setting up iServer for 52–54
viewing 698
open server technology xxiii
operating systems 92, 93, 146
Operation attribute 219
operation processes 91, 93
Operator role 113, 567, 587, 622
OPERATOR_ROLE_NAME parameter 126
–operatorRole option (acextern) 446
OperatorRole parameter 113, 126
OPP_DHTML_BROWSER parameter 718
OPP_HTML_OUTPUT_TYPE parameter 719
OPP_TOC_ENABLED parameter 719
optimizing performance. See performance
optional partitions 20
options xxv
Options page 558
Options parameter (License) 247
Oracle 9i Client 417, 418
Oracle databases
connecting to 417–422
ODBC drivers and 412
supported data types 421
testing connections 421
ORACLE_HOME variable 420, 550
orphan objects 459, 466
OSI filetype driver information 317
OSIDriverPath parameter 318, 543
OSIParameterFilePath parameter 318, 543
–output option (acafcconvert) 438
–output option (acexport) 444
output
converting 656–657
disk write operations and 87, 90, 91
e.reporting solutions for xxiii
embedding fonts in 67
installing fonts for 34
optimizing 89
redirecting 53
rendering chart 68
resource groups and 8
setting up Excel 38, 39
Output attribute 219
output directories 39
Output Directory for Runtime Excel
setting 39
output file types
Crystal reports 700
SQRIBE reports 699
output files 441, 450
output formats 656, 715
output information 219
output parameters 422, 425, 718
OutputDirForRuntimeExcel parameter 288,
528
ownership 450
Index 753
P Partition field 209
–P option (acmode) 456
page buffer pool 88, 355
resource requirements for 94
page caching options 703
Page Level Security Option xxvi, 13
page-level security xxvi
administrative tasks for 554
assigning to clusters 176
enabling 615
overview 105, 614–616
paging rate 94
paging resource requirements 94
parameter values files. See report object value
files
parameterized queries. See stored procedures
parameters
adding to configuration files 110
assigning values 206
changing resource group 275, 386, 388
changing startup 177
configuring disk space and 363
Crystal reports and 701
displaying Encyclopedia volume 346
Excel output and 38
setting Caching service 271, 272, 273, 313,
660, 670
setting Chart Server 319
setting configuration 470
setting e.Spreadsheet report 290, 291, 711
setting Encyclopedia volume 347, 351, 363
setting Factory service 270, 288
setting Formula One report 717, 719
setting general 262
setting information object 664, 665
setting language 68
setting Message Distribution service 264
setting open security 112, 121, 360
setting open server 692
setting output 718
setting printer 282, 283, 395, 397
setting resource group 275, 383, 385, 389
setting system 208, 287
setting View service 267, 294
SQRIBE reports and 700
Parent Roles page 605
754 Administering Actuate iSer ver System
Partition Name parameter 281
Partition Path parameter 281
partitioning Encyclopedia volumes 20–21,
330
partitions
accessing 167
adding 331–332
as secondary storage device 332
assigning 176, 331, 339, 362
assigning volumes to 341
changing locations for 374
changing paths for 334
changing state 362
changing transaction log 89
checking disk space for 41, 498
configuring 20, 330–331
creating multiple 137
defining paths for 333
displaying information for 330, 333
displaying system 150
Encyclopedia performance and 87
importing data and multiple 448
moving 372
moving files among 21
naming 332
primary vs. secondary 136
reconfiguring 21
removing 20, 21, 335–336
setting properties for 280, 341
setting up iServer 281
specifying 32, 209
storing e-mail templates in 343, 350
taking offline 336
testing accessibility 333
viewing information for 149
viewing state 330
Partitions page (Options) 149
Partitions page (Servers Properties) 280
Partitions page (System) 330
Partitions page (Volumes Properties) 362, 372
–P option (consolidator) 192
–password option (acafcconvert) 438
–password option (acimport) 452
–password option (acupgrade) 462
password attribute 110
Password property 424
passwords
administrators and 140
assigning to users 592
changing 592
database connections and 400, 412, 426
e-mail accounts and 57
external users and 621
leaving blank 140, 556
non-administrator accounts and 30
obtaining customer xxviii
open security configurations and 109, 110,
114
open security reports and 616
recommendations for 592
setting system 208
setting up separate 661
Path parameter 540
PATH variable
adding path names to 52
database connections and 402
described 550
Formula One configurations and 50
MS/SQL connections and 410
open server configurations and 52, 53
Oracle connections and 420
Progress connections and 423
setting for UNIX systems 426
paths
adding to configurations 37
changing partition 334
open server default search 52
setting external library 33, 34
setting font search 69, 70
setting global search 38
setting open security library 360
setting open server report 52, 53
setting partition 333
setting transaction log 342, 348
setting up Informix 407, 408
specifying for external files 38
PDF files
See also PDF reports
compressing 81
downloading 81
generating 97, 99, 716
online documentation and xxxiii
PDF formats 656
PDF Quality parameter 81
PDF reports
displaying 81
getting font information for 45
setting fonts for 34
viewing charts in 81
PDFCreator parameter 311, 526
PDFProducer parameter 311, 526
PDFQualityOnWindows parameter 525
PDFUseJPEGForImage parameter 525
pending jobs 450
PeopleSoft Configuration Manager 414
PeopleSoft Data Connector Option
(licensing) 11
PeopleSoft databases 414
PeopleSoft ODBC driver 414
performance
buffer pool size and 95
bundling report files and 82
CPU binding and 73
CPU speed and 91, 93
customizing resource groups and 96
enhancing LDAP server 122
enhancing report generation and
viewing 92
Factory processes 44
operations affecting 96
optimizing DHTML report viewing 80–82
optimizing Encyclopedia 82–90
optimizing for View process 97, 99
optimizing iServer 80, 90–97
transaction logs and 88
performance degradation 89, 91, 94
Performance page (Process
Management) 312
performance tools 95
permissions. See privileges
persistent completion notices 86
PFA files 67, 467
phaseout state 330
Pie Chart page 304
plain text formats 45
pmd7.sh 402
pool
resizing buffer 276
resource requirements for 94
setting buffer 277, 279, 355
Index 755
pool (continued) printers
setting buffer 88 accessibility to iServer clients 28
PORT parameter (RSSE library) 126 accessing on UNIX systems 33
Port parameter (RSSE web service) 113, 126 accessing on Windows systems 32
Port property 424 adding 395, 396
portinst utility 30 administrative tasks for 394, 554
portmapper service 30 changing 648
ports creating local 32
adding for network printers 32 displaying system 151, 394
changing default 36, 135 importing 450
configuring iServer 35, 134 open server applications and 623
multicast clusters and 163, 178, 208 overview 646
Progress database connections and 424 redirecting output to 53
setting LDAP server 113 removing 398
setting Message Distribution service 178, setting properties for 281, 283, 397, 647
263 setting up 646, 647–648
setting Process Manager 135, 167, 261 setting up Process Manager and 28
setting stand-alone server 162 viewing properties 396, 397
PostScript files 67 Printers page (Options) 151
PostScript font utility 466–467 Printers page (Servers Properties) 281
PostScript fonts 34, 466 Printers page (System Administration) 394
PPD File Name parameter 282 printing
PPD files 395, 397 charts 67
previous releases 7 from UNIX systems 33, 66–67, 396
primary partition open server reports 52, 53, 54
default location for 20 PDF files 97
determining 362 PostScript files 67
removing 20, 335 reports 167, 646
specifying 342, 348 printing events 221, 230
storing report files on 21, 136 printing logs 217
primary server 356 printing options 646
PrimaryPartition parameter 498 Printing page 597
PrimaryPartitionMinSpace parameter 498 PrintingLogEnabled parameter 478
PrimaryServer parameter 497 PrintingLogLevel parameter 478
print jobs PrintTime attribute 217
See also printing priorities
assigning priorities to 653, 654 setting job 593, 654
dispatching requests for 5 setting LDAP request 119
managing 648–649 setting resource group 385
print requests 5 priority levels 653, 654
Printable Summary option 284, 364 priority ranges 653
PrintedPageNumbers attribute 217 Privilege Template page 596
Printer Administration Wizard 32 privilege templates 588
Printer name parameter 282 changing 223, 596, 602
Printer path parameter 282 LDAP servers and 110, 115, 116
printer settings 646, 647 privileges
PrinterOSName parameter 540 access types for 590

756 Administering Actuate iSer ver System

privileges (continued)
adding to templates 603
assigning 97, 111, 632
assigning to folders 579
assigning to groups 582
assigning with roles 581
changing channel 226
changing file 228
changing folder 227
changing role 224
creating for imported files 450
export information and 440
external users and 618, 620
for information objects 580
granting file 111
granting folder 111
granting from roles 111
granting to all users 112
overriding default 588
overview 575, 576, 591
page-level security and 615
removing 602
removing from roles 583
required 652
setting 577
setting from Management Console 612,
613, 614
setting LDAP server 115, 116
setting on home folders 623
setting on root folders 613
setting up iServer accounts and 29
updating 580
PrivilegeTemplateAttr parameter 115, 126
PrivilegeTemplateDefault parameter 116, 126
Process Communication page 323
Process Communication parameters 291, 311
Process Management Daemon
CPU binding and 72, 73, 74, 76, 77
e-mail accounts and 57
failing 175
starting 57
Process Management parameters 292, 312
Process Manager
changing default ports for 135
communications protocol for 19
configuring 135, 166, 261
controlling number of connections for 37
default functionality for 16
iServer and 6, 9
overview 8
registering as service 29
removing cluster nodes and 23
running Management Console from 40
setting up accounts for 28
starting 8
starting iServer from 39, 40, 138
starting Management Console from 41
process overhead 94
process timing 93
Processor Affinity option 73
processor IDs 73
ProcessorAffinity element 73
processors. See CPUs
ProcessRecycleCount parameter 293, 531
product suite xix, xxiii, xxiv
product updates xxviii
production environments 96
programmers xxxvi
programming interfaces. See application
programming interfaces
programming languages xxiv
programming tools xxiv, xxv, xxvii
Progress databases xxvi
Progress Option xxvi
Progress SQL-89 interface 425
Progress8 databases
connecting to Progress9 tables with 425
Progress9 databases
accessing dynamic link libraries 426
connecting to 422–427
defining environment 423, 426, 427
logging onto multiple 424
properties
changing channel 226
changing file 228
changing folder 227
changing iServer System 160
changing role 607, 609, 610
changing server 287
changing service 259
changing user 598, 600
configuring system logging 214, 231
displaying printer 396, 397
displaying server 165, 260–262
Index 757
properties (continued)
displaying set of values for 158
displaying system 206, 284, 364
leaving blank 566
open security mappings for user 110
open server applications and 623
resetting notification group 641
setting for multiple items 566
setting log 286
setting notification 678
setting output 657
setting partition 280, 341
setting printer 281, 283, 397, 646, 647
setting resource group 383, 386
setting server 156, 260, 283
setting service 263, 264, 267
setting SMTP e-mail server 239
storing in external security sources 618
updating notification group 225
updating role 224
Properties command 598, 612
Properties page (Printers) 396
Properties page (Resource Groups) 386
property lists 158
publishing spreadsheets 49
purging notifications 677
purging scheduled jobs 341, 348
purging settings 678, 679
push technology 628
Q Record Matcher cache 197, 198, 202
queries
date conversions for 55
executing on LDAP servers 113, 122
information objects and 5
parameterized. See stored procedures
running xxvii
setting row buffer size 424
Query Generation parameters 288
Query Option xxvii, 11
QUERY_ACCOUNT parameter 126
QUERY_PASSWORD parameter 126
QueryAccount parameter 113, 126
QueryPassword parameter 114, 126
queue 270
758 Administering Actuate iSer ver System
R
RAID devices 89
RAM 94
rb_client utility 416
RB_CONFIG variable 415
RB_PATH variable 415
–rbf option (acexport) 443
Rc.local 406
RDBMS servers 13, 14
read failures 173, 174
read privilege 576, 615
readers 617
read-only data 101
ReadOnlyQuery property 424
rebooting systems 17, 39
reconfiguring clusters 16
Record Matcher 667–669
Record Matcher application
running information objects and 195
Record Matcher applications
administrative tasks for 658
Caching service database and 199
configuring 200
creating 197
installing 200
limitations for 204
merging data and 198
overview 201
running transactions for 202
Record Matcher Connection page 659
Record Matcher database 194, 203, 204
Record Matcher definition files 196
Record Matcher Framework 197, 198, 200
Record Matcher Option (licensing) 13
records
filtering 564
setting buffer size for 424
Recycle Processes parameter 95
Red Brick databases
connecting to 415–416
installing Factory server for 416
testing connections 416
RedCloud enhancements 123
redirector nodes 19
reducing number of persistent notices 86
–ref option (acexport) 443
referencing external files 38
regedit.exe 548
regional settings 245
registering e-mail accounts 56, 57, 58
registering external users 591, 617, 619, 621
registering Process Manager 29
Registry Editor
Actuate keys listed 549
changing JRE home 48
changing keys 548
resetting Informix column lengths 408
resetting ODBC column lengths 413
resetting Oracle column lengths 422
setting CPU binding 73
setting iServer home 42
setting JDK home 423
setting key values 547
setting Oracle locales 420
setting registry keys 547
relational databases. See databases
relationships xxvi
relative paths
open server drivers and 52
specifying external libraries with 33, 34
release information 43, 151
release notes xxviii
release numbers 146
relocating Encyclopedia volumes 20, 372
remote databases 425
remote drives 32
remote servers 28
–rename option (acimport) 451
renaming
notification groups 640
–repair option (acverify) 464
–replace option (acimport) 451
report bursting 699
Report Encyclopedia. See Encyclopedia
volumes
report execution requests 5
report extensions 688, 710
report files
archiving 71, 179, 674–683
assigning privileges for 576
assigning privileges to 97, 111, 450
bundling 82
caching 100, 101
changing privileges 228
changing properties 228
checking disk space for 41
copying 373, 698
creating 228, 652, 715
deleting 228
directory structures for 136
enabling page-level security for 615
exporting 440
importing 449
managing 23
moving 21
open server types 691
overview 691
removing temporary 43
setting access types for 590
setting privileges for 612
storing 4, 21, 82, 137
updating 228
zipping 81
report generation events 221
report generation jobs 5, 441
report generation options 46, 47, 656
report generation requests
memory usage and 94
setting priorities for 653
tracking 648
report generation status 548
report object executable files
bundling 82
changing configuration files and 38
configuring for spreadsheets 38, 39
connecting to databases from 37
copying 83
enabling page-level security for 615
getting font information in 39, 45, 69, 70
multi-language databases and 400
Oracle databases and 418
overriding font information in 44
Progress databases and 423
providing extra storage for 21
required privileges for 652
setting cache size for 100, 101
specifying external libraries for 33, 34
report object instance files
bundling 82
Index 759
report object instance files (continued) designing xxiii
converting output 656–657 developing xxiv, xxxvi
displaying contents 5 display timing out 82
enabling page-level security for 615 displaying xxvii, 702
generating 652 distributing 82
getting font information for 44, 45, 69, 70 downloading 99
graph controls and 68 generating xxiv, 44, 87, 91
View processes and 100, 101 getting font information for 45
report object value files 652 logging system usage information for 221
report search events 222 managing view requests for 5
Report Server API xxv, 7, 339 optimizing 80
Report Server Security Extension 590 output formats for 656
See also RSSE applications overview xxi
Report Server Security Extension (RSSE) xxv, problems displaying 402
104, 575, 615 providing online help for xxxvi
report servers. See iServer; servers running 31, 384
ReportCast xxiv storing 4
configuring View process for 45 streaming 81
enabling e-mail notifications from 343, 351 viewing list of available 628
running View process and 97 ReportVersion attribute 218
sending reports to 60 Request Status attribute 218
ReportCast channels. See channels Requester API xxiv, 339
ReportCastURLPrefix parameter 499 Requester API page 323
reportDocumentName value 64 RequesterAPIConnectToRE parameter 292,
reportDocumentVersionName value 64 530
reportDocumentVersionNumber value 64 RequesterRSAPIVolume parameter 323, 489
ReportExecutableName attribute 217 RequestRetryInterval parameter 290, 370,
ReportExecutableVersion attribute 217 506
report-generation requests 654 –requests option (actoc) 458
reporting tasks 4 requests
ReportingEngines suite xxiii archiving 674
reportLink value 64 dispatching 5, 19, 20
ReportName attribute 218 enabling services for 16
ReportParameters attribute 218 Encyclopedia service and 20
ReportQuery technology xxiii execution processes for 5
reports export options for 444
accessing 628 handling concurrent 6, 91, 100
adding URLs 60 importing job 450
applying fonts to 69–70 managing 5
assigning expiration dates 631 purging 341, 348
attaching to e-mail accounts 593 restarting Factory processes for 95
caching temporary 80 routing 14, 19, 22
changing security type for 107 running printing 5
controlling access to 104, 105 sending to Encyclopedia 19
customizing xxiv specifying number of 265
database connections and 400 specifying priority 119
deploying xxvii submitting view 98, 99, 100

760 Administering Actuate iSer ver System

requests (continued) restoring snapshots 371, 683
tracking 648 restricting access
types described 5 open security and 31, 104
resending e-mail messages 243, 244 page-level security and 105
resetting clocks 42 restructuring Encyclopedia volumes 82–85
resolution 81 result sets 401, 422, 425
Resource Center (Actuate) 80 retrieving data
Resource group attribute 219 from data stores 564
resource groups from databases 400, 409, 422, 424
adding 384–386 from information objects 5
assigning 385, 388, 390 from XML data sources 405
changing parameters for 275, 386, 388 retry e-mail errors 243
configuring 45, 653 retry intervals 40, 41
customizing 96 retry options 655
defining file types for 275 –rfolders option (actoc) 458
disabling 385 rich-text formats 656
displaying 273 RightImageHeightForActuateQueryOutput
failing 172 parameter 289, 528
naming 383, 385 RightImageNameForActuateQueryOutput
overview 8 parameter 289, 529
performance and 96 RightImageWidthForActuateQueryOutput
prioritizing 653 parameter 289, 529
running reports from 384 rights and privileges. See privileges
setting job priority range for 385 .roi files. See report object instance files
setting parameters for 275, 383, 385, 389 ROLE_BASE_DN parameter 126
setting properties for 383, 386 ROLE_OBJECT parameter 126
stopping 390 RoleBaseDN parameter 114, 126
Resource Groups page 273, 276, 383 RoleObject parameter 114, 126
resources roles
accessing 28, 32–34, 175 adding to ACLs 105
adding 91, 92 adding users 607, 611
allocating 91–92, 99 assigning privileges from 581
buffer pool size and 94 assigning to all users 587
determining limits 34 changing 600
estimating CPU 93 changing privileges for 224
memory requirements and 94 cloning 608
monitoring 95 converting security information for
optimizing 6, 91 RSSE 124
restart intervals 40, 41 creating 224, 581, 584, 605
restarting cluster nodes 55, 169, 174 defining for web environments 632
restarting Factory processes 95 deleting 224, 601, 609, 612
restarting iServer 17, 39, 160, 258 enabling page-level security for 105
RestartLimit parameter 40, 41 exporting 440, 441
–restore option (acextern) 447 external users and 618, 620, 621, 622
–restore option (acintern) 455 filtering 565
restoring backups 87 getting names 114
restoring Encyclopedia volumes 88, 371 granting privileges with 111, 614

Index 761
roles (continued)
importing 449
managing 591
nesting 97, 111
open security mappings for 111
removing privileges from 583
removing users 607, 611
resetting properties 607, 609, 610
updating properties for 224
Roles page 594
root directory 137
routers 14
.rov files. See report object value files
parameter values files. See report object value
files
rows 424, 564
.rox files. See report object executable files
.rpt files 700
RSAPI page 311
RSAPIFetchLimit parameter 369, 504
–RSSE option (acacfconvert) 439
–RSSE option (acextern) 125, 447
–RSSE option (acintern) 455
–rsse option (acupgrade) 462
RSSE applications
See also Report Server Security Extension
accessing external sources and 31, 107, 124
changing volume security for 446, 454
creating 104, 105, 615, 620
enabling open security with 106–108
external user registration and 619, 621
externally defined roles and 620
importing data and 123
installing sample 106
integrating with Encyclopedia 107
interfacing with external security
sources 616
overview 590, 618
running 104
running open security utilities for 124–126
running sample 105
updating volume information for 124
validating volume information with 125
RSSE Cache Timeout parameter 108
RSSE cache timeout property 360
RSSE interfaces 360
762 Administering Actuate iSer ver System
RSSE library applications
configuring as multithread safe 361
RSSE library name property 360
RSSE max ACL buffer size property 361
RSSE multithread safe property 361
RSSE web service
configuring 108, 126
installing 106
RSSE web service configuration
information 108
RSSECacheTimeout parameter 501
RSSECommandLineStart parameter 368, 504
RSSEContextString parameter 503
RSSEIPAddress parameter 503
RSSELibrary parameter 502
RSSEMaxACLBufferSize parameter 502
RSSEMultiThreadSafeLibrary parameter 502
RSSESoapPort parameter 503
–rssevol option (acafcconvert) 439
–rssevol option (acupgrade) 462
RTF files 45
RTF formats 45, 656
rules 614
Run as services access 30
run time environments 718
running Actuate Basic reports 31, 384
running Formula One reports 719
running multiple View processes 99, 100
running sample applications 105
S
–S option (consolidator) 192
–Port option (acmode) 456
sample applications
installing as web service 106
running open security 105
sample RSSE applications 590
SAN devices 89
SAP Business Warehouse 427
SAP BW Data Connector Option 11
SAP data sources 427–430
SAP JCO libraries 428
SAP MetaData Interface 429
SAP native connector parameter 290
SAP R/3 Data Connector Option 12
SAP R/3 data sources 427
sapjco.jar 428
saving
file dependency information 72
scalability 91, 93, 100
scheduled jobs
displaying 648
importing 450
purging 341, 348
ScheduleForPurgingNotices parameter 496
schedules
date-based operations and 55
setting Caching service 669
storing 5
time-based operations and 42
scheduling aging cycles 681
scheduling jobs 652
scheduling online backup 685
scripts (UNIX) 39, 51, 548
search criteria 562
Search Extension API xxiv
search paths
external libraries 33, 34
open server defaults 52
setting font information 69, 70
setting global 38
setting Windows 550
shared libraries 34
search results 560, 562
Search Results page 564
search timeout intervals 81
Search Timeout parameter 81
Searchable property 81
searches (indexed) 81, 122
searching
DHTML reports 81
folders 83
for special characters 561
for volume data 560–564
large databases 122
open security reports 122, 123
SearchNoIndex value 81
SearchTimeout parameter 313, 527
SearchWithIndex value 81
secondary partitions 20, 21, 136
secondary storage 332
secure read privilege 576, 615
securing Encyclopedia volumes 106
securing iServer 104
security
accessing external sources 618
accessing information for 590
administrative tasks for 554
changing type implemented 107
controlling external cache for 108
converting information for 125, 454
e.reporting solutions for xxiii
enabling page-level xxvi, 615
exporting administrative information 441
filtering roles for 565
importing administrative information 449
overview 31, 104, 105, 358, 574, 575
running applications for 106–109
running iServer and 28, 29
setting up LDAP databases for 106
storing information for 124
types supported 104
updating information for 124
security databases 106
security IDs
associating with ACLs 105
associating with users 615
security roles
adding to ACLs 105
adding users 607, 611
assigning privileges from 581
assigning to all users 587
changing 600
changing privileges for 224
cloning 608
converting security information for
RSSE 124
creating 224, 581, 584, 605
defining for web environments 632
deleting 224, 601, 609, 612
enabling page-level security for 105
external users and 618, 620, 621, 622
getting names 114
granting privileges with 111, 614
managing 591
nesting 97, 111
open security mappings for 111
removing privileges from 583
removing users 607, 611
resetting properties 607, 609, 610
updating properties for 224
security tools xxv
Index 763
Send e-mail notification option 593
SendEmailAttr parameter 117, 127
SendEmailDefault parameter 118, 127
Sender e-mail address parameter 240
Sender ID cache 101
Sender name setting 240
SenderAddress parameter 546
SenderName parameter 547
sending completion notices 86
sending mail 55–60
See also e-mail
sendmail client 56
sendmail program 59, 243
SendNoticeAttr parameter 119, 127
SendNoticeDefault parameter 119, 127
–server option (acextern) 447
–server option (acintern) 455
–server option (acverify) 465
Server Assignments page 355, 390
server cluster master. See cluster master
server nodes. See cluster nodes; clusters
SERVER parameter (RSSE library) 126
Server parameter (RSSE web service) 114,
126
Server Settings page (Partitions) 333, 334
server-based reporting xxiii
ServerIPAddress parameter 492
ServerList parameter 498
ServerName attribute 218, 234
servers
See also iServer
accessing remote 28
adding to clusters 92, 164, 164–167
administrative tasks for 132, 133
allocating resources for 91
assigning as backup 279, 354–356
assigning to volumes 278
changing properties 287
communications protocol for 19
configuring Formula One reports for 717
configuring multiple report 9
configuring stand-alone 6, 9, 13, 16
converting output and 657
crash recovery for 17, 40, 41
creating clusters for 9, 162, 163
creating stand-alone 135
designating partition space for 280, 281
764 Administering Actuate iSer ver System
displaying assigned 145
displaying current status 146, 148
displaying properties 165, 260–262
e.reporting solutions for xxii, xxiii, xxv
enabling services for 16, 165
getting system information for 258
installing Management Console on 4, 22,
40
logging errors for 233
managing clusters for xxiv, 176
managing multiple SMTP 237, 240
resetting iServer ports for 134
restarting stand-alone 40, 41
running from clusters 168–171
running View process for 98
setting IP addresses for 134, 167
setting iServer ports for 35
setting properties for 156, 260, 283
shutting down 168
specifying as backup cluster master 210
specifying SQL-specific 409
starting stand-alone 39
streaming zipped files to 81
viewing primary Encyclopedia volume
for 276
Servers page (Options) 145
Servers page (Properties) 165, 259, 260, 261
Servers page (System Administration) 168,
169
ServerSOAPPort parameter 492
ServerSOAPPortBase parameter 493
ServerSOAPPortCount parameter 493
ServerURL parameter 367, 500
serverURL parameter 141
service aids 96
Service property 424
ServiceName attribute 234
services
See also specific service
changing properties for 259
cluster configurations and 18
configuring server-specific 261
controlling 547
crash recovery for 17
creating failover 20
disabling 9, 19
distributing requests to 20
services (continued)
enabling 6, 9, 16, 19, 165
hosting 21
installing portmapper 30
non-administrator accounts and 30
registering Process Manager as 29
setting properties 263, 264, 267
setting up Process Manager 28
stand-alone configurations and 9
types described 4
services file 407
Session Cache page 297
Session Cache Timeout parameter 101
session information 100
SessionCacheSizePerProcess parameter 298,
516
SessionCacheTimeout parameter 298, 516
sessions
controlling cache for 101
creating 100
timing out 101
setenv command (UNIX) 403, 548
setnet program 407
SETNET32 utility 408
setting display options 558–560
settings. See properties; attributes
shared folders 580
shared libraries
as archive drivers 71
open server reports and 52
Progress databases and 426
specifying search paths for 34
system logging and 216, 232
shared storage devices 88
shell scripts (UNIX) 42, 548
SHLIB_PATH variable 34, 51, 52, 402, 550
shutdown messages 77
shutdown scripts (UNIX) 191
shutdown utilities 40, 191
shutting down servers 168
SIDs. See security IDs
simple object access protocol xxv
See also SOAP
single-machine configurations 7, 9
SizeOfReport attribute 218
SMA files 196
smart cards 617
SMTP configurations 56, 63, 239, 241
SMTP greeting parameter 241
SMTP Server name parameter 240
SMTP servers
adding 240, 241
configuring 238
getting errors from 243
loading-balancing mechanism for 242
setting parameters for 240
specifying 56
SMTPHostName parameter 545
SMTPPort parameter 545
snapshots 371, 683
SOAP connections 37
SOAP message timeout parameters 315
SOAP messaging protocol xxv, 6
SOAP requests 263
SOAPDispatchIPAddress parameter 538
SOAPDispatchPort parameter 538
SOAPPort parameter 315, 483, 485, 542
SocketBaseForProcesses parameter 312, 526
SocketCountForProcesses parameter 312, 526
Sockets page 323
Software Development Kit (SDK) 47, 48
Solaris servers
accessing Informix databases 407
accessing Red Brick databases 416
accessing Sybase databases 431
database connections and 402, 406
Formula One reports and 50
ODBC drivers and 412
printing from 33
running iServer on 33
setting language variable for 69
setting up CPU binding for 72, 75
specifying database information for 404
SourceApplicationNames table 203
special characters 561
spool command (UNIX) 282, 396, 397
Spool command parameter 282
spreadsheets
See also e.Spreadsheet reports
controlling output for 38
customizing xxvii
designing xxiv
generating xxvi, 266
getting font information for 39
Index 765
spreadsheets (continued) multiple volumes and 176
publishing 49 printing from 394
setting output directories for 39 restarting 40, 41
SQL Client Configuration Utility 409 setting up e-mail for 237
SQL databases starting 39, 155
connecting to 409–411 validating Encyclopedia for 465
driver compatibility for 411 standard data types. See data types
running as Caching service 661 Start/Stop Online Backup Mode dialog 684
testing connections to 410 start_srvr.sh 51
SQL ODBC Server 411 starting
SQL statements. See queries cluster nodes 16, 168–171
SQL*Net 419, 420, 421 iServer 16, 39
SQL_CLIENT_CHARSET variable 423, 426 Management Console 40
SQLConnectW() method 414 Process Management services 57
sqledit program 432 Process Manager 8
sqlplus utility 421 stand-alone servers 155
SQR_BURSTING parameter 699 View processes 97
Sqrext.dll 53 starting state 153
SQRIBE burst mode option 699 startmc utility 40
SQRIBE report extensions 688 StartRequestProcessing attribute 218
SQRIBE reports Startup parameter 40
accessing 4 startup parameter 39
configuring open server drivers for 52, 53 startup parameters 176, 177, 179
printing 53 startup scripts (UNIX) 39, 51, 191, 406
running 31, 699–700 startup utilities 40, 191
SQRIBE_SQRWP_PATH parameter 53 State parameter 508
Sqrwp.exe 53 status directory 137
stack 35, 94 status information
stand-alone configurations displaying system 141, 143, 152
administering iServer and 22 displaying volume 148
converting to 23 generating 548
creating 6, 9 sending 64
default settings for 16 stopmc utility 40
messaging protocol for 6 stopping
multiprocessor support for 7 Actuate iServer 154
sample for 13 cluster nodes 168
setting up e-mail notifications for 56 stopping state 153, 168
stand-alone servers storage 20, 82, 94, 332
adding Factory processes for 92 See also storing
adding to clusters 162, 163, 164 storage devices 88, 89
administrative tasks for 132, 133 stored procedure components 401, 414
configuring 136, 138 Stored Procedure Data Source Builder 401,
creating 135 417
defining as cluster 163 stored procedures
displaying properties for 208 DB2 databases and 403
getting system information for 258 Oracle databases and 417
installing 135 overview 401, 425

766 Administering Actuate iSer ver System

stored procedures (continued)
PeopleSoft ODBC connections and 414
Progress databases and 422
returning result sets from 422
stores 95, 564
storing
See also storage
log files 137
properties 618
report documents 4
report files 82, 137
XML documents 405
streaming report pages 81
strings
containing spaces 420
maximum character lengths for 411, 418
passwords as 592
setting as registry entries 548
XML column data and 405
structured content technology xx, xxii
stubs 717
subfolders 83
subject element 62
SubmitTimestamp attribute 218
subscribing to channels 598, 628
successful job notices 46
SuccessJobExpiration parameter 497
successMessage element 62
SuccessNoticeExpirationAttr parameter 120,
127
SuccessNoticeExpirationDefault
parameter 120, 127
summary data 91
summary information (debugging) 717
Sun systems
accessing Informix databases 407
accessing Red Brick databases 416
accessing shared libraries for 34
accessing Sybase databases 431
configuring JVM for 52
configuring open server drivers 52
connecting to ODBC data sources 412
DB2 clients 404
Formula One reports and 50
installing/uninstalling fonts 466
printing from 33
Progress9 clients and 426, 427
running iServer on 33
running on UNIX platforms 402
setting language variable for 69
setting up CPU binding for 72, 75
SunOS servers 404, 426
Supported Products page 28, 48
Sybase databases
connecting to 430–433
ODBC drivers and 412
setting up environments 432
testing connections 433
SYBASE variable 432, 550
$SYBASE_OCS variable 431
SYBASE_OCS variable 550
sybinit utility 432
symbolic links 404, 412, 416, 426
symbolic names (Oracle tables) 420
SynchReportingWeight parameter 528
synchronous jobs 8
SyncJobQueueSize parameter 533
SyncJobQueueWait parameter 534
syntax conventions (documentation) xxxvii
System Administration console
adding URLs 60
adjusting buffer pool size 88
changing default ports from 36
changing licensing options 246
changing locale and time zones 144
changing transaction log partitions 89
displaying system information 141, 152,
259
managing resource groups from 45
managing system printers from 394
overview 22
performing administrative tasks from 142,
154, 155, 164, 356
setting open security parameters from 106
setting server properties 260
specifying buffer pool size from 95
updating licenses from 247
system administrators. See administrators
System applet (Windows) 403
system configurations. See configurations
system data sources 31
System DSN setting 31
system errors 233
system identifiers (Oracle tables) 420
Index 767
system monitoring tools 212 partitions 333
System multicast address field 163, 178, 208 Red Brick connections 416
System multicast port field 163, 178, 208 Sybase connections 433
system parameters 287 text
system printers 394, 646 adding to charts 67
System Printers option 394 converting for Progress databases 423, 426
system properties 160 getting font information for 44
System Properties page 206 Unicode implementation of 411
System Resource Groups option 383 text editors 407
system resources 32, 34, 175 text files 716
System Status page 152, 153, 155 text strings. See strings
system time 42 third-party libraries 52
System UDP port field 163, 178, 208 third-party reports 4
system usage attributes 217 third-party security systems 590
system usage log 212, 216, 219, 221 Third-Party Service parameters 315
examples for 230 third-party tools xxiv, xxv
SystemName parameter 471 thread stack size 35
threads 91, 94, 99
T throughput 92, 93
table of contents 719 time 42, 245
Table View page 305 Time zone setting 144
tables 405 time zones 139, 144
tags time-based operations 42
embedding in e-mail message Timeout for Process File Cache
templates 62, 64 parameter 101
task managers 95 timeout intervals
TcpTimedWaitDelay 93 external security cache 108
technical assistance xxviii Factory service 269
–temp option (acafcconvert) 439 LDAP servers 122
–temp_dir option (acupgrade) 462 search operations 81
template files 60, 343, 350 system heartbeat 163, 178, 208
templates temporary reports 80
setting up e-mail 61–65 View service 266
specifying partitions for 343, 350 view session cache 101
temporary directories 438 Timeout parameter 316, 542
temporary files 43 Timestamp attribute 234
temporary jobs 5 tmp directory 43
temporary reports tnsnames.ora 420
caching 80 Too many recipients error 244
described 5 Toolbar page 307
generating 262, 268 tools.jar 717
testing trace information 286
DB2 connections 405 transaction isolation level 424
e-mail notifications 57, 59 transaction logs 41, 88, 342, 348
MS/SQL connections 410 transactions xxii, 41, 202
Oracle connections 421 TransactionType attribute 218
transient files 43

768 Administering Actuate iSer ver System

Transient Report Execution Storage
parameters 294
transient reports
caching 80
described 5
generating 262, 268
transient store cache 80
TransientReportCacheLocation
parameter 535
TransientReportCacheSize parameter 535
TransientReportTimeOut parameter 536
TransientStoreMaxCacheEntries
parameter 294, 537
TransLogPartition parameter 505
TransLogPartitionMinSpace parameter 505
trends xxvi
triggers 422, 425
troubleshooting 284
TrueType fonts 34, 51, 68, 467
truncate.log 460
trusted execute privilege 577
TTC files 51, 68
TTF files 51, 68
–type option (acexport) 443
Type parameter 544
typographic conventions
(documentation) xxxvi
U running Process Manager for 8
–U option (acmode) 456
–U option (consolidator) 192
UCS-2 character sets 54, 400, 413
UDP ports 163, 178, 208
UDPPort parameter 474
uid attribute 110, 122
ulimit command (UNIX) 34, 35
UNC syntax 32
unicast clusters 163, 175, 178, 208
unicast configurations 19
Unicode character sets 54, 400, 411, 413
Uniform Resource Locators. See URLs
uninstalling PostScript fonts 467
Universal Naming Convention syntax 32
UNIX startup and shutdown scripts 191
UNIX systems
accessing databases from 400, 402
accessing shared libraries for 34
archive driver for 676
changing JRE for 48
configuring Red Brick drivers for 415
connecting to ODBC data sources 411, 412,
415
displaying charts on 68
displaying current iServer version 44
displaying installed fonts for 66
displaying reports on 33
enabling spreadsheet reporting for 49
example archive driver for 71
finding system resource limits for 34
getting home directory for 42
installing Factory servers 434
installing fonts for 67, 466, 467
installing Java SDK files for 48
maintaining security on 29
printing from 33, 66–67, 396
rendering charts for 68
resetting default column lengths 408, 413
resizing default column lengths 422
running client software on 400
running Formula One reports on 50, 52
running iServer on 33
running Management Console on 40
running open server reports 52
running Oracle databases from 419, 420
running stored procedures 401
sending e-mail from 243
setting default connections for 37
setting search paths for 38
setting temporary file location for 43
setting up e-mail iServer accounts 59
setting up environments 547, 548, 549
setting up iServer accounts 28, 31
specifying external libraries for 34
starting iServer on 39
testing connections for 405, 410, 416, 421,
433
uninstalling fonts for 466, 467
UNIXPPDFileName parameter 540
UNIXSpoolCommand parameter 540
Unrecognized recipient error 244
unrestricted Directory Server user 123
unsent e-mail 56, 60
Index 769
unused disk space 41, 87 user attributes
unused state 330 changing 223
Update license parameter 247 User DSN setting 31
update operations 88 user login events 223
update_reload.sh file 39 user logout events 223
updates xxviii user names
updating accessing volumes and 575
administration information 107, 124 adding to ACLs 105
channels 226 changing 223
configuration files 36, 38 database connections and 400, 412
Encyclopedia volumes 88 entering 592
folders 227 finding 120
license file 247 non-administrator accounts and 30
licenses 247 setting up separate 661
locale maps 55 user security role 586
privileges 580 USER_BASE_DN parameter 126
property values 566 USER_CHANNEL_LIST_ATTR
Record Matcher cache 669 parameter 126
report files 228 USER_CHANNEL_LIST_DEFAULT
upgrades 448, 458 parameter 126
URL prefixes 60 USER_DEFAULT_PRIV_ATTR
URLs parameter 126
adding to e-mail notifications 343, 344, USER_DEFAULT_PRIV_DEFAULT
350, 351 parameter 126
linking to reports 60 USER_EMAIL_FORM_ATTR parameter 127
logging in to an Encyclopedia volume USER_EMAIL_FORM_DEFAULT
from 556 parameter 127
Management Console login page 141, 555 USER_EMAIL_ID_ATTR parameter 127
specifying default connections with 37 USER_EMAIL_WHEN_ATTR parameter 127
specifying for image files 632 USER_EMAIL_WHEN_DEFAULT
usage consolidator application 190 parameter 127
usage log files 186 USER_FAIL_NOTICE_EXPIRATION_ATTR
usage logging extension 216 parameter 127
Usage Logging page 215 USER_FAIL_NOTICE_EXPIRATION_
usage_log.csv 213 DEFAULT parameter 127
UsageAndErrorLogVersion parameter 250, USER_FOLDER_WHEN_ATTR
480 parameter 127
UsageLogFileName parameter 250, 481 USER_FOLDER_WHEN_DEFAULT
UsageLogFileSize parameter 250, 481 parameter 127
UsageLoggingExtensionName USER_HOME_FOLDER_ATTR
parameter 478 parameter 127
Use C Locale as Default parameter 44 USER_MAX_COMPLETED_ATTR
UseDummyToLine parameter 255, 475 parameter 127
UseExternalizedFonts parameter 70, 254, 474 USER_MAX_COMPLETED_DEFAULT
UseMulticast parameter 474 parameter 127
UseOldABDateDiff parameter 322, 489 USER_MAX_PRIO_ATTR parameter 127
user accounts 575

770 Administering Actuate iSer ver System

USER_MAX_PRIO_DEFAULT
parameter 127
USER_OBJECT parameter 127
USER_SUCCESS_NOTICE_EXPIRATION_
ATTR parameter 127
USER_SUCCESS_NOTICE_EXPIRATION_
DEFAULT parameter 127
USER_VIEWING_PREF_ATTR
parameter 127
USER_VIEWING_PREF_DEFAULT
parameter 127
UserActivityLoggingExt parameter 216
user-based licensing 9, 10
UserBaseDN parameter 114, 126
user-defined functions 403
–username option (acimport) 452
UserName attribute 218, 234
UserName property 424
UserObject parameter 120, 127
users
accessing Encyclopedia 20
activity logs for 217
adding new 591
adding to notification groups 111, 596,
639, 642
adding to roles 607, 611
administrative tasks for 554
assigning job priorities 653
assigning passwords 592
assigning privileges to 614
assigning roles 595
authenticating external 616, 618, 622
changing channel subscriptions 604
changing notification groups 601
changing properties 598, 600
changing roles for 600
cloning 599
converting security information for
RSSE 124
creating 223
creating anonymous 575
defining anonymous 621
deleting 223
deleting job information 652
dispatching requests for 5
enabling open security for 109
enabling page-level security for 105
exporting information for 440, 441
externalizing information for 22
getting information for 449, 652
mapping administration information
for 110
registering external 591, 617, 619, 621
removing accounts 600, 605
removing from notification groups 640,
643
removing roles 601
setting up e-mail notifications for 55–60
setting up iServer accounts for 29, 30, 31
subscribing to channels 598
testing e-mail notifications for 57, 59
Users page 591
UseSMTP parameter 475
UTF-8 code pages 400, 413
UTF-8 encoding 54
utilities. See command-line utilities
V
–v option 44
–V option 457
validating licenses 16
values
assigning to parameters 206
variable attribute 63, 64
variable length text 45
variant data types 411, 418
verifying external users 619
Veritas file systems 90
–version option (acimport) 451
version attribute 62
version information 146
versions
getting current iServer 43
View attribute 218
View process
adjusting timing for 93
allocating resources for 99
binding to specific CPUs 73, 77
converter framework for 99
creating PDF files and 81
file system I/O and 88
getting font information for 45
memory usage and 94
Index 771
View process (continued) release information 43
optimizing 97, 99 reports xxvii
overview 97, 98, 702 in web browsers 45, 702
page-level security and 615 on UNIX systems 33
running 91 resource groups 273, 383
setting cache size for 99, 100, 101 search results 562
setting search timeout intervals for 81 server properties 165, 260
setting up 99, 100 system partitions 150
starting 97 system printers 394
storing session information for 100 system properties 206, 284, 364
streaming report pages 81 system servers 145
view requests 98, 99, 100 system status 141, 143, 152
View service version information 146
e-mail notifications and 56, 237 volume information 338
enabling 262 volume status 148
enabling externalized fonts for 70 viewing events 222
managing 165 viewing logs 217
overview 5 viewing options 558–560
setting parameters for 267, 294 viewing preferences 121
setting properties 264 ViewingLogEnabled parameter 479
View Service page 264 ViewingLogLevel parameter 479
view session objects 100, 101 ViewingWeight parameter 509
ViewedPageNumbers attribute 218 ViewPreferenceAttr parameter 121, 127
Viewer xxvii ViewPreferenceDefault parameter 121, 127
ViewExcelFileWithExcel97 parameter 310, virtual IP addresses 14
524 virtual memory 94, 95
viewing virtual memory manager 95
active jobs 146 virtual X servers 33
available channels 629 visible privilege 576
bundled reports 82 –vol option (acexport) 444
cache information 671 –vol option (acextern) 447
channel contents 629 –vol option (acimport) 452
charts 67 –vol option (acintern) 454, 455
completion notices 46 –Vol option (acmode) 457
data 558 –vol option (acverify) 465
data cubes xxiii Volume Administration console
DHTML reports 6, 80, 97, 702 accessing 567–570
images 81 creating persistent notifications from 86
installed fonts 66 disabling notifications from 45
job information 657 managing administration information
jobs 648 and 96
licensing information 10, 246 managing open security applications 622–
online documentation xxxiii 624
open server reports 698 overview 22, 557–560
partition information 330, 333 volume administrators. See administrators
PDF files 81 Volume attribute 218
purging settings 679 Volume field 209

772 Administering Actuate iSer ver System

Volume parameter 545
volume-based licensing 10
VolumeHomeFileSystem parameter 474
Volumes page 276
Volumes page (Options) 147
Volumes page (Servers Properties) 276
Volumes page (System Administration) 356
Volumes Properties page 347
volumes. See Encyclopedia volumes
.vtf files 711
.vts files 710
.vtx files 711
W displaying charts on 68
wait periods 44, 82, 93, 101
Warning Threshold parameter 41
warnings 286
web browsers
connecting to Encyclopedia 555
displaying online documentation in xxxiii
displaying reports in 45, 80, 97
enabling caching for 80, 703
generating DHTML reports for 99
opening multiple windows for 556
output-specific parameters for 718
resetting volume defaults for 570
setting page caching options 703
viewing available channels 629
web pages
iServer predefined 628, 629
web servers
installing Management Console 4, 22, 40
open server reports and 689, 698
resetting iServer ports for 134
running View process for 98
setting iServer ports for 35
streaming zipped files to 81
web sites
accessing reports on 628
creating ReportCast channels 631–633
e.reporting solutions for xxi, xxii
obtaining Actuate product updates xxviii
securing xxiv
subscribing to channels on 628
webcasting 628
–what option (actoc) 458
white papers 80
wildcards 624
Windows messaging service 57
Windows startup and shutdown utility 191
Windows systems
accessing databases from 400, 402
accessing iServer resources 32
archive driver for 676
caution for network printers and NT 32
changing JRE for 48
configuring Red Brick drivers for 415
connecting to ODBC data sources 411, 414,
415
displaying current iServer version 43
enabling spreadsheet reporting for 49
example archive driver for 71
getting home directory for 42
installing Java SDK files for 48
installing portmapper service for 30
registering e-mail accounts 58
rendering charts for 68
resetting default column lengths 408, 413,
422
running Formula One reports on 50, 51
running Management Console on 40
running open server reports 52, 53
running Oracle databases from 419, 420
running Process Manager for 8
running reports on 31
running stored procedures 401
sending e-mail from 243
sending e-mail on 29
setting default connections for 37
setting default locales for 44
setting Registry keys for 547
setting search paths for 38
setting up CPU binding for 72, 73–75
setting up e-mail iServer accounts 57–59
setting up environments 549
setting up iServer accounts 28, 29–31
specifying external libraries for 33
testing connections for 405, 410, 416, 421,
433
workload
adding Factory processes for 92
adjusting process timing for 93
Index 773
workload (continued) XML data sources xxvii, 405
balancing 6, 14, 19, 96, 400 XML development tool xxv
estimating resources for 93 XML Extender 405
paging rates and 94 XML reports 97, 99
running multiple view processes and 100 XPHOME variable 550
testing View processes for 99 XPPATH variable 550
tracking resource usage for 95 XRD files 195, 196
World Wide Web. See web xvfb program 33
write failures 174 XVFBDISPLAY variable 550
write operations 87, 90, 91
write privilege 577 Y
year conversions 55, 322
X
X Windows servers 550 Z
X Windows systems 33 zip formats 81

774 Administering Actuate iSer ver System