Installing and Configuring the eG SuperManager on Windows Environments

The installation process of the eG SuperManager is similar to that of the eG Manager. Let us now proceed to the step by step procedure on how to install the eG SuperManager:

  1. To start the installation process on a 32-bit Windows server, run the eGManager_win2008.exe. For installing the SuperManager on a 64-bit Windows server, use the eGManager_win2008_x64.exe. The Welcome screen (see Figure 1) of the eG SuperManager Setup program appears. Clicking on the Next > button at the bottom of this screen takes the user to the next step of the setup.

    Figure 1 : Welcome screen of the eG SuperManager Setup program

  2. Now, the user can view the eG license agreement (see Figure 2). Also, the Setup program seeks the confirmation of the user regarding his/her acceptance of the terms and conditions of the license agreement. It is mandatory that the user accepts the license agreement to proceed with the setup. Click on the Yes button at the bottom of the screen to accept and proceed with the setup process.

    Figure 2 : License agreement of the eG SuperManager

  3. The eG SuperManager setup program then automatically discovers all the versions of JDK available on the target host, and lists them as depicted by Figure 3. The eG SuperManager requires JDK 1.7 (or its variants) for its functioning.

    Figure 3 : The JDK versions discovered in your environment

  4. Upon selecting a JDK version, eG Enterprise automatically determines the location of the JDK-related files on the target host, and uses them to configure the eG user’s Java execution environment to execute Java programs to proceed with the installation. Clicking on the Next button in Figure 3 will then lead the user straight to step 7 of the setup process.
  5. On the other hand, if the JDK version the user wishes to use is not listed in Figure 3 for some reason, he/she can pick the Other option from Figure 3. Figure 4 then appears, where the user is prompted to specify if his/her environment contains the required JDK (see Figure 4). It is recommended that you use JDK 1.7 (or its variants) for installing the eG SuperManager.

    Figure 4 : Setup that enquires the availability of JDK in the environment

  6. If this version of JDK is not available, the following message box appears asking the user to install the required JDK (see Figure 5).

    Figure 5 : Message box instructing the user to install JDK

    Note:

    If the message box of Figure 5 appears even after you have specified/selected JDK 1.7 or higher, then check whether the <jdk_install_dr>\bin directory on the eG SuperManager host is a Read-only directory. If so, grant Read-Write permissions to that directory, and then proceed with the eG SuperManager installation. 

  7. The setup process now requires the hostname and port number of the host on which the eG SuperManager is being configured (see Figure 6). The default port is 7077. If the domain name service is used in the target environment, use the full hostname. Otherwise, specify the IP address.

    Figure 6 : Hostname and port number of the system on which the eG SuperManager will execute

    Note:

    While specifying the host name/IP address of the SuperManager, please take care of the following aspects:

    • If the host name is provided when installing the SuperManager, use this name (and not the IP address) for accessing the user interface via the web browser.
    • If the host name is provided, make sure that forward and reverse lookups for this name are enabled via the DNS service in the target environment.
  8. The eG SuperManager system provides users with the option to view and key in data in a language of their choice. Different users connecting to the same SuperManager can view data in different languages as they see in their respective managers. However, some languages such as Chinese, Japanese, and Korean, support a double-byte character set. To view data in the eG SuperManager user interface in Chinese, Korean, or Japanese, the eG SuperManager should be explicitly configured to display and process double-byte characters. In such a case, enable double-byte support for the eG SuperManager by clicking the Yes button in Figure 7. On the other hand, for handling the character sets of other languages (example: French, German, Spanish, Portugese, etc.), the eG SuperManager need not be double-byte enabled. At such times, click the No button to disable double-byte support for the eG SuperManager. If the eG manager communicating with the eG SuperManager is double-byte enabled, then, it is recommended to ensure that the eG SuperManager is also double-byte enabled.

    Figure 7 : Enabling double-byte support

    Note:

    For a detailed discussion on how to enable double-byte support for eG Enterprise, refer to Configuring Double-byte Support for eG Enterprise .

  9. Next, you will be prompted to indicate whether you want to SSL-enable the eG SuperManager or not. Click Yes in Figure 8 to SSL-enable the eG SuperManager or No to not SSL-enable the same.

    Figure 8 : SSL-enabling the eG SuperManager

  10. By default, the eG SuperManager system stores data such as the audit log entries in a backend database. The database can either be an Oracle database or a Microsoft SQL server. You can opt to choose any one of the database servers (see Figure 9) as the default server of the eG SuperManager.

    Figure 9 : Selecting the backend database for the eG SuperManager

  11. Proceed to step 20 if you choose Microsoft SQL server as the backend database of the eG SuperManager. Alternately, if you choose Oracle as your database from Figure 9, you will be prompted (as in Figure 10) to ensure that a valid Oracle database instance (SID) is running on the target host and whether sufficient space is allocated for the Oracle database. A minimum of 100MB space is required for the Oracle database.

    Figure 10 : Message stating if sufficient space is available for hosting the database

  12. Once you click the OK button in Figure 10, Figure 11 will appear asking if you want to continue the setup program. Click the Yes button if you wish to continue with the setup and No if you wish to exit the eG SuperManager installation.

    Figure 11 : Confirmation for continuing the setup

  13. Now, you will be required to specify the host name/IP address and the port number of the Oracle database server. Specify the required credentials as in Figure 12.

    Figure 12 : Specifying the host name and IP address of the Oracle database server

  14. Now, specify the name of the Oracle database instance (SID) that the eG SuperManager is required to use in Figure 13. Then, click on the Next button.

    Figure 13 : Specifying the name of the Oracle database instance

  15. Once you specify a valid oracle database instance, you will be prompted (see Figure 14) to create a valid database user account within the Oracle database instance.

    Figure 14 : Specifying the credentials of the database user account

  16. Next, specify the install directory of the eG SuperManager. The default location is C:\ (see Figure 15).

    Figure 15 : Specifying the install directory of the eG SuperManager

  17. Upon clicking the Next button in Figure 15, the current settings that you have specified so far will be listed as in Figure 16. If you wish to change any of the settings, you can click on the Back button in Figure 16. Clicking on Next in Figure 16 will start installing the eG SuperManager.

    Figure 16 : Viewing the current settings provided so far

  18. Once the installation starts, you will be prompted to specify the default and temporary tablespaces for the created database user account. Specify the names of the tablespaces as in Figure 17 and click the Next button.

    Figure 17 : Specifying the default and temporary tablespaces

  19. Now, specify the name of a valid user who possesses database administrator privileges in Figure 18. Enter the password for the user in Figure 18 and click the Next button. The installation process will now start and once the installation is complete, Figure 36 will appear informing you of the successful installation of the eG SuperManager. It is recommended that you restart your system before proceeding to start the eG SuperManager.

    Figure 18 : Providing the credentials of the database administrator to create the new database user

  20. Alternately, if you choose to configure an Microsoft SQL server database as the eG backend, then setup first requests you to indicate whether/not the Microsft SQL server in your environment is NTLMv2-enabled (see Figure 19). If so, click the Yes button in the message box of Figure 19. If not, click the No button.

    Figure 19 : Confirm whether or not the Microsoft SQL server is NTLMv2-enabled

  21. Next, Figure 20 will now appear requesting you to confirm whether/not a Microsoft SQL server is running in your environment. Specify Yes if Microsoft SQL server is running in your environment.

    Figure 20 : Specify if Microsoft SQL server is running in your environment

    If you select Yes from Figure 20, then before proceeding with the setup, ensure that the Prerequisites discussed under the Prerequisites for using an Microsoft SQL Server Database topic.

  22. If an existing Microsoft SQL server is chosen to be used by the eG SuperManager, specify the host name/IP address and the port number of the Microsoft SQL server as in Figure 21. If the Microsoft SQL server being configured uses named instances, then specify ‘none’ instead of the port number in Figure 21. Then, click the Next button to proceed.

    Figure 21 : Specifying the hostname/IP address and port number of the MS SQL server

    If the Microsoft SQL server being configured uses named instances, then specify ‘none’ instead of the port number in Figure 21. Then, click the Next button to proceed.

    Note:

    • If the Microsoft SQL server being configured is part of a Microsoft SQL Cluster, then make sure you specify the virtual cluster IP address / cluster name as the hostname / IP address of the Microsoft SQL server in Figure 21.
    • If the Microsoft SQL server being configured is part of an SQL AlwaysOn Availability Group, then make sure you specify the name of the availability group listener as the hostname / IP address of the MS SQL server. An availability group listener is the name of the SQL server to which clients can connect in order to access a database in a primary or secondary replica of an AlwaysOn availability group. If such a SQL server is not configured with a listener name, then enter the virtual cluster IP address or cluster name against hostname / IP address.
  23. If ‘none’ is specified in Figure 21, then clicking on the Next button will open Figure 22 wherein the instance name is to be specified. Then, click the Next button in Figure 22.

    Figure 22 : Specifying the name of the SQL server instance to use

  24. Specify Yes in Figure 23 if the Microsoft SQL server running in your environment is SSL enabled. If not, press the No button.

    Figure 23 : Specify if SSL support is enabled for the MS SQL server

  25. Now, you will be required to specify if a new database has to be created in the Microsoft SQL server for the eG SuperManager. If you wish to create a new database, specify Yes in Figure 24.

    Figure 24 : Specify if a new database needs to be created

  26. Specify the name of the database that you wish to create in Figure 25.

    Figure 25 : Enter the name of the new database

  27. Since a new database instance can be created only by an administrator of the database server, next specify the user name and password for the database administrator. If Windows Authentication is enabled on the Microsoft SQL server, then ensure that the credentials of a valid Windows domain user with database administrator privileges are provided in Figure 29. Also, make sure that the user name is of the format domainname\username. For e.g., if the name of the database administrator is dbadmin and the domain name is chi, the user name you specify in Figure 29 should be: chi\dbadmin.

    On the other hand, if Mixed Mode Authentication is enabled on the MS SQL server, then the database administrator name that you specify need not necessarily be preceded by the domain name. In this case therefore, your user name specification can be of either of the following formats: username or domainname\username.

    However, if SQL Server Authentication is enabled on the MS SQL server, then the database administrator name should not be prefixed by a domain name. Your specification should then be only, username.

    Figure 26 : Specifying the database administrator user name and password for an MS SQL server with Windows Authentication enabled

    Figure 27 : Provide the database administrator credentials for creating the new database

    Note:

    Ensure that the DBA user name you provide does not contain any special characters.

    By default, manager setup displays the sa user name as depicted by Figure 30. If, due to security concerns, you decide not to use the sa user name and password, then you can create a user with the following server roles: securityadmin, serveradmin, and public, and then provide that user’s credentials when setup prompts you for the DBA’s user name and password. Figure 28, Figure 29, and Figure 30 depict how to create a new user with the aforesaid privileges using the Microsoft SQL Server Management Studio.

    Figure 28 : Selecting the option to create a new user login

    Figure 29 : Creating a new user

    Figure 30 : Granting the requisite privileges to the new user

    Note:

    • Make sure that user name you provide for the new DBA user does not contain special characters.
    • Also, ensure that either provide a strong password for the user. Strong passwords are defined by the following parameters:

      • Has at least 6 characters
      • Does not contain “Administrator” or “Admin”
      • Contains characters from three of the following categories:

        • Uppercase letters (A, B, C, and so on)
        • Lowercase letters (a, b, c, and so on)
        • Numbers (0, 1, 2, and so on)
        • Non-alphanumeric characters (#, &, ~, and so on)
        • Does not contain the corresponding username

    For instance, if the name of the special database user is egdb, then the password that you set for this user should be a strong password such as, db123$%#@. Note that without a ‘strong password’, the eG Supermanager installation will fail.

    If you do not want to provide a strong password, then, make sure that the Enforce password policy option is disabled while creating the user profile in the Microsoft SQL Server Management Studio.

  28. Once the database is created, a special database user account is required to access the database and store the data of the eG SuperManager. Specify the credentials of the database user account in Figure 31. Here again, if Windows Authentication is enabled on the MS SQL server, then the new user should be a valid Windows domain user. Accordingly, the user name should be of the format domainname\username. For eg., if the name of the new user is egdb and the domain name is sig, the user name you specify in Figure 31 should be: sig\egdb.

    On the other hand, if Mixed Mode Authentication is enabled on the MS SQL server, then the special user account you create need not necessarily be preceded by the domain name. In this case therefore, your user name specification can be of either of the following formats: username or domainname\username.

    However, if SQL Server Authentication is enabled on the MS SQL server, then the user name should not be prefixed by a domain name. Your specification should then be only, username.

    Figure 31 : Creating a new database user account in the newly created database

    Note:

    • Make sure that user name you provide for the new DBA user does not contain special characters.
    • Also, ensure that either provide a strong password for the user. Strong passwords are defined by the following parameters:

      • Has at least 6 characters
      • Does not contain “Administrator” or “Admin”
      • Contains characters from three of the following categories:

        • Uppercase letters (A, B, C, and so on)
        • Lowercase letters (a, b, c, and so on)
        • Numbers (0, 1, 2, and so on)
        • Non-alphanumeric characters (#, &, ~, and so on)
        • Does not contain the corresponding username

      For instance, if the name of the special database user is egdb, then the password that you set for this user should be a strong password such as, db123$%#@. Note that without a ‘strong password’, the eG Supermanager installation will fail.

  29. You will now be required to specify the install directory of the eG SuperManager. The default is C:\ (see Figure 32).

    Figure 32 : Specify the destination folder for installation

  30. Once you provide the install directory, the setup will display the settings provided by you as in Figure 33. If you wish to change any of the settings provided, you can click on the Back button in Figure 33 and specify the settings of your choice.

    Figure 33 : Viewing the current settings provided so far

  31. Setup next tries to access the database server and create the user account specified in Step 26. If the user name already exists in the database, an alert message as shown in Figure 34 appears. The user needs to now specify if he/she wants to use the same account or not. If the user chooses not to use the same account, he/she is made to repeat step 26 to create a new user account. However, if the user chooses to proceed by selecting the Yes option in Figure 34, he/she is directly taken to step 31 of this setup process.

    Figure 34 : Message box indicating the existence of a database user

    Note:

    If you want to set an existing database user as the eG database user, then make sure you grant dbowner privileges to such a user.

  32. Database administrator privileges are required for creating a new database user. The Setup now prompts the user to enter the database administrator’s name and password as in Figure 35. The default value for the DBA user name will be sa. For more information about your environment, contact your database administrator.

    Figure 35 : Setup program seeking the name and password of a database administrator

    Note:

    Ensure that the DBA user name you provide does not contain any special characters.

  33. Clicking on Next in Figure 35 will start the installation process. Once the installation completes, Figure 36 will appear informing you of the successful installation of the eG SuperManager. It is recommended that you choose to restart your system before proceeding to start the eG SuperManager.

    Figure 36 : Completion of SuperManager installation

  34. Finally, click the Finish button in Figure 36.