System Administration Guide - OpenText

BIRT iHub secure communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34Understanding HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35Understanding SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35BIRT iHub SSL communication process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36BIRT iHub SSL support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36Understanding SAML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37SAML communication process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37BIRT iHub SAML support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38Using SSL with IDAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38Using SSL with JSAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39Using SSL and external user management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40Using Visualization Platform with SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40Using SSL for communication with the volume metadata database . . . . . . . . . . . . . . . . . . . .49Managing SSL files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52Using a commercial SSL certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54Part 2BIRT iHub System ConsoleChapter 5Understanding System Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1About System Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2Viewing clusters, nodes, and system administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3Logging in to System Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3Using the System Console configuration user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4About Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8Chapter 6Managing clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11About clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12Creating and configuring a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13About the cluster configuration categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14Adding cluster nodes to a cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15Understanding Cluster Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26Performing management tasks for the entire cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26Performing management tasks for an individual cluster node . . . . . . . . . . . . . . . . . . . . . . .27Performing management tasks for a service running on a cluster node . . . . . . . . . . . . . . .28Adding a volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31Adding or updating a storage location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35Understanding the volume menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36Selecting the metadata database type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37Configuring alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40ii

Viewing the list of alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Adding an alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Enabling e-mail notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Editing, deleting, disabling, and enabling an alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Configuring Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Configuring User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Configuring LDAP Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Configuring RSSE SOAP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Updating the license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .About Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Editing an existing cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Managing a cluster node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Viewing the list of clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Filtering the list of clusters using a search string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Filtering non-starred clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Deleting clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Viewing cluster resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Viewing diagnostic log files using Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Viewing system-level information using Trends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .About the Actuate Viewer menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Viewing Current Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Using the ControlConsole utility to free memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .About BIRT iHub service and resource group properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Reporting service template properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Viewing service template properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Integration service Template properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Understanding resource groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Understanding resource group properties pertaining to a template . . . . . . . . . . . . . . . . . . . .Understanding resource group properties pertaining to all templates . . . . . . . . . . . . . . . . . .Configuring data source connections in BIRT iHub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Configuring an Apache web server for load balancing and proxying . . . . . . . . . . . . . . . . . . . . 6888889939495Chapter 7Managing system administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99About Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Viewing System Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Working with system administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Creating a system administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Customizing the notification e-mail template file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Editing a system administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Deleting system administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Configuring Email Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .iii100100101101103104104106

Part 3Managing and backing upChapter 8Licensing BIRT iHub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Understanding licensing types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Understanding licensing options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Installing BIRT iHub System license files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114About the license file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Collecting machine information for a license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116About modifying a license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119About modifying the data collection option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Understanding CPU binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Configuring CPU binding on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120Binding to specific CPU cores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120Binding to multiple-core CPU cores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Binding an Actuate process to a processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121About processors and hyperthreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Configuring CPU binding on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Checking BIRT iHub bound processors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124Determining the number of processors BIRT iHub System uses . . . . . . . . . . . . . . . . . . . .124Understanding CPU binding validation while BIRT iHub is running . . . . . . . . . . . . . . . . 125Understanding CPU binding validation when a volume comes online . . . . . . . . . . . . . .126Understanding CPU binding validation when running BIRT iHub processes . . . . . . . . .126Configuring e-mail for CPU license problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126Chapter 9Backing up BIRT iHub System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Performing a BIRT iHub System backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Managing the backup and recovery of BIRT iHub metadata and data files . . . . . . . . . . . . . 130Using RDBMS and file system backup utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131Backing up and restoring a BIRT iHub System that uses a PostgreSQL database . . . . . . . . . . . 132Backing up BIRT iHub System using pg dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133Restoring BIRT iHub System using pg restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137iv

Ab ou t B I RT i H u bSy st em Adm i nis tr atio nG ui deBIRT iHub System Administration Guide includes the following chapters: About BIRT iHub System Administration Guide. Provides an overview of thisguide, Actuate BIRT iServer documentation, and the typographicalconventions in this book. Part 1. Architecture and configuration. Describes BIRT iHub architecture andcustomizing the set-up of BIRT iHub. Chapter 1. Understanding Actuate BIRT iHub architecture. Describes BIRT iHubarchitecture, the iHub System process model, and system administration,including new utilities and third-party relational database managementsystems (RDBMS) used to store iHub system and volume metadata. Chapter 2. Configuring a BIRT iHub cluster. Describes how to set up a BIRT iHubcluster node in a Windows environment. Chapter 3. Configuring BIRT iHub to use an alternative database. If you want toconfigure BIRT iHub to use a pre-existing PostgreSQL or Oracle databaseinstead of the out-of-the-box PostgreSQL database, contact Actuate Support. Chapter 4. Configuring BIRT iHub security. Explains how to secure data in aBIRT iHub volume, BIRT iHub secure communications, and how to use SSL. Part 2. BIRT iHub System Console. Describes how to use BIRT iHub SystemConsole. Chapter 5. Understanding System Console. Introduces BIRT iHub SystemConsole. Chapter 6. Managing clusters. Describes creating, configuring, and managing aBIRT iHub cluster. Describes BIRT iHub cluster monitoring features.About BIRT iHub System Administration Guidev

