AC_SERVER_HOME

Points to the location of the iHub binaries specified during the BIRT iHub installation.

DATABASE_TYPE

Type of supported RDBMS that contains the data store. Specify DB2, Oracle, or PostgreSQL.

LOG_FOLDER

Absolute path to the log folder.

SCHEMA_FILE_NAME

Base name of the file without the extension that contains the schema definition.

SCRIPT_HOME

Absolute path to the root of the folder hierarchy that contains the scripts and the schema definition.

APPLICATION_USER

Application user ID for connecting to the database for normal operations. Must be a legal SQL identifier. Typically iserver. This parameter is required when creating or populating a schema. Restrict the iHub application user 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.

 

All

APPLICATION_USER_PASSWORD

Application user password for connecting to the database for normal operations. Required when creating a schema. The password is not encrypted.

 

All

CONFIG_SCHEMA_NAME

Specifies the schema definition in acserverconfig.xml. Use this property when any of the following properties is required but is not specified in the properties file:

False

All

CREATE_SCHEMA

Set to true to create a new schema, false to use an existing schema. Specifies whether to create a new Encyclopedia schema. PostgreSQL only, not supported for DB2 or Oracle. Creating a schema automatically creates the schema owner and application user if necessary.

False

PostgreSQL

DATA_EXPORT
_FOLDER

Absolute path to the folder to which data is exported. This parameter is required if EXPORT_DATA is true. Folder is on the database machine.

 

All

DATA_EXPORT_FORMAT

Format of exported data. Specify 'Oracle' or 'PostgreSQL'.

{DATABASE
_TYPE}

All

DATA_IMPORT_FOLDER

Absolute path to the folder from which data is imported. This parameter is required if IMPORT_DATA is true. For PostgreSQL, the data must be on the database server.

 

All

DATA_IMPORT_FORMAT

Format of imported data. Specify DB2, Oracle, or PostgreSQL.

{DATABASE
_TYPE}

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.

 

All

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

DATABASE_TYPE

Type of relational database system that contains the data store. iHub currently supports DB2, Oracle, and PostgreSQL in Linux.

 

All

DEFAULT_DATABASE_NAME

Used by the superuser to connect to the default database in order to create the iHub application database. Required when the application database does not exist. PostgreSQL only.

 

PostgreSQL

DELETE_ALL_DATA

Set to true to delete all data from the data store. Does not delete data from other tables in the schema.

False

All

DELETE_DATA

Set to true to delete filtered data from the data store. This parameter only works when a filter value is available.

False

All

DEPOPULATE_SCHEMA

Set to true to delete data store elements such as tables, views, stored functions, and procedures from the schema. Does not remove any other objects in the schema.

False

All

DROP_SCHEMA

Set to true to delete the schema.

False

PostgreSQL

EXPORT_ALL_DATA

Set to true to export all volumes from a schema.

False

All

EXPORT_DATA

Set to true to export a single volume from a schema. Use VOLUME_NAME to specify the name of the volume to export. Optionally, use NEW_VOLUME
_NAME to specify a new name for the exported volume.

False

All

FILE_LOG_LEVEL

Minimum logging level for messages sent to the log file. This parameter only works for AcLogger, and is a standard JUL Level name. 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

IMPORT_DATA

Set to true to import data into the data store.

False

PostgreSQL

INITIALIZE_DATA

Set to true to initialize the data in the data store, using the data initialization script.

False

All

LOG_FILE_COUNT

Maximum number of log files to create before starting to overwrite previous log files. Must be a valid integer. Data Store Administrator tools do 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. A unique number is appended automatically to the file name to prevent overwriting previous logs.

Encyclopedia
DataStore
Administrator
<number>.log

 

LOG_FILE_SIZE

Approximate maximum size of log files, in byte, before a new log file starts. Must be a valid integer. Data Store Administrator tools do not generate large logs.

10,000,000

All

LOG_FOLDER

Full path of folder to write logs.

AC_DATA_HOME/server/log.

 

NEW_SCHEMA_NAME

Name of the new schema to be created, or the name of the target schema for data export. This name is required if {SCHEMA_NAME} is not present. Restrict 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.

NEW
_SCHEMA_NAME

All

NEW_VOLUME_NAME

Name of the new volume to be created, or the name of the target schema for data export. Do not use a hyphen in a volume name.

NEW_VOLUME_NAME

All

ORACLE_TNS_NAMES_FILE

Absolute path to the Oracle TNS names file. This path can be used instead of {DATABASE_HOST} and {DATABASE_PORT} to generate a JDBC URL.

 

Oracle

POPULATE_SCHEMA

Set to true to populate the schema with data store elements such as tables, views, stored functions, and procedures. Set to false if the data store elements already exist. Use Configuration Console to populate schema when possible. Schema automatically populates when defined in Configuration Console.

CREATE_SCHEMA

All

POPULATE_SCHEMA_PHASE_ONE

Set to true to create the schema objects necessary for data to be loaded. Set to false to prevent this schema object creation. Imports data without building indexes for fast load.

POPULATE_SCHEMA

All

POPULATE_SCHEMA_PHASE_TWO

Set to true to create schema objects phase one does not create. Set to false to prevent this schema object creation. Builds indexes and other structures in database.

POPULATE_SCHEMA

 

All

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_NAME

Name of the existing schema. Must be a legal SQL identifier. This parameter is required when performing operations on an existing schema. Restrict 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.

NEW_SCHEMA_NAME

All

SCHEMA_PASSWORD

Password for the schema owner. Required if PROMPT_FOR _PASSWORDS is false.

 

All

SUPERUSER

User ID of the database superuser. This parameter is required if CREATE_SCHEMA is true or when importing data into PostgreSQL. Typically postgres in a PostgreSQL database.

 

PostgreSQL

SUPERUSER_PASSWORD

Password of the database superuser. This parameter is required if CREATE_SCHEMA is true or when importing data into PostgreSQL.

 

PostgreSQL

TABLESPACE_NAME

Name of the application tablespace.

 

PostgreSQL

TABLESPACE_LOCATION

Absolute path to the application tablespace folder.

 

PostgreSQL

TIME_ZONE

Local time zone for installation.

 

All

VOLUME_NAME

Name of the volume or target schema for data import.

VOLUME_NAME

All