Professional Documents
Culture Documents
Administering Iserver System
Administering Iserver System
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
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.
Introduction xxiii
modify complex reports created by an IT developer and use sophisticated
components from libraries.
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.
Actuate Viewer
An application end users can use to find, view, and print report documents.
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
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
Terminology map
Glossary
Actuate 8
Glossary
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.
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.
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
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.
Typographical conventions
The following table describes the typographical conventions in this guide.
Syntax conventions
The following table describes the symbols used to present syntax.
Introduction xxxvii
xxxviii Administering Actuate iServer System
Part
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
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
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.
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.”
Application
databases
Encyclopedia
volumes
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.
Router
Application
servers Server Server Server
Optional Router
hardware router
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
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.
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
Accessing resources
The following sections discuss how to access Actuate iServer System
resources.
Microsoft Actuate
Exchange Server Server
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.
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" />
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.
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.
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
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.”
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
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
Actuate web
application
Encyclopedia
volume
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.
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
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.
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.
For information about changing the default login setup, see Chapter 6,
“Working with system-wide Actuate iServer parameters.”
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.
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.
For more information about working with Actuate iServer System volumes,
see Chapter 9, “Working with an Actuate iServer System volume.”
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.
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.
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.
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:
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.
For an Actuate iServer cluster, System—Modify Start Parameters looks like the
one in the following illustration.
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.
</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.
Log
database
Log file Consolidation
process
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
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.
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.
Actuate
iServer
Encyclopedia
volume
AIS ACS
process process
Data source
Record
Caching and
Matcher
Record Matcher
application
databases
Application
information
object
Record Matcher
Data source
Information
information
objects
objects
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.
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
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.
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.”
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
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.
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.
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.
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
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
At the detailed logging level, Actuate iServer add the printer name to
string field 13.
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 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.
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.
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>
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.
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.
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.
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.
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.
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
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
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
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.
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"
>
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.
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.
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.”
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
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.
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.
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).
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.
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.
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.”
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.”
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.”
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.
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
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).
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.
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.
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.
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.
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.
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>
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Parameter Description
NWPPort Port for Caching process communication with
Integration process. The default value is 0.
Takes effect at server restart.
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.
Parameter Description
Name Name of an Actuate iServer OSI filetype driver.
Actuate iServer displays this name in the list of
OSI filetype drivers.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
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
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.
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.
Parameter Description
Volume name Name of the Encyclopedia volume.
Description Optional description of the Encyclopedia
volume.
Choose OK.
Volumes appears, displaying the new volume owner.
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.
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.
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.
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.
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.
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
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.
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.
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.
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
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
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.
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.
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.
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.
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.
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.
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.
Chapter 10, Adding and configuring an Actuate iSer ver System resource group 391
392 Administering Actuate iSer ver System
Chapter
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.
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.
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
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.
[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.
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
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.
Variable Value
DLC Progress 9 installation directory
JDKHOME This must be set to the JDK directory
PATH %DLC%/bin and %DLC%/jre/bin must be
added to this variable
Platform Library
AIX libacprg9_share.a
HP-UX libacprg9.sl
SunOS libacprg9.so
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
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.
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.
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.
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.
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Display name
Server System parameter Description
System name Name of cluster, if it belongs to one.
Parameter: SystemName Takes effect at system restart.
Category: General
Default system encoding Default encoding for the servers in the cluster. Default value is
Parameter: DefaultEncoding windows-1252.
Takes effect at system restart.
Category: Locale
Default system locale Default locale for the servers in the cluster. Default value is C
Parameter: DefaultLocale locale.
Takes effect at system restart.
Category: Locale
Display name
Usage and error logging
parameter Description
Deletion log enabled Actuate iServer usage logging extension records activity in a
Parameter: log file when a user deletes an object from an Encyclopedia
DeletionLogEnabled 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 Deletion log level. For the Actuate usage logging extension
Parameter: that ships Actuate iServer, values are Standard and Detail.
DeletionLogLevel Default value is Standard. Takes effect only when
DeletionLogEnabled is true.
Takes effect immediately.
Category: Usage And Error Log File Settings
Error log enabled Actuate iServer error logging extension records Actuate
Parameter: iServer error information in a log file. Default value is false do
ErrorLogEnabled 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
Display name
Integration service
parameter Description
Enable integration service Flag to enable or disable the Integration service. Default value
Parameter: is false.
EnableIntegrationService Takes effect immediately.
Category: General
Port for integration server TCP/IP port for Integration process communication with
operations Encyclopedia volume process. Default value is 11800. Range is
Parameter: SOAPPort an integer between 1024 and 65535.
Takes effect at server restart.
Category: Process Communication
Display name
Caching service parameter Description
Enable caching service Flag to enable or disable Actuate iServer Caching service.
Parameter: Default value is false.
EnableCachingService Takes effect immediately.
Category: General
Port for caching server TCP/IP port for Caching process communication with
operations Encyclopedia volume process.
Parameter: SOAPPort Default value is 11200. Range is an integer between 1024 and
65535.
Takes effect at server restart.
Category: Process Communication
NWPPort Port for Caching process communication with Integration
Parameter: NWPPort process. Default value is 0.
Takes effect at server restart.
Category: Process Communication
Max SOAP requests Maximum number of connections when communicating with
Parameter: MaxConnections Encyclopedia volume process. Default value is 20. Range is an
integer between 2 and 1024.
Takes effect at server restart.
Category: LoadSettings
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
Port count from base for Port count from base for internal soap messages. Default value
internal soap messages is 500.
Parameter: Takes effect at server restart.
ServerSOAPPortCount
Category: SOAP Settings
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
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
Display name
Viewing service parameter Description
Viewing weight Relative value Actuate iServer uses to distribute viewing
Parameter: ViewingWeight 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
Enable viewing service Flag to enable or disable the View service. Default value is
Parameter: false.
EnableViewingService Takes effect immediately.
Category: General
Maximum concurrent Maximum number of concurrent requests handled by a View
requests process. Default value is 128.
Parameter: Takes effect immediately.
MaxConcurrentRequests
Category: Request Management
Timeout for process file Controls the timeout of a View process file cache. The default
cache Value 86400 seconds, 1 day, is the recommended value.
Parameter: Actuate recommends a value between the range of 3600, 1
FileCacheTimeout 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
Show histogram data values Show e.Analysis histogram data values as numeric data.
as numeric Default value is true.
Parameter: Takes effect at server restart.
eAnalysisShowHistogram
Category: Histogram
Values
Show Line graph Show e.Analysis line graph subcategory labels. Default value
subcategory labels is false.
Parameter: Takes effect at server restart.
eAnalysisShowLineLabels
Category: Labels
Show Line graph data Show e.Analysis line graph data values as percent. Default
values as percent value is false.
Parameter: Takes effect at server restart.
eAnalysisShowLinePercent
Category: Labels
Show Line graph data Show e.Analysis line graph data values as numeric data.
values as numeric Default value is false.
Parameter: Takes effect at server restart.
eAnalysisShowLineValues
Category: Labels
Combine pie chart Combine Pie Chart subcategories that are less than this
subcategories that are less percentage of total. Default value is 3. Range is from 0 to 99.
than this % of total Takes effect at server restart.
Parameter:
eAnalysisPieChartCombine Category: PieChart
Minimum
Show 3D pie chart graphs Show e.Analysis pie chart graphs in 3D. Default value is true.
Parameter: Takes effect at server restart.
eAnalysisShowPieChartIn
Category: PieChart
3D
Auto-resize vertical axis Automatically expand the rows to fill the height of the data
Parameter: display area. Default value is true.
eAnalysisAutoResize Takes effect at server restart.
VerticalAxis
Category: Table View
Disable measures total Disable measures total in e.Analysis. Default value is false.
Parameter: Takes effect at server restart.
eAnalysisDisableMeasures
Total 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
Show rows with all zeros Show e.Analysis rows with all zeros. Default value is true.
Parameter: Takes effect at server restart.
eAnalysisShowZeroRows
Category: Table View
Show Zero Variables Show e.Analysis zero rows. Default value is false.
Parameter: Takes effect at server restart.
eAnalysisShowZero
Category: Table View
Variables
Hide horizontal fit to page Hide e.Analysis horizontal fit to page button. Default value is
button false.
Parameter: Takes effect at server restart.
eAnalysisHideHorizontalFit
Category: Toolbar
ToPage
Hide line graph button Hide e.Analysis line graph button. Default value is false.
Parameter: Takes effect at server restart.
eAnalysisHideLineGraph
Category: Toolbar
Hide pie chart button Hide e.Analysis pie chart button. Default value is false.
Parameter: Takes effect at server restart.
eAnalysisHidePieChart
Category: Toolbar
Hide save as Microsoft Word Hide e.Analysis Save a Microsoft Word button. Default value
button is false.
Parameter: Takes effect at server restart.
eAnalysisHideSaveAsMS
Category: Toolbar
Word
Hide table view button Hide e.Analysis table view button. Default value is false.
Parameter: Takes effect at server restart.
eAnalysisHideTableView
Category: Toolbar
Hide vertical bar chart Hide e.Analysis vertical bar chart button. Default value is
button false.
Parameter: Takes effect at server restart.
eAnalysisHideVerticalBar
Category: Toolbar
Chart
Hide vertical fit to page Hide e.Analysis fit vertical to page button. Default value is
button false.
Parameter: Takes effect at server restart.
eAnalysisHideVerticalFitTo
Category: Toolbar
Page
Hide work offline button Hide e.Analysis work offline button. Default value is false.
Parameter: Takes effect at server restart.
eAnalysisHideWorkOffline
Category: Toolbar
Display name
Reporting service
parameter Description
Synchronous reporting Relative value used for distributing synchronous report
weight requests among servers with the View service enabled in an
Parameter: Actuate iServer cluster. Default value is 100.
SynchReportingWeight Takes effect immediately.
Category: Cluster Load Balancing
Output directory for Specify the 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.
Parameter:
OutputDirForRuntimeExcel Category: Excel Generation
Enable Generation Service Flag to enable or disable the Factory service. Default value is
Parameter: false.
EnableGenerationService Takes effect immediately.
Category: General
Height for the image Specify the height in inches of the image that appears in the
Parameter: upper left corner of Actuate Query pages.
LeftImageHeightForActuate Takes effect immediately.
QueryOutput
Category: Top-left corner image in Actuate Query Output
Path to the image Specify the path to the image that appears in the upper left
Parameter: corner of Actuate Query pages.
LeftImageNameForActuate Takes effect immediately.
QueryOutput
Category: Top-left corner image in Actuate Query Output
Width for the image Specify the width in inches of the image that appears in the
Parameter: upper left corner of Actuate Query pages.
LeftImageWidthForActuate Takes effect immediately.
QueryOutput
Category: Top-left corner image in Actuate Query Output
Height for the image Specify the height in inches of the image that appears in the
Parameter: upper right corner of Actuate Query pages.
RightImageHeightFor Takes effect immediately.
ActuateQueryOutput
Category: Top-right corner image in Actuate Query Output
e.SpreadSheet server port Port used for e.Spreadsheet server. Default value is 1569.
number Takes effect at server restart.
Parameter:
Category: eSpreadSheet
eSpreadSheetServerPort
Report use originating Controls the value of the server parameter used in Requester
encyclopedia for requester API calls. Default value is true.
API calls Actuate iServer uses the name or IP address of the
Parameter: Encyclopedia volume managing the report. Actuate iServer
RequesterAPIConnectToRE 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
Display name
SOAP dispatch parameter Description
Message distribution service IP address or machine name of the Message Distribution
IP address Service.
Parameter: If you specify a machine, Actuate iServer binds to all available
SOAPDispatchIPAddress 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
Message distribution service Port of the Message Distribution Service. Default value is 8000.
port Value is a valid, unused port, typically between 1024 and
Parameter: 65535.
SOAPDispatchSOAPPort
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
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
Display name
Server node printer
parameter Description
Name used by operating Printer name.
system to identify printer Takes effect at server restart.
Parameter: PrinterOSName
Category: Identification
PPD file name on UNIX PPD file name for UNIX printer.
Parameter: Takes effect at server restart.
UNIXPPDFileName
Category: Identification
Spool command on UNIX Spool command used with UNIX printer.
Parameter: Takes effect at server restart.
UNIXSpoolCommand
Category: Identification
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
Display name
Resource group parameter Description
Name Name of an Actuate iServer resource group. Displays in the
Parameter: Name list of resource groups.
Takes effect immediately.
Resource group description Optional resource group description displays in list of
Parameter: Description resource groups.
Takes effect immediately.
Category: General
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
Administering an Encyclopedia
Part 4
4
volume
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
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.
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.
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.
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.
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.
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
The following table lists actions that require privileges for a source or
destination folder.
1. Select each
DAdams BCarter DAdams BCarter
user
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.
1. Select each
R&D Sales R&D Sales
security role
(which groups
DAdams BCarter DAdams BCarter
certain users)
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.
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.
Role Manager
Sales
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.
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.
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\
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
Choose Roles.
Choose 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.
9 To specify a default printer and printer settings for the user, choose
Printing.
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 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.
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.
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:
7 Choose OK.
6 Choose OK.
7 Grant the users read access to the channels to which they are subscribed,
either directly or through a security role.
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.
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.
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.
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.
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.
Choose OK.
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.
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.
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
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.
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.
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.
7 Choose OK.
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
Choose OK.
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.
No
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.
When you have finished setting the properties for a printer, you can set
properties for another printer by selecting a different printer.
Choose OK.
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
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
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.
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.
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.
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.
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.
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.”
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.
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.
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
Choose OK.
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.
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.
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
Third-party
support Actuate Encyclopedia
software iServer volume
System
Third-party
report Open
engine server
driver
Open
server
report files
For full descriptions of the file types listed here, see the individual file type
entries in Actuate 8 Glossary.
7 Choose OK.
Choose OK.
Choose OK.
Choose OK.
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
Web Actuate
browser Web server Active
Portal
For information about using a DHTML report, see Working with Actuate Basic
Reports.
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.
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
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
Index 723
–adminUser option (acintern) 454 AppContainerPort parameter 261, 491
advanced parameter categories 287 AppContext parameter 315, 542
Advanced properties page 156 application programming interfaces
Advanced Server Properties page 283, 287 (APIs) xxv
AFM files 67, 467 backward compatibility for 7
age-based rules 675 dispatching requests from 5
aggregate reports 91 application servers
aging cycle 681 See also servers
See also archiving configuring as cluster 14
aging interval 675 configuring as stand-alone 13
See also archiving configuring Formula One reports for 717
AIS. See Integration service e.reporting solutions for xxii
AIS events 229 setting iServer ports for 35, 134
AIX servers application service providers 21
accessing shared libraries for 34 application-level partitioning 21
configuring JVM for 52 applications
configuring open server drivers 52 allocating memory for 94
DB2 clients and 404 building custom login 104
Formula One reports and 50 configuring Encyclopedia volumes for 21
increasing stack size for 35 controlling stack size for 35
Informix clients and 405, 407 customizing xxiv
installing/uninstalling fonts 466 deploying from xxvii
ODBC connections and 412 designing 21
printing from 33 developing 575
Progress9 clients and 426, 427 dispatching requests for 5
Red Brick databases and 416 e.reporting solutions for xx, xxii
running iServer on 33 extracting data from Java 716
setting language variable for 69 generating XML data for 97, 99
setting up environments 402 installing sample RSSE 106
Sybase databases and 431 managing iServer from 22, 23
–all option (acexport) 443 messaging protocol for 6
–all option (acimport) 451 running open security sample 105
–all option (actoc) 458 Apply Filter option 565
All role 112, 587, 620 Archive before deletion option 675
ALL_ROLE_NAME parameter 126 archive driver xxv
allocating memory 94–95 creating 71–72
allocating resources 91–92, 99 displaying current settings for 342, 350
–allRole option (acextern) 446 specifying 342, 350
AllRole parameter 112, 126 archive library 675, 676
analysis tools xxiv Archive library name parameter 342, 350
Analytics Cube Designer xxiii Archive Option (licensing) 10
Analytics Cube Viewer xxiii Archive Schedule button 681
Analytics Option xxv, 11, 416 archive.dll 71
analyzing data xxvi Archive.log file 72
anonymous users 575, 621 ArchiveServiceCmd parameter 495
ANSI drivers 413 archiving
ANSI to OEM Conversion option 409 administrative tasks for 554
Index 725
C locales 44, 54 CPU binding and 73
C shell scripts (UNIX) 42, 548 CPU resources and 91
cache calendar. See dates
ACS database for 658 callback classes 49
automatically installing 661 cancelling jobs 652
configuring Record Matcher 202 capacity planning 42, 87
controlling external security 108 cascading style sheets 298
creating information object 663, 664 case sensitivity 592
deleting information object 667 C-based RSSE application 104, 109
displaying information about 671 CDATA sections (e-mail templates) 62, 64
enabling for web browsers 80, 703 CenturyBreak parameter 55, 322, 488
enabling/disabling information changing
object 665, 666 channel subscriptions 604
increasing size 266, 269 cluster configurations 16
invalidating view session 101 cluster master 325–326
replicating information object 666 CPU binding 76
setting for PDF files 81 database configurations 38
setting for View processes 99, 100, 101 default locales 44, 145
setting open security 122 default ports 36, 135
setting parameters for 295, 297 diagnostic logging 285, 286
synchronizing 101 Encyclopedia volume owner 351
updating information object 669 font executable files 70
updating Record Matcher 669 home folder location 580
Cache Connection page 659 iServer accounts 29
caching licensing information 246, 247
DHTML report pages 80, 703 licensing options 247
external security information 107 notification groups 601
information objects 193, 658, 662 passwords 592
report files 100, 101 printers 648
temporary reports 80, 269 privilege templates 223, 588, 596, 602
caching options (web pages) 703 property values 566
Caching service role properties 607, 609, 610
configuring 658 security roles 600
described 6 security type 107
displaying information for 671 SMTP configurations 239
overview 193, 658 start-up parameters 177
running Record Matcher jobs 669 system properties 160
scheduling jobs for 669 system time 42
setting parameters for 271, 313, 660, 670 time zones 145
setting up external database for 661 transaction log partitions 89
Caching Service Load Information property user attributes 223
group 271 user names 223
Caching Service page 271 user properties 598, 600
Caching Service Port Information property channel attribute 112
group 271 channel membership information 110
calculations Channel Privileges page 606
caution for running time-based 42 Channel Subscriptions command 598
Index 727
cluster master (continued) getting system information for 208, 258
starting 155 load balancing service for 6
cluster master failover 209 managing 19, 22, 175
cluster nodes multiprocessor support for 7
accessing Encyclopedia volumes and 89 multi-server configurations and 9
adding iServer machines to 92 networking requirements for 175
administrative support for 8 overview 21
configuring iServer for 6 removing nodes from 23, 171
configuring resource groups for 383 resetting iServer ports for 134
creating multiple 16 restarting nodes 55, 174
deleting 23, 171 routing requests to 14
displaying resource groups for 273 running servers from 168–171, 176
enabling iServer services for 16, 19, 237 setting iServer ports for 35
failing 20, 174 setting up e-mail notifications for 56, 237
installing iServer on multiple 9 setting up open server drivers for 52
making partitions available to 332, 333 setting up UNIX accounts for 31
message routing for 6, 23 specifying Factory processes for 45
overview 164 stand-alone configurations and 9
reordering display settings for 146 starting nodes in 16
reporting status of 6 system configurations and 6
restarting 55, 169, 174 cn attribute 111
running on UNIX systems 31 code pages
setting up 138 database encoding and 400, 409, 423, 426
specifying as backup volume 278 detecting 413
starting 16 specifying default 245
taking offline 171 column length
viewing primary Encyclopedia volume Informix data sources and 408
for 276 ODBC data sources and 413
ClusterName attribute 217, 233 Oracle data sources and 422
clusters xxiv Sybase data sources and 431
accessing locale maps 54 command-line arguments
adding Factory processes for 92 getting current server version 44
adding printers 394 setting acacfconvert 438
adding servers 92, 164 setting acexport 442
administrative tasks for 132, 133 setting acextern 446
communications protocol for 19 setting acimport 450
configuring 14, 16, 17–19, 138 setting acintern 454
CPU binding and 73, 76 setting acmode 456
creating 9, 19, 160–162 setting actoc 458
customizing resource groups and 96 setting acupgrade 461
designating partition space for 280 setting acverify 464
dispatching requests to 5 setting fontutils 467
displaying system options for 145, 147, setting UNIX environments 403
149, 151 testing connections 405, 410, 421, 433
enabling services for 16 testing UNIX e-mail notifications 59
failing 172 Commandline parameter 315, 541
file system I/O and 88
Index 729
configuring (continued) Oracle databases 417–422
backup cluster master 210 overview 400
Caching service 658 PeopleSoft databases 414
clusters 138 Progress9 databases 422–427
consolidator application 190 Red Brick databases 415
custom login applications 104 running multiple view processes and 100
default locales 54 SAP data sources 427–430
e.Spreadsheet Designer 49 setting default 37
Encyclopedia volumes 19–22, 340 Sybase databases 430–433
example archive driver 71 ConnectOptions parameter 37, 38
external security sources 106 console applications. See Active Portal;
Factory processes 92 Management Console
failover services 20 consolidator application 186, 189, 190
Formula One reports 50–52, 717 content management systems xxii
iServer 16, 28 content types (e-mail) 63, 64
iServer clusters 14, 16, 17–19, 138 Context string property 360
iServer ports 35 context-sensitive help xxxiv
iServer processes 44–46 controller processes (Oracle tables) 421
LDAP servers 121, 122 conversion utilities 446, 454
multicast clusters 163, 178, 208, 209 conversions
open security applications 109–112 dates 322
open server drivers 52–54 default date 55
open server reports 690, 692 image files 81
partitions 20, 330–331 converters 99
Record Matcher applications 200 cookies 144
regional settings 245 coprocessors. See CPUs
resource groups 45 –copy option (acupgrade) 461
RSSE web service 108, 126 copying
SMTP servers 238 Encyclopedia volumes 442
stand-alone servers 13, 136, 138 executable files 83
system error logging 232 information object cache 666
ConnConfigFile parameter 321, 488 JAR files 49
ConnConfigSearchPath parameter 321, 488 report files 373, 698
connection components 400, 422 shared libraries 52
connection parameters 37 template files 343, 350
connection strings 413, 419, 420 corruption 463
connections CPU binding 72–78
adding to configuration files 37 CPU-intensive tasks 91
changing default ports and 36 CPUs
checking database 405, 410, 416, 421, 433 adding 92
DB2 databases 402–405 allocating resources for 91–92
defining environment variables for 402 assigning IDs to 73
embedding 716 cluster configurations and 18
Encyclopedia volumes 555–557 configuring Factory processes for 92
Informix databases 405–408 estimating memory for 94
MS/SQL databases 409–411 estimating resources for 93
ODBC data sources 411–416 logging information for 77
Index 731
DaemonSOAPPort parameter 135 Oracle databases and 418, 421
daemonURL parameter 141 Database Connection Configuration
DAT files 137 page 320
data database connectivity software 28
analyzing xxvi Database Log Directory Minimum Space
caching 101 parameter 41
default location for 20 Database property 424
displaying 558 database servers
e.reporting solutions for xxii accessing remote databases from 425
extracting from Java applications 716 connecting to 400
importing 123, 448, 449 running ODBC data sources 412
merging 197 specifying as SQL-specific 409
outputting to spreadsheets 38, 39 databases
retrieving accessing external drivers 49
from data stores 564 accessing multi-language 400
from databases 400, 409, 422, 424 accessing security 106
from information objects 5 caching information objects and 658
from XML data sources 405 checking disk space for transactions 41
data connection definition files 196 connecting to 37, 400
Data Connector options (licensing) 11 CPU resources and 91
data cubes defining environment variables for 402
designing xxiii e.reporting solutions for xxii
Encyclopedia file types for 706 exporting administration 442
generating xxiv getting client information for 401
licensing option for xxv importing administration 450
data filters listing export information 458
applying 564 logging onto multiple 424
limiting items returned with 83 merging data from multiple 197
Data Integration Option (licensing) 12 ODBC drivers and 411
data object instance files 5 running multiple reports on 92
data sets 401 searching large 122
data source map files 196 setting locales for 406
data sources setting up accounts for 407, 410, 420
accessing 31 DataDirect Connect ODBC drivers 411
connecting to 37, 411–416 date-based operations 55
e.reporting solutions for xxvii date-based rules 675
embedding 716, 717 dates 322, 631
merging 197 See also schedules
non-administrator accounts and 31, 32 Dates page 322
overview 706 DateTimeAsString parameter 251, 482
PeopleSoft databases and 414 db directory 137
setting up iServer clients and 28 DB2 databases
stored procedures as 401 connecting to 402–405
supported 716 getting connection information for 405
data stores 95, 564 setting up environments 403
data types testing connections 405
MS/SQL databases and 411 DB2 Factory server 404
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
Index 735
eAnalysisCubeSizeLimit parameter 301, 518 eAnalysisShowHistogramIn3D
eAnalysisDecimalPoint parameter 302, 518 parameter 302, 519
eAnalysisDisableMeasuresTotal eAnalysisShowHistogramPercent
parameter 306, 520 parameter 303, 519
eAnalysisHideCalculate parameter 308, 522 eAnalysisShowHistogramValues
eAnalysisHideHelp parameter 308, 522 parameter 303, 519
eAnalysisHideHome parameter 308, 522 eAnalysisShowLineLabels parameter 303,
eAnalysisHideHorizontalBarChart 519
parameter 308, 522 eAnalysisShowLinePercent parameter 303,
eAnalysisHideHorizontalFitToPage 519
parameter 309, 522 eAnalysisShowLineValues parameter 303,
eAnalysisHideLineGraph parameter 309, 522 519
eAnalysisHidePieChart parameter 309, 522 eAnalysisShowPieChartIn3D parameter 304,
eAnalysisHidePreferences parameter 309, 519
523 eAnalysisShowPieChartLabels
eAnalysisHidePrint parameter 309, 523 parameter 304, 520
eAnalysisHideSave parameter 309, 523 eAnalysisShowPieChartPercent
eAnalysisHideSaveAsMicrosoftExcel parameter 305, 520
parameter 309, 523 eAnalysisShowPieChartValues
eAnalysisHideSaveAsMicrosoftWord parameter 305, 520
parameter 309, 523 eAnalysisShowRowLevels parameter 306,
eAnalysisHideTableView parameter 309, 523 521
eAnalysisHideVerticalBarChart eAnalysisShowRowTotalLeading
parameter 309, 523 parameter 306, 521
eAnalysisHideVerticalFitToPage eAnalysisShowRowTotals parameter 306,
parameter 310, 523 521
eAnalysisHideWorkOffline parameter 310, eAnalysisShowZeroColumns parameter 307,
523 521
eAnalysisHorizontalAxisColor eAnalysisShowZeroRows parameter 307, 521
parameter 306, 520 eAnalysisShowZeroVariables parameter 307,
eAnalysisMainTitle parameter 301, 518 521
eAnalysisPathJSPRC parameter 302, 518 eAnalysisSortDimension parameter 307, 522
eAnalysisPieChartCombineMinimum eAnalysisVerticalAxisColor parameter 307,
parameter 304, 519 522
eAnalysisShowColumnLevels eAnalysisWatermark parameter 301, 518
parameter 306, 520 eAnalysisWindowTitle parameter 301, 518
eAnalysisShowColumnTotals parameter 306, –echannels option (acexport) 442
520 editors 407
eAnalysisShowColumnTotalsLeading –ef option (acexport) 443
parameter 306, 520 –efiles option (acexport) 443
eAnalysisShowDrillControls parameter 306, –efiletypes option (acexport) 442
521 –egroups option (acexport) 443
eAnalysisShowEmptyColumns –eprinters option (acexport) 443
parameter 307, 521 EiiLogEnabled parameter 480
eAnalysisShowEmptyRows parameter 307, EiiLogLevel parameter 480
521 EJB data sources 716, 717
eAnalysisShowGridLines parameter 307, 521 –ejobs option (acexport) 444
Index 737
Encyclopedia volumes (continued) securing 106, 574, 615
creating from import utility 449 sending requests to 5
creating multiple 176 setting autoarchive rules 677, 680
defining file types for 275 setting buffer pool for 277
determining buffer pool size for 94 setting parameters for 347, 351, 363
determining number of licenses for 10 setting printer properties for 647
disabling job notices for 45 setting properties for 566
displaying information for 338 setting up user accounts for 575
displaying items in 98 specifying buffer pool size for 95
displaying list of 147 specifying default setup for 338
displaying primary 276 specifying system default 209
displaying properties for 346 stand-alone configurations and 13
exporting information only 441 storing data for 4, 20
exporting objects 440 storing user information for 22
failing 169, 170, 280, 353 structuring 136
failover policy for 354, 356 synchronizing cache with 101
file types supported 13, 196 taking offline 87, 345
filtering data in 564–566 temporary reports and 5
Formula One reports in 51 updating 88, 124
generating documents for xxiv upgrading 458
importing administrative information 447 validating 463
importing/exporting data for 123 viewing available partitions for 330, 333,
installing example archive driver for 71 362
integrating external security sources viewing bundled reports and 82
with 124, 125 End User Desktop xxiii
limiting number of objects in 83 enhancements 10
logging in to 100, 110, 556 enterprise reporting xix, xxi, xxii
managing content 4, 22, 96, 554, 557 ENU locales 44
managing notifications for 86 environment variables
managing remotely 4 configuring Formula One 50
mapping administration information 110– DB2 databases and 403
112 defining for database connections 402
moving 20, 87, 372, 373 Informix databases and 406
naming 345 installing archive driver with 71
open server applications and 689 MS/SQL databases and 410
optimizing performance for 82–90 Oracle databases and 420
overview 338, 339 overview 547
partitioning 20–21, 330 Progress9 databases and 423, 426, 427
putting online 345 Red Brick databases and 415
read or write failures and 174 setting 548
registering e-mail accounts for 56, 57, 58 shared library search paths and 34
removing 20, 374–375 Sybase databases and 432
resetting defaults 570–656 system vs. user 402
restoring 88, 371, 456 –erequests option (acexport) 444
restructuring 82–85 error codes 233
running multiple 20, 22 error log configurations 232
searching 560–564 error log consolidator application 190
Index 739
external security sources (continued) failover
running sample application for 106 file system failures and 172–175
storing user properties 618 setting up cluster master 209
external user registration 591 setting up Encyclopedia 354
externalized Encyclopedia volumes 123 setting up iServer node 174
externalized fonts 70 setting up system 172
externalizing user information 22 failover nodes 20
failover service 20, 278, 279
F Failover Volumes page 279
Factory logs 217 FailoverIOFailureDelay parameter 254, 473
Factory process FailoverRetryPeriod parameter 254, 473
adjusting timing for 93 FailureJobExpiration parameter 494
binding to specific CPUs 73, 77 failureMessage element 62
changing configurations and 38 FailureNoticeExpirationAttr parameter 118,
configuring 92 127
CPU management and 91 FailureNoticeExpirationDefault
executing requests and 5 parameter 118, 127
file system I/O and 88 failures
generating reports and 44 assigning backup servers for 354
getting font information for 44 configuring restart parameter for 40, 41
memory usage and 94 creating failover service for 20
optimizing 92 default configurations and 17
resource groups and 8, 96 file systems and 172
restarting 95 transaction logs and 88
running 91, 92 Fatal DiskSpace Level parameter 41
setting default locales for 44 fctsrvr6 server 435
setting up resource groups for 45 fetching data 424
Factory server installations FetchRowBufferCount property 424
ODBC data sources and 412 file attributes 181
Red Brick databases 416 File Caching parameters 295
UNIX-specific platforms 434 file dependencies
Factory service archive drivers and 72
defining file types for 275 export utilities and 441
enabling 262 import utilities and 449
managing 165 preserving 182
overview 5 file descriptors (UNIX) 34
processing requests and 5 file directory 137
setting parameters for 270, 288 file name extensions 691
setting properties 267–274 file names 37
Factory Service page 267 file system directory 20
FactoryIdleTimeout parameter 293, 531 file system failures 172
factsrvr database 434 file system I/O 87
factsrvr.redbrick 416 File type attribute 218
Fail over option 326 file types
failed job notices 46, 118 Actuate 13
failed jobs 60, 652 Actuate Analytics 706
failed state 153 Crystal reports 700
information objects 196
Index 741
fonts (continued) spreadsheets 266
shipped with iServer 66 temporary reports 5, 262, 268
specifying dynamic text control 44 generation events (reports) 221
fonts.supported directory 66 generation jobs 5
FontUsedForSearchResultToExcel generation options (reports) 46, 47, 656
parameter 313, 527 generation requests
fontutils (UNIX) 466, 467 memory usage and 94
–force option (acimport) 452 tracking 648
–force option (acupgrade) 461 GenerationLogEnabled parameter 477
–forceGroup option (acintern) 455 GenerationLogLevel parameter 477
–forceRole option (acintern) 455 Global Search Path for Files used
–forceUser option (acintern) 455 parameter 38
formats grace periods 358
predefined locales and 54 grant privilege 577
specifying output 656 granting privileges. See privileges
variable length text and 45 graph controls 68
formatting graphics
e-mail messages 62 displaying in PDF files 81
Formula One e.Report Designer xxvii increasing resolution for 81
Formula One e.Report Engine xxvii graphics files. See image files
Formula One e.Report Engine Option xxvi greeting attribute 241
Formula One e.Report Option (licensing) 12 Greeting parameter 546
Formula One e.Spreadsheet Engine xxvii GROUP_BASE_DN parameter 126
Formula One reports GROUP_OBJECT parameter 126
configuring 50–52, 717 GROUP_TO_NOTIFY parameter 126
managing 715–720 GroupBaseDN parameter 112, 126
free disk space 41, 87, 342, 348, 363, 498 GroupObject parameter 112, 126
Fully Editable RTF formats 656 Groups page 595
functions groups. See notification groups; resource
date conversions and 55 groups
DB2 databases and 403 GroupToNotify parameter 113, 126
fundamental data types. See data types GZIP-compressed DHTML format 81
G H
garbled data 413 –H option (acextern) 446
General page (New Security Role) 605 –H option (acintern) 455
General page (New Users) 592 –H option (acmode) 456
generating hardware devices 28
DHTML reports 719 headlines 64, 637
e.Spreadsheet reports xxvi heap 47
HTML reports 719 heartbeat
log files 96 monitoring responses and 163, 178, 208
open server reports 52, 54 setting for cluster nodes 163, 178
PDF files 97, 99, 716 Heartbeat failure period field 163, 178, 208
Record Matcher files 667 Heartbeat send period field 163, 178, 208
report object instance files 652 HeartbeatFailurePeriod parameter 473
reports xxiv, 44, 87, 91 HeartbeatSendPeriod parameter 473
Index 743
ICU_DATA environment variable retrieving data from 5
acacfconvert utility and 438 retrieving data with 198
acexport utility and 440 setting parameters for 664, 665
acextern utility and 446 updating cache 669
acimport utility and 448 Informix Connect 407
acintern utility and 454 Informix databases
acmode utility and 456 connecting to 405–408
actoc utility and 457 determining version 407, 408
acupgrade utility and 460 ODBC drivers and 412
acverify utility and 464 setting up locales for 406
setting 550 Informix ESQL utility 407
–if option (acimport) 451 INFORMIXDIR variable 406, 550
–ifiletypes option (acimport) 450 INFORMIXSERVER variable 406, 550
–igroups option (acimport) 450 Inherits the Desktop and Window Station
–ijobs option (acimport) 452 parameter 52
image files –input option (acafcconvert) 438
creating for PDF files 81 –input option (acimport) 452
setting search paths for 38 –input option (actoc) 458
images input
adding to channels 632 disk write operations and 87, 91
displaying in PDF files 81 optimizing 89
increasing resolution for 81 input files
import utilities 447 exporting 441
importing importing 450
administrative information 447 input parameters 425
data 123, 448, 449 insert element 63
inactive partitions 21 installation
index (online documentation) xxxiv Actuate HTTP server 107
indexed searches 81, 122 custom login applications 104
information application platform xx example archive driver 71
Information Delivery API xxv, 5, 6, 22, 23 Factory servers 412, 416, 434
information delivery solutions xxii iServer 6, 29
information delivery systems xxi Java SDK 47, 48, 50
information object cache definition files 196 Management Console 4, 22, 40
Information Object Caching Option online documentation xxxiv
(licensing) 12 portmapper services 30
information objects xxiv PostScript fonts 466–467
caching 193, 658, 662 Record Matcher 200
caching service for 6 Record Matcher applications 200
copying cache for 666 RSSE application 106
creating cache for 663, 664 RSSE web service 108
deleting cache 667 security application 106
enabling cache for 665, 666 stand-alone servers 135
file types for 195 system printers 646
integration service for 6 installation scripts (UNIX) 406
overview 662 INSTHOME variable 550
querying 5
Index 745
iServer (continued) isql program 433
setting up Formula One environments isqlw program 410
for 50–52 –iusers option (acimport) 450
setting up open server environments
for 52–54 J
setting up ports for 35, 134 jar directory 47
setting up processes for 44–46, 99, 100 jar files 47, 49, 718
starting 16, 39 Java 2 Standard Edition (J2SE) 49, 50
stopping 154 Java applications 716
system states for 153, 168 Java Database Connectivity. See JDBC
temporary reports and 5 Java files 47
tracking object relationships 83 Java Naming and Directory Interface
viewing available partitions for 330, 333 (JNDI) 717
iServer Integration Technology xxv, 72, 105 Java Native Interface (JNI) 51
iServer System xxiv, xxv Java Object Interface page 322
accessing resources 32–34 Java objects xxvii, 51
adding printers for 395, 396 Java report documents 4
administrative tasks for 132–133 Java Report Generation option 715
changing diagnostic logs for 286 Java Runtime Environment (JRE)
changing licensing information for 247 caution for earlier releases 48
changing properties for 160 changing 48
configuration options for 9 upgrading 47
controlling jobs for 652 Java Software Development Kit (SDK) 47, 48,
displaying information about 151 50
displaying licensing information 246 Java tools xxvii
displaying properties 206, 284, 364 Java Virtual Machine (JVM)
fonts shipped with 66 configuring for Formula One
installing Java SDK for 47, 48, 50 environments 51, 717
installing JRE for 47, 48 default fonts and 68
installing JVM for 47 default heap size for 47
job scheduling model for 652 running Formula One reports and 50
licensing options 9–13 JavaDataSourceLogLevel parameter 291, 530
managing 4 JavaScript files 300
monitoring 139, 163, 178, 208 JDBC data sources 716
output formats for 656 JDBC drivers 49
removing printers 398 JDK installations 423, 425
report generation options for 656 JDKHOME variable 423, 426
setting e-mail notification preferences JNDI client classes 717
for 343 Job name attribute 219
setting logging properties for 214, 231 Job priority attribute 219
specifying regional settings for 245 Job Schedules page 652
states listed 153, 168 Job type attribute 219
updating licenses for 247 jobCompletion value 64
validating licenses for 16 jobDetailedStatus value 64
viewing status 141, 143, 152 jobHeadline value 64
volume security capabilities for 574 jobName value 64
installing JVM for 51
Index 747
libjvm.a 50 locales
libjvm.sl 50 accessing multi-language databases 400
libjvm.so 50 changing default 44, 145
LIBPATH variable configuring defaults for 245
Formula One reports and 50 detecting character sets for 413
open server reports and 52 e.reporting solutions for xxi
UNIX environments and 34, 402, 550 getting client information for 401, 404
libraries installing fonts for 67
creating symbolic links to 404 naming conventions for 54
DB2 databases and 404 rendering charts for specific 68
Informix connections and 407 resetting Progress database 424, 426
location of archive 342, 350 setting database 406, 420
MS/SQL connections and 410 setting default 44, 54
open server reports and 52 specifying default 144
Oracle connections and 418, 419, 420 specifying time zones for 139, 144
Progress databases and 426 localized fonts 67, 68
Red Brick databases and 415 locating data. See searching
setting search paths for 34, 38 lock files 43
specifying archival 675 –log option (acverify) 464
specifying external 33, 34 log directory 137
specifying location of 718 log files
specifying open security 360 archiving reports and 72
library paths 550 command-line utilities 440, 448, 460
license file 246, 247 configuring diagnostic 284
License page 10, 247 examining sample usage 230
licensing information 10, 13, 247 generating 96
licensing options xxv, 9–248 optimizing transaction 88
Lightweight Directory Access Protocol. See setting properties for 286
LDAP setting up 139, 213
links xxxiv storing 137
links (Active Portal) 628 writing processor information to 77
links (Management Console) 630 Log in disabled option 593
Linux systems 400 Log on as service privilege 30
Listen port parameter 240 LogDirectory parameter 484, 486, 489, 517,
listeners 421 529
load balancing 14, 96, 242, 400 logging
load balancing routers 19 archival information 72
load balancing service 6 diagnostic information 284, 285
load-balancing weights 237, 241 message errors 244
local configurations 29, 33 server errors 233
local database connections 425 system errors 231
local printers 32 system usage 214, 216, 230
locale maps 54, 55 transaction information 342, 348
Locale parameter 245 logging in to Encyclopedia 100, 110, 555
Locale setting 144 logging in to multiple volumes 556
localemap.xml 54, 55 logging levels 233
LoggingOn parameter 484, 486, 491, 517, 529
Index 749
MaxFileCacheSizePerProcess parameter 296, Message Distribution IP Address
511 property 263
Maximum Cached Sessions Per Process Message Distribution Port property 263
setting 101 Message Distribution service
Maximum File Cache Size Per Process adding multiple cluster nodes and 16
setting 101 cluster configurations and 9, 23
Maximum Heap Size setting 47 communications protocol for 19
Maximum Number of File Descriptors enabling 16, 19, 161, 262
settings (UNIX) 34, 35 managing 165
Maximum Number of Worker Threads overview 5
setting 99 printing requests and 5
Maximum Timeout for Cached ROX Files setting IP addresses for 167
setting 101 setting parameters for 264
Maximum Total Size of Cached ROX Files setting properties 263
setting 101 temporary jobs and 5
MaximumStringLength property 418, 431 Message Distribution Service page 263
MaxJobPriorityAttr parameter 119, 127 message routing 19, 22
MaxJobPriorityDefault parameter 120, 127 Message too large error 244
MaxMailMessageSize parameter 239, 474 messages
MaxMailRecipients parameter 242, 255, 475 See also e-mail; notifications
MaxPagesConvertibleToExcel parameter 524 formatting e-mail 62
MaxPriority parameter 544 logging archival 72
MaxProcesses parameter 526 sending CPU licensing 78
MaxQueryInputRows parameter 484 shutdown 77
MaxQueryMemory parameter 484 messaging protocol 6
MaxQueryRunTime parameter 484 metadata 20, 88, 95, 136
MaxROXCacheSizePerFactory metadata directories 136
parameter 530 –mf option (acimport) 451
MaxROXCacheSizePerProcess Microsoft Active Directory servers 104
parameter 515 Microsoft Analysis Services data cube 707
MaxROXCacheSizeTimeout parameter 515 Microsoft Analytic Services parameters 709
MaxSoapEndpointThreads parameter 37 Microsoft Exchange 29, 56, 57, 58, 243
MaxSyncJobRuntime parameter 532 Microsoft Internet Explorer. See Internet
MaxThreads parameter 484, 486 Explorer
MaxThreadsPerProcess parameter 312, 527 Microsoft SQL databases. See MS/SQL
MaxUserPort 93 databases
MaxVarLen argument 408, 413, 422 Microsoft SQL Server 409, 411, 414, 661
memory Min view processes property 265
adding additional 91 MinFreeSpaceMB parameter 508
allocating 94–95 Minimum Partition Disk Space setting 41
determining e.reporting usage for 94 MinPriority parameter 545
image resolution and 81 MinProcesses parameter 526
report generation and 91 Modify Start Parameters option 177
setting buffer pool size for 88 monitoring disk space 87
tracking 95 monitoring iServer System 139, 163, 178, 208
memory blocks 94 monitoring resources 95
menus 558
Index 751
notification templates 343, 350 creating view session 100, 101
NotificationConfigPartition parameter 497 tracking relationships among 83
notifications ociw32.dll 420
See also notification groups ODA drivers xxiv, 661
adding headlines 637 odaconfig.xml 433
customizing e-mail 60–65 ODBC data sources
deleting 342, 348 connecting to 400, 411–416
disabling 45, 46 iServer accounts and 29
displaying purging settings for 679 non-administrator accounts and 31, 32
formatting e-mail 62 ODBC databases 413
load-balancing for 242–243 ODBC driver managers 413
managing 86 ODBC drivers
purging 677 configuring Red Brick 415, 416
reducing number of persistent 86 running DataDirect Connect 411
sending 86, 637 running PeopleSoft 414
setting options for 343, 593 SQL servers and 411
setting properties for 678 ODBC interface 414
setting up e-mail 55–60, 237, 593 ODBC Server 411
setting up open server 116, 117, 118 odbc.ini 412, 413, 416
testing e-mail 57, 59 offline backups 683
notificationTemplate element 62 offline state 153, 168
ntext message can’t be sent error 411 offline systems 155
NTWDBLIB MS/SQL library 410 –oldhome option (acupgrade) 461
Number of Copies setting 54 OLE Automation software 29
Number of Requests Before Recycling Online Archive application 11
Processes setting 95 online archive application 182
Number of RPC sockets setting 324 Online Archive Option (licensing) 11
Number of sockets for reply setting 325 online backup 554, 683–685
NumberOfErrorLogFiles parameter 251, 483 Online Backup Schedule page 685
NumberOfPagesGenerated attribute 217 online backup utilities 87, 456
NumberOfPagesPrinted attribute 217 online documentation xxxi, xxxiii, xxxiv,
NumberOfPagesViewed attribute 217 xxxvi, xxxvii
NumberOfUsageLogFiles parameter 250, 481 overview xxviii
NumLogs parameter 485, 486, 490, 518, 529 online help xxxiii, xxxiv–xxxvi
NumRequestRetries parameter 290, 370, 506 online reports. See reports
NumSocketsForReply parameter 492 online state 153, 168
NumSocketsForRPC parameter 492 online systems 153
NWPPort parameter 314, 484, 485 Open Client mechanism 430
Open Data Access driver 433
O Open Data Access Framework xxiv
Object attribute 219 open database connectivity. See ODBC
object cache definition files 663 open security applications
ObjectArchiveDLL parameter 495 caching external information for 107
–objects option (actoc) 458 centralizing user information in 22
objects configuring 109–112
accessing Java 51 configuring for LDAP servers 121
Index 753
P Partition field 209
Partition Name parameter 281
–P option (acmode) 456 Partition Path parameter 281
page buffer pool 88, 355 partitioning Encyclopedia volumes 20–21,
resource requirements for 94 330
page caching options 703 partitions
Page Level Security Option xxvi, 13 accessing 167
page-level security xxvi adding 331–332
administrative tasks for 554 as secondary storage device 332
assigning to clusters 176 assigning 176, 331, 339, 362
enabling 615 assigning volumes to 341
overview 105, 614–616 changing locations for 374
paging rate 94 changing paths for 334
paging resource requirements 94 changing state 362
parameter values files. See report object value changing transaction log 89
files checking disk space for 41, 498
parameterized queries. See stored procedures configuring 20, 330–331
parameters creating multiple 137
adding to configuration files 110 defining paths for 333
assigning values 206 displaying information for 330, 333
changing resource group 275, 386, 388 displaying system 150
changing startup 177 Encyclopedia performance and 87
configuring disk space and 363 importing data and multiple 448
Crystal reports and 701 moving 372
displaying Encyclopedia volume 346 moving files among 21
Excel output and 38 naming 332
setting Caching service 271, 272, 273, 313, primary vs. secondary 136
660, 670 reconfiguring 21
setting Chart Server 319 removing 20, 21, 335–336
setting configuration 470 setting properties for 280, 341
setting e.Spreadsheet report 290, 291, 711 setting up iServer 281
setting Encyclopedia volume 347, 351, 363 specifying 32, 209
setting Factory service 270, 288 storing e-mail templates in 343, 350
setting Formula One report 717, 719 taking offline 336
setting general 262 testing accessibility 333
setting information object 664, 665 viewing information for 149
setting language 68 viewing state 330
setting Message Distribution service 264 Partitions page (Options) 149
setting open security 112, 121, 360 Partitions page (Servers Properties) 280
setting open server 692 Partitions page (System) 330
setting output 718 Partitions page (Volumes Properties) 362, 372
setting printer 282, 283, 395, 397 –P option (consolidator) 192
setting resource group 275, 383, 385, 389 –password option (acafcconvert) 438
setting system 208, 287 –password option (acimport) 452
setting View service 267, 294 –password option (acupgrade) 462
SQRIBE reports and 700 password attribute 110
Parent Roles page 605 Password property 424
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
Index 757
properties (continued) R
displaying set of values for 158
displaying system 206, 284, 364 RAID devices 89
leaving blank 566 RAM 94
open security mappings for user 110 rb_client utility 416
open server applications and 623 RB_CONFIG variable 415
resetting notification group 641 RB_PATH variable 415
setting for multiple items 566 –rbf option (acexport) 443
setting log 286 Rc.local 406
setting notification 678 RDBMS servers 13, 14
setting output 657 read failures 173, 174
setting partition 280, 341 read privilege 576, 615
setting printer 281, 283, 397, 646, 647 readers 617
setting resource group 383, 386 read-only data 101
setting server 156, 260, 283 ReadOnlyQuery property 424
setting service 263, 264, 267 rebooting systems 17, 39
setting SMTP e-mail server 239 reconfiguring clusters 16
storing in external security sources 618 Record Matcher 667–669
updating notification group 225 Record Matcher application
updating role 224 running information objects and 195
Properties command 598, 612 Record Matcher applications
Properties page (Printers) 396 administrative tasks for 658
Properties page (Resource Groups) 386 Caching service database and 199
property lists 158 configuring 200
publishing spreadsheets 49 creating 197
purging notifications 677 installing 200
purging scheduled jobs 341, 348 limitations for 204
purging settings 678, 679 merging data and 198
push technology 628 overview 201
running transactions for 202
Q Record Matcher cache 197, 198, 202
Record Matcher Connection page 659
queries Record Matcher database 194, 203, 204
date conversions for 55 Record Matcher definition files 196
executing on LDAP servers 113, 122 Record Matcher Framework 197, 198, 200
information objects and 5 Record Matcher Option (licensing) 13
parameterized. See stored procedures records
running xxvii filtering 564
setting row buffer size 424 setting buffer size for 424
Query Generation parameters 288 Recycle Processes parameter 95
Query Option xxvii, 11 Red Brick databases
QUERY_ACCOUNT parameter 126 connecting to 415–416
QUERY_PASSWORD parameter 126 installing Factory server for 416
QueryAccount parameter 113, 126 testing connections 416
QueryPassword parameter 114, 126 RedCloud enhancements 123
queue 270 redirector nodes 19
reducing number of persistent notices 86
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
Index 761
roles (continued) RSSE library applications
importing 449 configuring as multithread safe 361
managing 591 RSSE library name property 360
nesting 97, 111 RSSE max ACL buffer size property 361
open security mappings for 111 RSSE multithread safe property 361
removing privileges from 583 RSSE web service
removing users 607, 611 configuring 108, 126
resetting properties 607, 609, 610 installing 106
updating properties for 224 RSSE web service configuration
Roles page 594 information 108
root directory 137 RSSECacheTimeout parameter 501
routers 14 RSSECommandLineStart parameter 368, 504
.rov files. See report object value files RSSEContextString parameter 503
parameter values files. See report object value RSSEIPAddress parameter 503
files RSSELibrary parameter 502
rows 424, 564 RSSEMaxACLBufferSize parameter 502
.rox files. See report object executable files RSSEMultiThreadSafeLibrary parameter 502
.rpt files 700 RSSESoapPort parameter 503
RSAPI page 311 –rssevol option (acafcconvert) 439
RSAPIFetchLimit parameter 369, 504 –rssevol option (acupgrade) 462
–RSSE option (acacfconvert) 439 RTF files 45
–RSSE option (acextern) 125, 447 RTF formats 45, 656
–RSSE option (acintern) 455 rules 614
–rsse option (acupgrade) 462 Run as services access 30
RSSE applications run time environments 718
See also Report Server Security Extension running Actuate Basic reports 31, 384
accessing external sources and 31, 107, 124 running Formula One reports 719
changing volume security for 446, 454 running multiple View processes 99, 100
creating 104, 105, 615, 620 running sample applications 105
enabling open security with 106–108
external user registration and 619, 621 S
externally defined roles and 620 –S option (consolidator) 192
importing data and 123 –Port option (acmode) 456
installing sample 106 sample applications
integrating with Encyclopedia 107 installing as web service 106
interfacing with external security running open security 105
sources 616 sample RSSE applications 590
overview 590, 618 SAN devices 89
running 104 SAP Business Warehouse 427
running open security utilities for 124–126 SAP BW Data Connector Option 11
running sample 105 SAP data sources 427–430
updating volume information for 124 SAP JCO libraries 428
validating volume information with 125 SAP MetaData Interface 429
RSSE Cache Timeout parameter 108 SAP native connector parameter 290
RSSE cache timeout property 360 SAP R/3 Data Connector Option 12
RSSE interfaces 360 SAP R/3 data sources 427
Index 763
Send e-mail notification option 593 displaying assigned 145
SendEmailAttr parameter 117, 127 displaying current status 146, 148
SendEmailDefault parameter 118, 127 displaying properties 165, 260–262
Sender e-mail address parameter 240 e.reporting solutions for xxii, xxiii, xxv
Sender ID cache 101 enabling services for 16, 165
Sender name setting 240 getting system information for 258
SenderAddress parameter 546 installing Management Console on 4, 22,
SenderName parameter 547 40
sending completion notices 86 logging errors for 233
sending mail 55–60 managing clusters for xxiv, 176
See also e-mail managing multiple SMTP 237, 240
sendmail client 56 resetting iServer ports for 134
sendmail program 59, 243 restarting stand-alone 40, 41
SendNoticeAttr parameter 119, 127 running from clusters 168–171
SendNoticeDefault parameter 119, 127 running View process for 98
–server option (acextern) 447 setting IP addresses for 134, 167
–server option (acintern) 455 setting iServer ports for 35
–server option (acverify) 465 setting properties for 156, 260, 283
Server Assignments page 355, 390 shutting down 168
server cluster master. See cluster master specifying as backup cluster master 210
server nodes. See cluster nodes; clusters specifying SQL-specific 409
SERVER parameter (RSSE library) 126 starting stand-alone 39
Server parameter (RSSE web service) 114, streaming zipped files to 81
126 viewing primary Encyclopedia volume
Server Settings page (Partitions) 333, 334 for 276
server-based reporting xxiii Servers page (Options) 145
ServerIPAddress parameter 492 Servers page (Properties) 165, 259, 260, 261
ServerList parameter 498 Servers page (System Administration) 168,
ServerName attribute 218, 234 169
servers ServerSOAPPort parameter 492
See also iServer ServerSOAPPortBase parameter 493
accessing remote 28 ServerSOAPPortCount parameter 493
adding to clusters 92, 164, 164–167 ServerURL parameter 367, 500
administrative tasks for 132, 133 serverURL parameter 141
allocating resources for 91 service aids 96
assigning as backup 279, 354–356 Service property 424
assigning to volumes 278 ServiceName attribute 234
changing properties 287 services
communications protocol for 19 See also specific service
configuring Formula One reports for 717 changing properties for 259
configuring multiple report 9 cluster configurations and 18
configuring stand-alone 6, 9, 13, 16 configuring server-specific 261
converting output and 657 controlling 547
crash recovery for 17, 40, 41 crash recovery for 17
creating clusters for 9, 162, 163 creating failover 20
creating stand-alone 135 disabling 9, 19
designating partition space for 280, 281 distributing requests to 20
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
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
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
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
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