Updating the configuration manually

Details of the properties that are set during the installation of the Explore for iBase application, and how to change them after the installation has completed.

Properties that are set in variables.conf

The following properties can be set in the installer, and/or changed after the installation has completed, by modifying the appropriate property in the following file:

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

Properties that will be set in the variables.conf file during the installation process include:

  • iBase admin 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.

    • The value will be set on the following property in variables.conf:

      • DB_ADMIN_USER

  • The iBase database name: The name of the iBase database that the Explore for iBase application will connect to.

    • The value will be set on the following property in variables.conf:

      • IBASE_DB_NАME

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

  • The iBase security database name: The name of the iBase security database that the Explore for iBase application will connect to.

    • The value will be set on the following property in variables.conf:

      • IBASE_SEC_DB_NАME

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

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

    • The value will be set on the following property in variables.conf:

      • HOST_PORT_DB

      • Default value: 1433

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

    • The value will be set on the following property in variables.conf:

      • DB_FQDN

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

    • The value will be set on the following property in variables.conf:

      • I2ANALYZE_SERVICE_FQDN

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

  • The i2 Explore service port: The port number that the i2 Analyze service will listen on.

    • The value will be set on the following property in variables.conf:

      • HOST_PORT_I2ANALYZE_SERVICE

      • Default value: 9443

    • Changing this port on a existing deployment requires a specific process described in Starting the deployment.

  • The Solr service port: The port number that the Solr service will listen on.

    • The value will be set on the following property in variables.conf:

      • HOST_PORT_SOLR

      • Default value: 8983

    • Changing this port on a existing deployment requires a specific process described in Starting the deployment.

  • The Zookeeper service port: The port number that the Zookeeper service will listen on.

    • The value will be set on the following property in variables.conf:

      • ZK_CLIENT_PORT

      • Default value: 2181

    • Changing this port on a existing deployment requires a specific process described in Starting the deployment.

  • The 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.

    • The value will be set on the following property in variables.conf:

      • DB_INSTALL_DIR

  • The iBase 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.

    • The value will be set on the following property in variables.conf:

      • DB_LOCATION_DIR

  • Operating System that the iBase database is on: Valid values are UNIX or WIN.

    • The value will be set on the following property in variables.conf:

      • DB_OS_TYPE

      • Default value: WIN

  • The iBase security mode: Valid values are IBASE_SECURITY, ENTRA_ID, or ACTIVE_DIRECTORY.

    • The value will be set on the following property in variables.conf:

      • IBASE_AUTH_MODE

      • Default value: IBASE_SECURITY

  • The client ID for Entra ID authentication:

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

    • The value will be set on the following property in variables.conf:

      • ENTRA_CLIENT_ID

  • The tenant ID for Entra ID authentication:

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

    • The value will be set on the following property in variables.conf:

      • ENTRA_TENANT_ID

  • The URL of the Entra ID authority:

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

    • The value will be set on the following property in variables.conf:

      • ENTRA_AUTHORITY

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

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

  • The Kerberos service principal name:

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

    • The value will be set on the following property in variables.conf:

      • KERBEROS_SPN

  • The address of the LDAP server: 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.

    • The value will be set on the following property in variables.conf:

      • LDAP_PROVIDER_HOST

  • The port number of the LDAP server:

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

    • The value will be set on the following property in variables.conf:

      • LDAP_PROVIDER_PORT

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

  • The 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.

    • The value will be set on the following property in variables.conf:

      • LDAP_BASE_DN

  • The distinguished name (DN) for the user, which is used to bind to the directory service:

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

    • The value will be set on the following property in variables.conf:

      • LDAP_BIND_DN

  • Specify whether to use SSL for the LDAP connection: Valid values are true or false.

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

    • The value will be set on the following property in variables.conf:

      • 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 Starting the deployment for the changes to take effect.