Using the command-line installation package on Windows
The following sections describe how to use the command-line installer to install BIRT iHub modules on Windows. To use the installers for an individual BIRT iHub module, see Installing BIRT iHub modules on Windows.
To install the BIRT iHub command-line installation package, the administrator performs the following tasks:
Downloads the BIRT iHub 3 installation package, iHub3.zip, from the download site
Downloads the zip archive installation packages and associated MD5 files for the required BIRT iHub modules from the download site
Extracts the contents of the installation package into a directory such as C:\Actuate\iHub3
Reads the readme.txt file and updates the acinstall.properties file
Runs the install script, install.bat
The readme.txt file contains instructions about how to install the BIRT iHub product packages, as shown in Listing 2‑1. The instructions contain the following sections:
Using BIRT iHub Network Install
Lists the software components the command-line installation package can install, such as BIRT iHub, System Console and BIRT iHub Visualization Platform, Java Development Kit (JDK), PostgreSQL, Content Services, BIRT Analytics, and Metrics Management components.
Deployment Steps
Describes the deployment tasks required to extract and run install the BIRT iHub Release 3 installation package. By default, the installation script installs iHub, System Console, and BIRT iHub Visualization Platform on the local machine.
Properties
Describes the properties in the iHub3\acinstall.properties file.
Uninstalling Modules
Describes how to unregister or uninstall a module using the batch script uninstall.bat.
Listing 2‑1 BIRT iHub readme.txt
Using BIRT iHub Network Install
-------------------------------
Use the BIRT iHub network installation package to install:
a. System Console
b. BIRT iHub
c. Information Console
d. Metrics Management Server
e. Metrics Management SQL Server RDBMS
f. Metrics Management Web
g. Metrics Management Classic Web Client
h. Metrics Management All
i. BIRT Analytics Core
j. BIRT Analytics Web
k. BIRT Analytics All
l. BIRT iHub PostgreSQL Database
m. JDK
n. Content Services
Deployment Steps
----------------------
• Download iHub3.zip to your local machine.
• Extract iHub3.zip to a clean folder, such as C:\Actuate\iHub3.
• Open a command prompt with administrator privileges
• Go the directory where iHub3 package contents have been extracted
• Run iHub3/install.bat
The default installation installs the following product components:
• BIRT iHub with the out-of-the-box (OOTB) Postgres RDBMS for storing metadata
• BIRT iHub System and Information Consoles
• System Console
To install additional product components, open the iHub3/acinstall.properties file in a text editor. Add the corresponding alphabetic identifier for a component to the ac.package property list.
For example, change ac.package from:
ac.package=a,b
to:
ac.package=a,b,i,k,l
To get the full list of modules available for installation, open a command prompt and type:
install -list
Properties
-----------
iHub3/acinstall.properties contains the following properties:
• ac.login= (Modify the ac.login and ac.password properties to contain the login and password for the network machine that contains the Actuate BIRT product modules.)
• ac.password=
• ac.package=a,b (Default installation packages.)
• ac.homedir=. (Default installation folder.)
• ac.downloadonly=false (Set ac.download to true to download product modules only and have no installation take place.)
• ac.source= (Set ac.source to the network path of the installation modules. For example, //urup/Actuate/Install/iHub3/modules.)
• ac.runasservice=true (Set ac.runasservice to false to open command prompts for iHub server and Postgres services after installation is complete.)
• ac.acceptlicense=y (Leave ac.acceptlicense set to y to install using the evaluation license. After installation, the administrator can specify a purchased product license using System Console.)
Uninstalling Modules
----------------------
On Windows, Unregistering or uninstalling a module can done using the batch script uninstall.bat
• To get the list of modules that can be uninstalled use following command
uninstall.bat -list
• Using this script you can uninstall the following modules
For example: To unregister BIRT iHub installed under C:/install/iHub3
uninstall b C:/install/iHub3
If you have modules installed in default home location you do not need to specify path to iHub3 installation. Just use following command
uninstall b
The acinstall.properties file contains the following properties, as shown in Listing 2‑2:
The ac.login and ac.password properties contain the account login name and password for the network machine that contains the installable Actuate BIRT product modules.
The ac.package installation list contains the BIRT iHub modules to install. By default, the installation script installs options a and b, iHub with System Console and the embedded BIRT iHub Visualization Platform.
The ac.homedir property specifies the path to the installation files if you do not run the installation script from the directory to which you extracted the files.
The ac.downloadonly property specifies whether to download the product modules only and have no installation take place. Typically, leave this property at its default value, false, to install the modules.
The ac.source property specifies the network path of the installation modules.
The ac.runasservice property specifies whether to run BIRT iHub using Windows services. If the value of this property is true, ac.runasservice_username specifies the user name and ac.runasservice_password the user password for the account that runs the services. If these two properties are blank, BIRT iHub services run as the local system account. If the value of ac.runasservice is false, command prompt windows for iHub server and Postgres services open after installation is complete.
The value of ac.acceptlicense must be y to specify that you accept the software license terms. If this property is n, the BIRT iHub software installation does not proceed.
The ac.ihub_cluster_schema_name and ac.ihub_postgres_port properties specify the cluster schema name and PostgreSQL RDBMS port, if necessary.
All path settings use forward slash (/) for the file separators. Do not use Windows, backward-slash (\) notation.
Listing 2‑2 acinstall.properties
#Tue, 11 Jun 2013 16:19:16 -0700
ac.login=machine/actuate
ac.password=password
ac.package=a,b
ac.homedir=.
ac.downloadonly=false
#ac.source=.
ac.source=//machine/Actuate/Install/iHub3/modules
ac.runasservice=true
ac.runasservice_username=
ac.runasservice_password=
# By changing the value of the ac.acceptlicense parameter
# to “y” you agree to the terms of the license agreement
# in the file “license.pdf” located in the same folder as
# this parameter file.
ac.acceptlicense=y
#Advanced Settings
#ac.ihub_cluster_schema_name=
#ac.ihub_postgres_port=
To obtain the list of installable modules and the corresponding letter settings, open a the command prompt and type the following command:
install -list
This command lists the available packages specified in installation script, as shown in Listing 2‑3.
Listing 2‑3 Available installation modules for Windows
a. System Console
b. BIRT iHub
c. Information Console
d. Metrics Management Server
e. Metrics Management SQL Server RDBMS
f. Metrics Management Web
g. Metrics Management Classic Web Client
h. Metrics Management All
i. BIRT Analytics Core
j. BIRT Analytics Web
k. BIRT Analytics All
l. BIRT iHub PostgreSQL Database
m. JDK
n. Content Services
Choose a module
How to extract the contents of the BIRT iHub distribution package on Windows
To extract the BIRT iHub run-time resources and configure the setup script, perform the following tasks. The downloaded installation file is iHub3.zip.
1 Download the required files, iHub3.zip, and the contents of the modules folder from the software distribution site.
2 Create a new folder into which to extract the installation files from the distribution archive file. This location must be outside C:\Program Files or C:\Program Files (x86), such as C:\Actuate.
3 Extract the contents of iHub3.zip to the folder created in the previous step.
4 Navigate to the folder where you extracted the BIRT iHub package.
5 Open and read the file, license.pdf. You must agree to the license terms in order to install BIRT iHub.
6 Using a text editor, open and read the file, readme.txt. Then, close the file.
7 Using a text editor, open the acinstall.properties file, as shown in Listing 2‑2, and perform the following tasks:
1 Modify the ac.login and ac.password properties to contain the account login and password for the network machine that contains the installable Actuate BIRT product modules.
2 By default, the installation script installs options a and b, iHub with System Console and the embedded BIRT iHub Visualization Platform. To obtain the list of installable modules and the corresponding letter settings, open a the command prompt and type the following command:
install -list
This command lists the available packages, as shown in Listing 2‑3.
Modify the ac.package installation list, shown in Listing 2‑2, to contain the values for other BIRT iHub packages, such as a stand-alone Information Console, Metrics Management components, JDK, BIRT iHub PostgreSQL Database, Content Services, or BIRT Analytics.
3 Modify the ac.homedir property to specify the path to the installation files if you do not run the installation script from the directory to which you extracted the files.
4 Leave ac.downloadonly set to false.
5 Set ac.source to the network path of the installation modules.
6 To run BIRT iHub processes as Windows services, set ac.runasservice to true and edit ac.runasservice_username to the user name and ac.runasservice_password to the user password. Set ac.runasservice to false to see open command prompts for iHub server and Postgres services after installation is complete.
7 Set ac.acceptlicense to y to accept the software license terms.
8 Uncomment ac.ihub_cluster_schema_name and ac.ihub_postgres_port, setting these two properties to the cluster schema name and PostgreSQL RDBMS port, if necessary.
9 Save and close the file.
How to run the command-line installation script on Windows
1 From the Windows menu, choose Start➛Run. Open a command prompt by typing cmd, and choose OK.
2 Navigate to the folder where you extracted the BIRT iHub package, such as C:\Actuate\iHub3.
3 Type install, and press Enter to execute the installation script. Alternatively, you can navigate to the installation directory using Windows Explorer and double click the install.bat file to execute the script.
The command prompt display a series of status messages regarding the progress of the installation process, as shown in Listing 2‑4:
Detects and confirms administrative permissions
Searches for a pre-existing registry key
Detects and confirms a pre-existing JDK installation, or installs a JDK if a previous installation does not exist
Extracts and installs the iHub3.zip installation package
Displays BUILD SUCCESSFUL message indicating installation is complete.
If a Windows Security Alert appears indicating that the firewall is blocking access to Actuate BIRT iHub programs, as shown in Figure 2‑33, perform the following tasks:
Figure 2‑33 Allowing firewall access to Actuate BIRT iHub
1 In Allow Actuate BIRT iHub to communicate on these networks, for example, select Private networks, such as my home or work network, then choose Allow access.
2 Repeat this step for other Windows Security Alerts, such as Java Platform SE binary.
When the script finishes running, press any key to close the command prompt, as shown in Listing 2‑4.
Downloads the BIRT iHub 3 installation package, iHub3.zip, from the download site