# Prepare XML for Auto Installation & Upgradation for Linux-Based Deployment

Here is the process of getting and customizing OpsHubAutoInstall/OpsHubAutoMigrator XML file.

## 1 - Download XML file

Below are the sample templates for OpsHubAutoInstall/OpsHubAutoMigrator XML. You need to customize the template downloaded as described below for configuring your own file for installing or migrating <code class="expression">space.vars.SITENAME</code>.

* If you are installing <code class="expression">space.vars.SITENAME</code> then download file [here](https://opshubtrial-my.sharepoint.com/:u:/g/personal/support_opshub_com/EdwkmbjVf5RNpjHmsqi8dE4BaSfch1pFlGQhPsixpGnHEw?e=VJclvQ)
  * To customize the file as per your configuration, follow steps from section [step 3 - Configure Installation path](#id-3-configure-installation-path).
* If you are upgrading the existing <code class="expression">space.vars.SITENAME</code> then download file [OpsHubAutoMigrator.xml](https://opshubtrial-my.sharepoint.com/:u:/g/personal/support_opshub_com/EW_r0v_m5RtPoQp-jGLitoMBfWzZDdB0zdpJxflswG4a2Q).
  * To customize the file as per your configuration, follow steps **step 3 and step 4**.

> **Note**: Refer to [step 2](#id-2-customized-example-of-xml-file-with-mysql-database) for example of an already customized file for **installation with MySQL database**.

> **Note**: It is always recommended to have a secured environment for OIM installation. The purpose of Silent installation is to have no manual intervention, and so the user needs to have a secured VM installation as the autoinstall.xml file contains the password in plain text.

## 2 - Customized example of xml file with MySQL database

* Here are the examples of XML file after all modifications.
  * Installation with MySQL Database : [Installer Example file](https://opshubtrial-my.sharepoint.com/:u:/g/personal/support_opshub_com/ETH4fCuE0VBBvBucTLI8DtIBl9MlETKWMF3Y1eup2XjuGQ?e=c9TvS4)
  * Upgrade : [Migrator example file](https://opshubtrial-my.sharepoint.com/:u:/g/personal/support_opshub_com/EY22j0v_TdFGsCLzrxWEy1IBb8mZXapO2a8po-mPix1R8A?e=N8oyFe)

## 3 - Configure Installation Path

* Find `com.izforge.izpack.panels.TargetPanel` and replace the input mentioned below:
  * Replace **@INSTALLATION\_PATH@** with actual installation directory which you mentioned in **Registration\_Input.properties** during [Silent Registration](https://docs.opshub.com/v7.203/getting-started/registration#silent-registration-for-linux).

## 4 - Configure Verification Code

* Find "UserInputPanel.EmailIdVerificationForExistingCode" panel and replace the input mentioned below:
  * Replace @VERIFICATION\_CODE@ with verification code that you got on your registered business email address.

## 5 - Configure Base Parameter

Find all parameters below under panel `id="UserInputPanel.installationflow"`.

1. Find **@COMPANY\_NAME@** parameter in the OpsHubAutoInstall.xml file and replace with your company name.
2. Find **@DB\_TYPE@** and replace database type as below:
   * Replace with "MySQL" for configuring MySQL database. Refer to [MySQL Database configuration](#mysql-database-configuration) for detailed steps.
   * Replace with "MS SQL Server" for configuring MS SQL database. Refer to [MSSQL Database configuration](#mssql-database-configuration) for detailed steps.
   * Replace with "ORACLE" for configuring Oracle database. Refer to [Oracle Database configuration](#oracle-database-configuration) for detailed steps.
   * Replace with "HSQLDB" for configuring HSQL database. Refer to [HSQL Database configuration](#hsql-database-configuration) for detailed steps.
   * Replace with "PostgreSQL" for configuring PostgreSQL database. Refer to [PostgreSQL Database configuration](#postgresql-database-configuration) for detailed steps.
3. Find **@ADVANCE\_CONFIG\_FLAG@** and replace with either "1" if you want to configure advance parameter or "0" if you don't want to configure advance parameters.

   > **Note**: Advance configuration allows to change default database name, Http/Https configuration, Advanced Security Options.

   * If you are setting above flag as "0" then advance configuration parameters will be set with default values.

## 6 - Database configuration

### MySQL Database configuration

1. Find panel with id **"UserInputPanel.mysqldb"**.
2. Remove comment from parameters.
3. Go to [Common Database configuration parameters](#common-database-configuration-parameters) and follow the steps.

### Common Database Configuration Parameters

1. Find and replace **@DB\_HOST@** with the host name of your database.
2. Find and replace **@DB\_PORT@** with the port of your database.
3. Find and replace **@DB\_USER@** with the username of your database.
4. Find and replace **@DB\_PASSWORD@** with the password of your database.
5. Find and replace **@DB\_CONNECTOR\_JAR\_PATH@** with the jar file path of your database connector. Find the jar file name according to the database you are using.

   * For MySQL, refer section [Installation with MySQL Server](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-mysql-server)

   * For MS SQL, refer section [Installation with MSSQL Server](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-ms-sql-azure-sql-server)

   * For ORACLE, refer section [Installation with Oracle](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-oracle)

   * For HSQL, no external connector jar file is required.

   * For PostgreSQL, refer section [Installation with PostgreSQL](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-postgresql)

   > **Note**: The user who is running the installer should have 'Read' access to the jar file of your database connector.

### MSSQL Database configuration

#### Installation on Windows

**With Windows authentication**

1. Find panel with id **"UserInputPanel.mssqlAuthModeOnWindows"**.
2. Remove comment from parameters.
3. Find **@DB\_AUTH\_TYPE@** in the same panel.
4. Replace variable value with "Windows Authentication" if you are configuring MSSQL with Windows Authentication.
5. Find panel with id **"UserInputPanel.mssqldbOnWindowsAuth"**.
6. Remove comment from parameters.
7. Go to [Common Database configuration parameters](#common-database-configuration-parameters) and follow the steps to replace **@DB\_HOST@, @DB\_PORT@, @DB\_CONNECTOR\_JAR\_PATH@** with your input.
8. Find and replace **@DB\_NAME\_TO\_TEST\_CONNECT@** with the database name to which database user has access to.

   > **Note**: Go to [MS SQL/Azure SQL Server Database Name Input](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-ms-sql-azure-sql-server) to find the usage.

**With SQL authentication**

1. Find panel with id **"UserInputPanel.mssqlAuthModeOnWindows"**.
2. Remove comment from parameters.
3. Find **@DB\_AUTH\_TYPE@** in the same panel.
4. Replace variable value with "SQL Authentication" if you are configuring MSSQL with SQL Authentication.
5. Find panel with id **"UserInputPanel.mssqldbOnSQLAuth"**.
6. Go to [Common Database configuration parameters](#common-database-configuration-parameters) and follow the steps.
7. Find and replace **@DB\_NAME\_TO\_TEST\_CONNECT@** with the database name to which database user has access to.

   > **Note**: Go to [MS SQL/Azure SQL Server Database Name Input](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-ms-sql-azure-sql-server) to find the usage.

**Installation on Linux**

1. Find panel with id **"UserInputPanel.mssqlAuthModeOnLinux"**.
2. Remove comment from parameters.
3. Find **@DB\_AUTH\_TYPE@** in the same panel.
4. Replace variable value with "SQL Authentication" if you are configuring MSSQL with SQL Authentication.
5. Find panel with id **"UserInputPanel.mssqldbOnSQLAuth"**.
6. Go to [Common Database configuration parameters](#common-database-configuration-parameters) and follow the steps.
7. Find and replace **@DB\_NAME\_TO\_TEST\_CONNECT@** with the database name to which database user has access to.

   > **Note**: Go to [MS SQL/Azure SQL Server Database Name Input](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-ms-sql-azure-sql-server) to find the usage.

### Oracle Database configuration

1. Remove comment from panel id **"UserInputPanel.oracleDatabaseType"**.
2. Find and replace **@ORACLE\_DB\_TYPE@** from the same panel with CDB or Non CDB depending upon your oracle database type. For reference follow section[Installation with Oracle](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-oracle).
3. Find and replace **@ORACLE\_CONNECTION\_TYPE@** from the same panel with Service or SID depending upon your oracle configuration. For reference follow section [Installation with Oracle](https://docs.opshub.com/v7.203/getting-started/installation/..#installation-with-oracle).
4. Now, remove comment from panel id "UserInputPanel.oracledb".
5. Find and replace **@ORC\_INSTANCE@** with oracle database instance name from the same panel.
6. Go to [Common Database configuration parameters](#common-database-configuration-parameters) and follow the steps.

### HSQL Database configuration

For HSQL you can move to next step for further configuration.

### PostgreSQL Database configuration

1. Find panel with id **"UserInputPanel.postgresqldb"**.
2. Remove comment from parameters.
3. Go to [Common Database configuration parameters](#common-database-configuration-parameters) and follow the steps.

## 7 - Enable Advance Configuration

If you are doing advance configuration then only follow the below step.

* Make sure you have **@ADVANCE\_CONFIG\_FLAG@** flag is 1 as specified [here](#id-5-configure-base-parameter).

### Enabling advance configuration with HSQL, then follow below steps

1. Remove comment from panel id "UserInputPanel.advancedOptionsHSQL" and add comment in panel id **"UserInputPanel.advancedOptions"**.
2. Find **@ADV\_HTTP\_CONFIG@** and replace it with "HTTP" if you want to configure <code class="expression">space.vars.SITENAME</code> with HTTP or replace it with "HTTPS" if you want to configure <code class="expression">space.vars.SITENAME</code> with https.
   * Make sure you are following step no 8 if you configure <code class="expression">space.vars.SITENAME</code> with https.
3. Find **@ADV\_ISSERVICE@** and replace with 1 if you want to configure <code class="expression">space.vars.SITENAME</code> as a service else replace it with 0.
4. Find **@ADV\_SEC\_CONFIG@** and replace with 1 if you want to configure advance Security configuration else replace it with 0.

### Enabling advance configuration other than HSQL, then follow below steps

1. Remove comment from id "UserInputPanel.advancedOptions".
2. Find **@ADV\_HTTP\_CONFIG@** and replace it with "HTTP" if you want to configure <code class="expression">space.vars.SITENAME</code> with HTTP or replace it with "HTTPS" if you want to configure <code class="expression">space.vars.SITENAME</code> with https.
   * Make sure you are following step no 8 if you configure <code class="expression">space.vars.SITENAME</code> with https.
3. Find **@ADV\_ISDBFLAG@** and replace with 1 if you will create <code class="expression">space.vars.SITENAME</code> database manually else set it as 0.
4. Find **@ADV\_OPSHUBDBMAME@** and replace it with your <code class="expression">space.vars.SITENAME</code> database name else remove that entry from the panel.
5. Find **@ADV\_REPORT\_DBNAME@** and replace it with your <code class="expression">space.vars.SITENAME</code> report database name else remove that entry from the panel.
6. Find **@ADV\_ISSERVICE@** and replace with 1 if you want to configure <code class="expression">space.vars.SITENAME</code> as a service else replace it with 0.
7. Find **@ADV\_SEC\_CONFIG@** and replace with 1 if you want to configure advance Security configuration else replace it with 0.

## 8 - HTTPS configuration

1. Make sure you have configure **@ADV\_HTTP\_CONFIG@** with "HTTPS" value.
2. Find panel with id "UserInputPanel.certInfo" remove comment from parameters.
3. Find **@CERT\_SERVER\_HOST@** and replace it with IP Address/hostname of Machine on which you install <code class="expression">space.vars.SITENAME</code>.
4. Find **@CERT\_COMP\_UNIT@** and replace it with your Organization's Unit like Manufacturing, Sales etc.
5. Find **@CERT\_COMP\_NAME@** and replace it with your Organization Name.
6. Find **@CERT\_COMP\_CITY@** and replace it with your Organization's City.
7. Find **@CERT\_COMP\_STATE@** and replace it with your Organization's State or Province.
8. Find **@CERT\_COMP\_COUNTRY@** and replace it with your Organization's Country.
9. Find **@CERT\_VALIDITY@** and replace it with number of days for which the certificate should be considered valid.

## 9 - Advance Security Configuration

1. Make sure you have configure ADV\_SEC\_CONFIG with "1" value in step 5.
2. Find panel with id "UserInputPanel.securityConfig" remove comment from parameters.
3. Find **@SEC\_KEYMODE@** replace with "newSecretKey".
4. Find **@SEC\_KEY\_PATH@** and replace with your secret key installation path.
5. Find **@SEC\_ALGO@** and replace with either "AES-256" or "DES-56 or "DESede-168" as per your need.
6. Note do not copy your secret file once its generated after <code class="expression">space.vars.SITENAME</code> installation process.