Configuration properties

You can change the configuration properties for the Explore for iBase application using the i2 Explore Administration Console, or by modifying the configuration file on disk.

Properties that are set in variables.conf

The following properties can be set in the i2 Explore Administration Console, or by modifying the appropriate property in the following file:

  • <installation_location>/analyze-deployment-tooling/configs/explore-for-ibase/utils/variables.conf

Properties that are set include:

  • Database Administrator User Name

    • The user name for the administrator user in the iBase SQL Server instance. This is required to create the ISTORE database and views, and add appropriate users to this database.

    • Property name: DB_ADMIN_USER

  • iBase Database Name

    • The name of the iBase database that the Explore for iBase application connects to.

    • This is the SQL Server database name, which can be found in the database properties dialog in iBase designer (under the File menu).

    • Property name: IBASE_DB_NАME

  • iBase Security Database Name

    • The name of the iBase security database that the Explore for iBase application connects to.

    • This is the SQL Server database name, which can be found in the security database properties dialog in iBase designer (under the File menu).

    • Property name: IBASE_SEC_DB_NАME

  • Database Collation for Information Store

    • The database collation for the Information Store database. This value is calculated during deployment if not set. When loading iBase details, the collation is automatically populated from the selected iBase database.

    • Property name: DB_COLLATION

  • iBase Database Port

    • The port number that the iBase database is listening on.

    • Property name: HOST_PORT_DB

    • Default value: 1433

    • Either HOST_PORT_DB or DB_INSTANCE must be set.

  • iBase Database Instance

    • The name of the SQL Server instance to use to connect to the iBase database.

    • Property name: DB_INSTANCE

    • Either DB_INSTANCE or HOST_PORT_DB must be set.

  • Fully qualified domain name of the iBase Database Server

    • The host name or IP address of the server that is running the iBase database.

    • Property name: DB_FQDN

  • Information Store Database Name

    • The SQL Server database name for the Information Store.

    • Property name: DB_10.1.3Current

    • Default value: ISTORE_IBASE

  • Use SSL connection for the database

    • Specifies whether the connection to the database is secure.

    • Property name: DB_SSL_CONNECTION

    • Default value: false

  • Database Connection Timeout (seconds)

    • The timeout in seconds applied to both the SQL Server login phase and individual query execution.

    • Property name: DB_CONNECTION_TIMEOUT

    • Default value: 30

  • The locale that the iBase client is using

    • The locale that the iBase client is using.

    • Property name: DB_LOCALE

    • Default value: en-US

    • Allowed values: en-GB, en-US, ar-SA, cs, de, es, fr, it, ja, pl, pt-BR, zh-Hans, zh-Hant

  • The fully qualified domain name used to connect to the deployment

    • The fully qualified domain name (FQDN) of the server that is running the i2 Analyze application.

    • Property name: I2ANALYZE_SERVICE_FQDN

    • Default value: The deployment uses the name of the host it is running on

  • i2 Explore Service Port

    • The port number that the i2 Analyze service listens on.

    • Property name: HOST_PORT_I2ANALYZE_SERVICE

    • Default value: 9443

    • Changing this port on an existing deployment requires a specific process described in Deploying the Application.

  • Solr Service Port

    • The port number that the Solr service listens on.

    • Property name: HOST_PORT_SOLR

    • Default value: 8983

    • Changing this port on an existing deployment requires a specific process described in Deploying the Application.

  • Zookeeper Service Port

    • The port number that the Zookeeper service listens on.

    • Property name: ZK_CLIENT_PORT

    • Default value: 2181

    • Changing this port on an existing deployment requires a specific process described in Deploying the Application.

  • Admin Console Port

    • The port number that the Administration Console listens on.

    • Property name: ADMIN_CONSOLE_PORT

    • Default value: 8000

  • Heap size in Megabytes for the Liberty Application Server

    • The heap size in megabytes for the Liberty Application Server.

    • Property name: WAS_HEAP_SIZE

    • Default value: 2048

  • SQL Server Install Location

    • The location of the SQL Server installation, or the SQL server client tools on the host machine, for example: C:/Program Files/Microsoft SQL Server/Client SDK/ODBC/170.

    • Property name: DB_INSTALL_DIR

  • Database Location

    • The location of the iBase database data files. This may be on a different machine from the i2 Explore server, for example: C:/Program Files/Microsoft SQL Server/MSSQL16.MSSQLSERVER/MSSQL/DATA.

    • Property name: DB_LOCATION_DIR

  • The operating system that the iBase database is on

    • Valid values are UNIX or WIN.

    • Property name: DB_OS_TYPE

    • Default value: WIN

  • Secret Store Type

    • The secret store used to persist secrets.

    • Property name: SECRET_STORE_TYPE

    • Default value: cm (Windows Credential Manager)

    • Valid values: cm (Windows Credential Manager), file

  • The iBase security mode

    • Valid values are IBASE_SECURITY, ENTRA_ID, or ACTIVE_DIRECTORY.

    • Property name: IBASE_AUTH_MODE

    • Default value: IBASE_SECURITY

  • Entra client ID

    • This must be set if the iBase security mode is set to ENTRA_ID.

    • Property name: ENTRA_CLIENT_ID

  • Entra tenant ID

    • This must be set if the iBase security mode is set to ENTRA_ID.

    • Property name: ENTRA_TENANT_ID

  • Entra authority

    • This must be set if the iBase security mode is set to ENTRA_ID.

    • Property name: ENTRA_AUTHORITY

    • Default value: https://login.microsoftonline.com/{TENANT_ID}

      • {TENANT_ID} is replaced with the value of the ENTRA_TENANT_ID property

  • Kerberos service principal name (SPN)

    • This must be set if the iBase security mode is set to ACTIVE_DIRECTORY.

    • Property name: KERBEROS_SPN

  • LDAP server address (IP or DNS name)

    • This is in the form of an IP address or a domain name service (DNS) name.

    • This must be set if the iBase security mode is set to ACTIVE_DIRECTORY.

    • Property name: LDAP_PROVIDER_HOST

  • LDAP server port

    • This must be set if the iBase security mode is set to ACTIVE_DIRECTORY.

    • Property name: LDAP_PROVIDER_PORT

    • Default value: 636 when LDAP_SSL_CONNECTION is true, otherwise 389

  • Base distinguished name (DN) of the directory service

    • This indicates the starting point for LDAP searches in the directory service.

    • This must be set if the iBase security mode is set to ACTIVE_DIRECTORY.

    • Property name: LDAP_BASE_DN

  • Distinguished name (DN) of user

    • This must be set if the iBase security mode is set to ACTIVE_DIRECTORY.

    • Property name: LDAP_BIND_DN

  • Use SSL connection for LDAP

    • Valid values are true or false.

    • This must be set if the iBase security mode is set to ACTIVE_DIRECTORY.

    • Property name: LDAP_SSL_CONNECTION

    • Default value: false

If you want to change any of these settings after the initial deployment, you need to run the process described in Deploying the Application for the changes to take effect.