Specifying System Data Store Administrator properties

Working with BIRT iHub utilities : Working with System Data Store Administrator : Specifying System Data Store Administrator properties

The system data store is a separate schema in the database that stores iHub system metadata. The system schema is a required element for any iHub installation. In a cluster, the nodes share system schema metadata and use this information for communicating and coordinating processing.

In BIRT iHub, it is not necessary to back up the system schema, although future versions may require this procedure to protect critical system metadata. If a system schema becomes corrupted or is accidentally deleted, the administrator can use the System Data Store Administrator utility to create a new schema. You can define a new system schema in Configuration Console or edit acserverconfig.xml to refer to the current system schema.

Before running the System Data Store Administrator utility, edit the PATH environment variable on your machine to contain the following string:

<AC_SERVER_HOME>\bin

where AC_SERVER_HOME refers to the iHub installation path. For example, using the default value for AC_SERVER_HOME, add:

C:\Program Files\Actuate\iHub\bin

To run the System Data Store Administrator utility, perform the following tasks:

1 In Windows Explorer, navigate to AC_SERVER_HOME\bin.

2 Create a properties file containing the property definitions necessary to perform an operation, such as creating and populating a system schema, described in “Performing operations using the System Data Store Administrator utility,” later in this book. You pass this file to the System Data Store Administrator utility when you execute it.

3 Open a command prompt and navigate to AC_SERVER_HOME/bin.

4 Create a batch file or run the administrate_system_data_store.bat file, passing in the name of the properties files as an argument, using the following command line syntax:

administrate_system_data_store systemdatastore.properties

Alternatively, you can execute the utility by running the adminsds.bat script, using the following command-line syntax:

adminsds systemdatastore.properties

The batch file performs the following operations, as shown in Listing 11‑1.

Checks to see if the administrator submitted a property file on the command line when running the script.

If the administrator does not submit an argument, the script echoes a usage statement that describes the command-line syntax.

Calls the set_tools_environment.bat script, which sets the environment variables.

Executes the System Data Store Administrator utility using the name of the properties file as an argument.

Listing 11‑1 administrate_system_data_store.bat

@echo off

if %1.==. goto :HELP

:: Set up environment variables

CALL "%~dp0"set_tools_environment.bat

:: Administrate data store

java com.actuate.iserver.system.datastore.admin.SystemDataStoreAdministrator %1

GOTO :END

:HELP

echo Usage: administrate_system_data_store.bat ^<properties file name^>

:END

In the example, the ^ symbol functions as a line-continuation marker to concatenate the lines together.

The SystemDataStoreAdministrator class has the same parent class as the Encyclopedia Data Store Administrator and uses the same property settings. For more information about these properties, see Table 11‑1.

System Data Store Administrator properties include the following categories:

Properties that specify details of the iHub installation environment, such as AC_SERVER_HOME and AC_DATA_HOME

Database properties that specify the RDBMS type and JDBC connection details, such as the schema, application user, superuser, and passwords

Schema operation properties that specify an action to perform, such as create, populate, or delete a schema

Logging properties that control messages sent to the console and log files

Engineering properties used by Actuate Support or Professional Services to assist with diagnosing or resolving specific issues

Refer to the required and optional properties tables in “Specifying Encyclopedia Data Store Administrator properties,” earlier in this chapter, for detailed information about these properties.