1.6 Running the Retain Server Configuration Wizard

After installing the Retain Server, you must run the initial configuration wizard to prepare the server for working with all the components that will constitute your Retain deployment.

Do the following:

  1. On an administrative workstation, open a supported administrative web browser.

  2. Go to http://RetainServer-IP-or-DNS/RetainServer.

  3. Run the wizard to configure the Retain Server as outlined in the following table.

    Table 1-1 Running the Retain Server Configuration Wizard

    Panel or Prompt

    Action

    Information

    Welcome > File Path

    1. Set the paths for Retain as planned in Storage Planning in Planning.

      By default, all data is stored as follows:

      • Linux: /var/opt/beginfinite/retain

      • Windows: C:\Retain

      By default, zookeeper path is as follows:

      • Linux: /var/opt/beginfinite/retain

      • Windows: \Retain\zookeeper

      Retain derives all file paths from this base path.

      Retain derives all file paths from this base path.

    2. If you need to alter the base path, select Custom in the drop-down list and specify an alternate path.

      IMPORTANT:

      • As outlined in Setting Custom Storage Path Rights on Linux in Planning, specifying an alternate storage path on a Linux system requires that you grant sufficient rights to Retain before running this wizard.

      • Ensure that the ownership of the base path is set to tomcat:www, otherwise, the runtime Zookeeper directory creation fails. For more information, see the Indexes section in the Planning guide.

    3. To customize the path for each item (attachments, XML mappings, etc.), click Advanced Settings and disable the Derive all file locations from above specified path? option.

    4. When the path settings are complete, click Continue.

    Storing data on separate volumes can yield significant performance increases. Therefore, Retain lets you specify where you want to store archived data, indexes, and so on.

    If you are running Retain on a Windows Server, Solr9 disallows the use of Windows SMB shares on the UNC format, such as\\myhost\myshare\mypath. For the indexer storage path, you are can use a drive and mount later. As a workaround, map the storage path in UNC format to a symbolic link folder on the local drive:

    1. On the server where Retain is running, run the following command in the Windows Command Prompt: mklink /D C:\myLink \\IP address\c\Retain\Index In the above command, C:\myLink corresponds to the linked folder on the local drive and \\IP address\c\Retain\Index corresponds to the storage path in UNC format.

    2. Ensure that the Retain Tomcat service is running as a user who has access to the shared folder. If not, please update the service and restart Tomcat.

    Message Store Database

    1. Enter the database connection information for the database you created in Creating and Maintaining an SQL Database.

    2. Click the Enable SSL check box to secure the database connection to Retain.

      Else, click Continue and proceed to Configuration Database.

    3. If the SSL is enabled and the database type is MariaDB, MySQL, PostgreSQL, and MSSQL, select one of the options from the Choose Trust Mode dropdown list.

      • Allow only trusted certificate: This allows only trusted certificates and you can upload the SSL certificate created during SSL configuration.

      • Allow all certificate: if this option is selected, and the SSL is configured with the database, then all the certificates are trusted.

      If your database type is Oracle, the Private Key and Certificate will be a single file and you must provide an alias name and password while uploading the certificate .

    4. Browse to and select the Database client server’s Private Key and Certificate files that you identified in Securing the Database Connection in the Planning guide. Following are the supported and certified files formats:

      • MSSQL - .pfx

      • Postgres - .pem and .crt

      • MariaDB -.pem and .crt

      • MySQL - .pem and .crt

      • Oracle - .p12 

    5. Based on the database type, the certificates can be either a lone certificate or a key pair. The certificate name has to be unique else you will not be able to upload the file. To create a key pair, you must upload the cert.pem first and then the key.pem. Ensure that the alias name given for both the files are same. Only self-signed certificates need to be manually trusted. Registered CA-signed certificates are automatically trusted

    6. Click Continue.

    This is the database that stores meta data for messages and other data archived in the datastore.

    Configuration Database

    1. Enter the database connection information for the database you created in Creating and Maintaining an SQL Database.

    2. Click Continue and continue with Administrator Account

    This is usually the same as the Message Store Database, so all connection information is carried forward to this dialog except the password.

    Administrator Account

    1. Specify and confirm a password for the main administrator account.

    2. Click Continue.

    This account

    • Has all admin rights.

    • Never expires.

    • Can authenticate when the system is offline.

    NOTE:Retain lets you create as many user accounts with administrative roles as you need. If this account is deleted, you will need to contact OpenText support.

    SMTP Notifications

    1. Enter the following information:

      • SMTP Server: The DNS hostname (preferred) or IP address of the SMTP server that Retain should use for emailing notifications.

      • From address: The From address shown on the messages that Retain sends.

      • To address: The address to which Retain sends notifications through the SMTP server.

      • Username: The username for authenticating with the SMTP server.

      • Password: The password for the username.

      • Click Continue.

    Retain uses an SMTP relay host for sending notifications.

    The wizard attempts to send a test message.

    You shouldn’t proceed with setting up Retain until the SMTP test message is successfully delivered. If you see an error, check firewall settings, including local application firewalls running on affected desktops and/or servers.

    If no SMTP is present, you can skip this step by typing skip in the SMTP Mail Server field. This disables Retain’s notification services and is therefore not recommended for production deployments.

    Indexing Engine

    1. Enter the admin password you set earlier.

    2. Click Continue.

      The system initializes and connects to the indexing engine.

    The default port for indexer is 8081. You can change the port if required.

    By default, zookeeper path is as follows:

    • Linux: /var/opt/beginfinite/retain

    • Windows: \Retain\zookeeper

    Retain Server Connections

    1. Set up the Retain Server connection. This sets the connection for the Router (Retain Message Router Configuration Page in Configuration and Administration) and REST applications.

      When possible, use the Retain Server’s DNS hostname so that external devices can resolve to it.

     

    (Optional) Cloud Mobile Service Proxy Connection

    1. (Optional) Configure the Cloud Mobile Service (CMS) Proxy Connection. If you would like to provision and register devices using CMS and have a Proxy server for your Retain server, you can specify the Proxy server information here.

    2. Click Continue > Complete.

      The Retain login prompt displays.