vi Chapter 7. Managing system administrators. Describes creating and working withSystem administrators. Part 3. Managing and backing up. Describes licensing, backup, and utilities. Chapter 8. Licensing BIRT iHub. Describes licensing options, license keyinstallation, and CPU-binding policies for BIRT iHub. Chapter 9. Backing up BIRT iHub System. Describes how to back up and restoreBIRT iHub volume metadata and data.BIRT iHub System Administration Guide

PartOne1Architecture and configurationPart 1

Chapter1Understanding ActuateBIRT iHub architectureChapter 1This chapter contains the following topics: Understanding BIRT iHub architecture Understanding the BIRT iHub process model iHub security overview Administering BIRT iHub SystemChapter 1, Understanding Actuate BIRT iHub architecture3

Understanding BIRT iHub architectureActuate BIRT iHub stores metadata containing information about the cluster andvolume configurations in a relational database management system (RDBMS). Inthe default configuration, Actuate BIRT iHub uses the open-source, third-partydatabase, PostgreSQL. iHub also supports using other alternative, third-partydatabase systems, such as Oracle or a pre-existing PostgreSQL instance.iHub stores metadata in the following schemas: ClusterContains settings related to BIRT iHub configuration, such as nodes,templates, volumes, users, and roles. VolumeContains settings related to volume configuration, such as folders, files, andother objects.Using a third-party RDBMS with BIRT iHub systemActuate installs BIRT iHub cluster and volume schemas in the defaultPostgreSQL RDBMS installation. Installing the schemas in a pre-existingPostgreSQL RDBMS or alternative RDBMS, such as Oracle, requires running aSQL script containing the appropriate Data Definition Language (DDL)statements and switching to the alternative RDBMS. Following sections of thisbook provide detailed, step-by-step instructions on how to perform theseoperations.Only the metadata that specifies the cluster and volume configuration are in thedatabase. Designs, documents, and other data objects are stored in the file system.About the cluster and volume schemasActuate supports read-only operations on the cluster and volume metadatastored in the tables of the OOTB or other third-party database. Actuate does notsupport the addition, deletion, or modification of these metadata tables.Actuate does permit the creation of additional indexes on these tables. Forexample, a customer can create an index on the job completion notices table toexpedite database processing.Actuate does not recommend any customization of the cluster schema. Anycustomization that the customer does on the volume schema must be redonewhen migrating to or reinstalling BIRT iHub. BIRT iHub does not track anydatabase objects that a customer creates. Actuate reserves the right to change thestructure of the schemas in future releases.4BIRT iHub System Administration Guide

Managing backup, recovery, and failoverThe BIRT iHub administrator uses third-party RDBMS tools to manage thebackup, recovery, and failover capabilities of the cluster and volume metadatadatabase. The administrator uses standard operating system or other third-partytools to manage the backup and recovery of the data files.The third-party database schemas that contain cluster and volume metadata arecritical components of a BIRT iHub system. To guard against data loss, thedatabase administrator must back up the cluster and volume schemas and allrelated file data to ensure recoverability in the event of failure. Please consultActuate Support at the time of installation if you have any questions about thebackup, recovery, or failover procedures necessary to protect a BIRT iHub systemagainst the possibility of catastrophic failure.For more information on backing up an BIRT iHub installation, see Chapter 9,“Backing up BIRT iHub System,” later in this book.In BIRT iHub, there is no concept of volume failover, since each node in a clustercan operate on all the volumes. Configuring cluster and volume database failoveris the responsibility of the third-party RDBMS administrator. The databaseadministrator must use the facilities available in the RDBMS to configure thisfailover capability. Consult the third-party RDBMS documentation for detailedinformation on how to use native system tools to configure backup, recovery, andfailover operations for the externally managed cluster and volume database.Documentation for a PostgreSQL RDBMS is available at:http://www.postgresql.org/docsDocumentation for an Oracle RDBMS is available ng the BIRT iHub process modelThe Actuate BIRT iHub platform uses a multi-threaded, multi-process model,running single instances of the following components on each iHub node: iHub servlet containerProvides the run-time environment for client applications, such as BIRT iHubSystem and Visualization Platform. Client applications communicate withBIRT iHub System using SOAP-based messaging. Process Management Daemon (PMD)Distributes service requests among available BIRT iHub services and nodes.Chapter 1, Understanding Actuate BIRT iHub architecture5

In addition, the BIRT iHub platform supports multiple instances of the followingservices on each node: FactoryExecutes requests to generate documents and perform server-side printing. ViewSupports viewing documents in DHTML and other output formats, such asCSV and PDF. Handles requests to download files from a volume. Integration (Actuate Integration service or AIS)Coordinates the running of information object files that extract data frommultiple data sources.This loosely coupled BIRT iHub architecture model provides the followingmaintenance and performance benefits: Startup and shutdown of a BIRT iHub node is fast because it is independent ofthe RDBMS that manages a volume. The database server can remain onlinewhen shutting down a BIRT iHub node and is available when the node startsup. Controlling the sequence of a volume startup is not necessary. All volumes areeither already online in the database server or come online as the databaseserver starts. Downtime to apply a patch or diagnostic fix for a BIRT iHub node is reduced.The RDBMS d

About BIRT iHub System Administration Guidev About BIRT iHub System Administration Guide BIRT iHub System Administration Guide includes the following chapters: About BIRT iHub System Administration Guide. Provides an overview of this guide, Actuate BIRT iServer documentation, and the typographical conventions in this book. Part 1. Architecture .