You can configure initial site settings using the setup.xml file. You must configure the settings in the setup.xml file during the ALM Octane installation.
Caution: These settings cannot be changed later.
Configure these settings by editing the setup.xml file, for example, with an editor such as nano:
Configuration files must be readable and editable by the user installing ALM Octane, which is generally the octane user. If you copy or edit a configuration file as the root or sudoer user that does not have the necessary installation permissions, the install fails.
Tip: To change the owner:
chown <owner>:<group> <file>
chown octane:octane setup.xml
It is recommended that you save a local copy of the setup.xml file before making changes to it.
Also, for security purposes, setup.xml should be stored in a secure, off-site location.
The Oracle settings can be used for both Oracle and SQL server.
The supported database types are:
The name of the site schema that is created by the DBAdminUser during the installation, or supplied by the organization's DBA. Enter the supplied name.
For SQL Server:
The password for the DBLoginUser user.
ALM Octane uses the DBAdminUser both to create objects during installation and also to check that the database server is accessible.
For SQL Server:
Login object for logging into the database instance. ALM Octane uses this login for setup, tables, and indexes.
For details about DBAdminUser permissions, see Permissions.
For Oracle: The password of the database admin user (DBAdminUser).
For SQL Server: Password for the sa user or the SQL Server power user defined with the DBAdminUser setting.
The Java Database Connectivity (JDBC) database connection string. It includes the following details: database type, database server name, database server port number, service name.
The instructions below demonstrate how to set up the string with non-secured database access. However, you can use this connection string to configure secure access to the database. For details, see Configure secure database access.
To connect to Oracle RAC, use the Single Client Access Name (SCAN) instead of the database server name.
The tablespace in the Oracle database where the site schema segment will be created. Case-sensitive.
|TempTableSpace||The temporary tablespace in the Oracle database. Case-sensitive.|
The TNS alias name for connecting to the Oracle database. Optional.
For use with Configure initial site settings .
|DBServerPort||The port for connecting to the Oracle database.|
|SQL Server settings||Description|
MSSQL database login authentication user for ALM Octane. This is the user for day-to-day ALM Octane use.
This login is associated with the ALM Octane site and space databases.
Specify the password for this user using the SchemaPassword setting. Do not include a pound sign (#) or accented characters (such as, ä, ç, ñ).
If the DBLoginUser user already exists, make sure to use the existing user's password.
The SiteAction setting determines how the installation should handle databases. Possible values:
Use this site action for new installations.
Use this site action for new installations, in cases where the database admin user does not give permissions to create a schema (for Oracle) or a database (for SQL Server)..
For SQL Server:
Two databases are created, one for the site and one for the space. Both are created by the DBA.
Two schemas are created, one for the site and one for the space. Both are created by the DBA.
Make sure that the passwords that the DBA defines for the site schema and the shared space schema both match the SchemaPassword setting.
Handling schema exceptions
If the organization's DBA made changes to schemas, such as the addition of tables or columns, you can define an exception file. The exception file instructs ALM Octane to ignore manual changes to the database user schema during installation and upgrade. For details, see Using exception files for manual database changes.
Where relevant, the Oracle settings can be used for both Oracle and SQL server. Alternatively, for SQL Server, you can specify the SQL Server settings instead.
A working Elasticsearch server is a requirement for working with ALM Octane. Make sure you are using a version supported by ALM Octane:
For the supported version, see the requirements for Database and Elasticsearch.
For details on installing Elasticsearch, see knowledge base article KM02494295.
For details on upgrading to a new Elasticsearch version, see knowledge base article KM03207448.
The name of the host running Elasticsearch.
If running an Elasticsearch cluster, all node host names should be separated by semi-colons (;).
The number of the port running the Elasticsearch binary service.
This port must be accessible from the ALM Octane server, not just by checking the HTTP connection.
The name of the Elasticsearch cluster.
The full path of the repository directory.