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



    Welcome > File Path

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

      By default, all data is stored as follows:

      • Linux: /var/opt/beginfinite/retain.

      • Windows: C:\Program Files\Beginfinite\Retain.

      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 Retain 4.9.2: Planning, specifying an alternate storage path on a Linux system requires that you grant sufficient rights to Retain before running this wizard.

    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.

    Message Store Database

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

    2. If your database type is MySQL or MariaDB and you want to secure its connection to Retain, click the Enable SSL option and proceed to the next step.

      Otherwise, click Continue and proceed to Configuration Database.

    3. Under SSL Configuration > KeyStore click Add New KeyStore Entry.

      The KeyStore contains certificates and keys for client services on this Retain server. In this case, this is the Retain database client on this Retain server.

    4. Type and confirm a password for the KeyStore.

      This establishes the password for the KeyStore on this Retain server.

    5. The KeyStore Alias field specifies an identifying name for this server’s database clients credentials that are stored in the KeyStore. The name identifies the credentials in the Digital Certificates Tab in the browser-based management utility.

      Accept the default name or modify it if desired.

    6. Browse to and select the Database client server’s Private Key and Certificate .pem files that you identified in Securing the Database Connection in the Retain 4.9.2: Planning guide.

    7. The TrustStore contains the certificate and keys for database server.

      Under TrustStore, type and confirm a TrustStore password, accept or modify the TrustStore Alias, and browse to and select the database server’s certificate .pem file.

    8. Clck 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. If you are securing the connection with the Retain server, complete the KeyStore and TrustStore steps as needed, referring to the instructions for the Message Store Database as needed.

    3. 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.

    Retain lets you create and specify a separate database if desired.

    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 Micro Focus 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. Obviously, 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.


    Retain Server Connections

    1. Set up the Retain Server connection. This sets the connection for the Router (Retain Message Router Configuration Page in Retain 4.9.2: Configuration and Administration) and REST applications, such as Retain Publisher (Retain Publisher and Viewer in Retain 4.9.2: User Guide).

      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.