Working with BIRT iHub utilities : Working with Encyclopedia Data Store Upgrader
 
Working with Encyclopedia Data Store Upgrader
Use Encyclopedia Data Store Upgrader to migrate an Encyclopedia volume manually from an earlier iServer Release 11 installation, such as Service Pack 3, to Release 11 Service Pack 4.
Table 11‑3 describes the required Encyclopedia Data Store Upgrader properties to specify in the upgrade_encyclopedia_data_store.bat or other properties file for a manual upgrade operation.
Table 11‑3 Required Encyclopedia Data Store Upgrader properties
Parameter
Description
AC_SERVER_HOME
Points to the location of the iHub binaries, which you specify during the BIRT iHub installation.
APPLICATION_USER
User ID used to connect to the database for normal operations.
DATABASE_TYPE
Type of relational database system that contains the data store. Actuate iHub currently supports PostgreSQL and Oracle.
LOG_FOLDER
Absolute path to the log folder.
SCHEMA_FILE_NAME
Base name of the file without the file extension that contains the meta-schema definition.
SCHEMA_NAME
Name of the target schema which the Encyclopedia Data Store Upgrader updates. Required if NEW_SCHEMA_NAME is not present. Restrict the schema name to alphanumeric and underscore characters with an initial alphabetic character in the pattern [a‑z][a‑z 0‑9]*. Do not use a hyphen.
SCRIPT_HOME
Absolute path to the root of the folder hierarchy containing scripts and the meta-schema definition.
Table 11‑4 describes the optional Encyclopedia Data Store Upgrader properties to specify in the upgrade_encyclopedia_data_store.bat or other properties file.
Table 11‑4 Optional Encyclopedia Data Store Upgrader properties
Parameter
Description
Default value
Supported databases
CONFIG_SCHEMA_NAME
Specifies the schema definition in acserverconfig.xml. The schema name can be different from the database schema name.
False
All
DATABASE_HOST
Hostname or IP address of the machine hosting the database. This value is required for PostgreSQL. Required for Oracle if not using TNS.
False
All
DATABASE
_INSTANCE
RDBMS instance that manages the database.
 
SQL Server
DATABASE_NAME
Database name for PostgreSQL. For Oracle not using TNS, the database service name. For Oracle using TNS, the TNS net service name.
 
All
DATABASE_PORT
Port that the database server uses. This value is required for PostgreSQL. Required for Oracle if not using TNS.
 
All
FILE_LOG_LEVEL
The minimum logging level for messages sent to the log file. This parameter only works for AcLogger. Supported values are CONFIG, FINE, FINER, and FINEST.
CONFIG
All
GENERATE_SCRIPTS
Set to true to generate scripts to perform operations instead of performing the operations directly.
False
All
LOG_FILE_COUNT
Maximum number of log files to create before starting to overwrite previous log files. Must be a valid integer. Encyclopedia Data Store Upgrader tool does not generate large logs.
5
All
LOG_FILE_NAME
Name of the log file. Do not add a file extension. The extension is set to .log. Standard JUL.FileHandler placeholders are supported. A unique number is appended automatically to the file name to prevent overwriting previous logs.
 
All
LOG_FILE_SIZE
Approximate maximum size of log files, in byte, before a new log file starts. Must be a valid integer. Encyclopedia Data Store Upgrader tool does not generate large logs.
10,000,000
All
LOG_FOLDER
The full path of folder to write logs.
AC_DATA_HOME/server/log
All
ORACLE_TNS_NAMES_FILE
Absolute path of the Oracle TNS names file to use instead of DATABASE_HOST and DATABASE_PORT to generate a JDBC URL.
 
Oracle
PROMPT_FOR_PASSWORDS
Indicates whether to prompt the user to type in a password instead of specifying it as a property value. Required if SCHEMA_PASSWORD is not present. Password prompting works only when running the tool from the command line.
True
All
SCHEMA_PASSWORD
Password for the schema owner. Required if PROMPT_FOR_PASSWORDS is false.
 
All