Install and configure TEXTML Server 4.4

The upgrade procedure begins with installing the new TEXTML Server.

About this task

The supplied instructions are based on a sample deployment where TEXTML Server 4.3 contains a ProdX docbase at /docbases/TEXTML43/ProdX ready for upgrade to version 4.4.
Important: If your deployment uses replication or clustering, contact IXIA CCMS Customer Support before you begin the upgrade process, since your instructions may differ.

To install and configure TEXTML Server 4.4:

Procedure

  1. Install TEXTML Server 4.4.
    Note: You can install TEXTML Server 4.4 on the same machine as TEXTML Server 4.3 without one overriding the other. See Installing and Configuring IXIA TEXTML Server for IXIA CCMS.
  2. To update the TEXTML Server 4.4 configuration, replace the default values from the TextmlServerCfg.xml file in version 4.4 with the version 4.3 values.
    1. Open the TextmlServerCfg.xml file for each version.
      In Windows, open C:\ProgramData\IxiaSoft\TextmlServer43\TextmlServerCfg.xml and C:\ProgramData\IxiaSoft\TextmlServer44\TextmlServerCfg.xml.
    2. As you locate each of the following parameters in version 4.3, copy its value, and replace the default version 4.4 parameter value.
      • MaxThreadCount
      • UseICUWordParsing
      • ConnectionTimeOut
      • RecyclingInterval
      • HeartBeatFrequency
      • PrependDate
      • DaysOfLogToPreserve
      • LogCalls
      • LogCallsDaysToPreserve
      • AllocateMultiplePools
      • LeaveFree
      • ReduceCacheOnIdle
      • CacheMaximumMemory
      • ForceMainMemory
      • Preload
      • MaxWildcardOccurrences
    3. Locate the Endpoint parameter in version 4.4 and replace the default value with the port number for TEXTML Server 4.4. See "Server parameters for configuration file" in Installing and Configuring IXIA TEXTML Server 4.4 for IXIA CCMS.
      Important: If you installed TEXTML Server 4.4 on the same machine as TEXTML Server 4.3, establish a temporary port number for TEXTML Server 4.4 and edit the version 4.4 configuration to replace the default port number with the new port number.
      Note: If your deployment uses Kerberos authentication, it is not possible to connect to TEXTML Server version 4.4 while it is running with a port number other than the one defined in the Service Principal Names (SPN) in the Active Directory. You can only connect to it once you complete the upgrade and configure TEXTML Server 4.4 to use the port number defined in the Service Principal Names (SPN).
    4. Locate the File parameter in version 4.4 and replace the default value, such as log/textml_log.txt, with the appropriate path.
      Note: If the TEXTML Server process has sufficient permission, it automatically creates the path.
      Important: If you installed TEXTML Server 4.4 on the same machine as TEXTML Server 4.3, make sure you configure each version of TEXTML Server with a different path. The TEXTML Server instances cannot share the same log file.
    5. Locate the LogCallsFilename parameter in version 4.4 and replace the default value, such as log/logcalls, with the appropriate path.
      Important: If you installed TEXTML Server 4.4 on the same machine as TEXTML Server 4.3, make sure that each version of TEXTML Server is configured with a different path. The TEXTML Server instances cannot share the same log file.
      Note: The path will be created automatically if the TEXTML Server process has sufficient permission.
    6. Locate Security parameter under the Server section in version 4.3, copy the entire block, and then replace the existing block in the version 4.4 file.
      In Windows, replace the following default lines in the version 4.4 file with those from version 4.3 that include additional values for ServerAdmin and ServerUser.
      <Security>
         <!-- Enables user authentication. Two types of authentication are available: Kerberos (Windows only) and local authentication -->
         <!-- False: accepts any username and password -->
         <AuthenticateUsers>True</AuthenticateUsers>
         <!-- Determines whether to filter the search results according to the user's collection permissions. -->
         <SearchSecurityEnabled>False</SearchSecurityEnabled>
         <!-- Enables the usage of Kerberos protocol to authenticate users. -->
         <AuthenticateUsingKerberos>True</AuthenticateUsingKerberos>
         <!-- If True, TEXTML Server will authenticate its users locally on the system it is currently running. -->
         <AuthenticateLocal>False</AuthenticateLocal>
         <ServerAdmin>
           ...
         </ServerAdmin>
         <ServerUser>
           ...
         </ServerUser>
      </Security>
      
    7. If you use the Secure Sockets Layer (SSL) protocol to provide secure communications in the deployment, locate SSL parameter in version 4.3, copy the entire block, and replace the existing block in the version 4.4 file.
      In Windows, replace the identified default lines in the version 4.4 file with the ones from version 4.3.
      <SSL>
            <!-- Determines whether client-server transactions are encrypted. -->
            <UseSSL>True</UseSSL>
            <!-- If UseSSL is True, determines the port used. -->
            <SSLPort>2551</SSLPort>
            <!-- If UseSSL is True, this parameter may be set to False to give users the option of using another protocol as well.
      		If UseSSL is False, the UseSSLOnly value is ignored. -->
            <UseSSLOnly>True</UseSSLOnly>
            <!-- Specifies the path to the security certificate for the TEXTML Server server. -->
            <CertificatePath>./Certificates/</CertificatePath>
            <!-- Specifies the path to the private key. -->
            <PrivateKeyPath>./Certificates/</PrivateKeyPath>
            <!-- Specifies the path to the security certificate for the client server. On windows machines, C:\ProgramData\IxiaSoft\TextmlProxy\Certificates is a good place on Linux: /opt/ixiasoft/certificates -->
            <ClientCertificatePath>./Certificates</ClientCertificatePath>
      </SSL>
      Important: If you installed TEXTML Server 4.4 on a different machine than TEXTML Server 4.3, confirm the server name for TEXTML Server 4.4 is a valid name for the SSL certificate. Otherwise, you may need to generate a new certificate.
    8. If you use the Secure Sockets Layer (SSL) protocol to provide secure communications in the deployment, copy the certificates from your TEXTML Server 4.3 installation to your 4.4 installation.
      In Windows, copy the certificate file from C:\ProgramData\IxiaSoft\TextmlServer43\Certificates to C:\ProgramData\IxiaSoft\TextmlServer44\Certificates.
    9. Locate Security parameter under the DocumentBaseProperties section in version 4.3, copy the entire block, and paste the block in the version 4.4 file right before the closing DocumentBaseProperties element.
      . . . 
      <Security>
            <DBAdmin>
              <value NAME="company\Group-Admins"></value>
            </DBAdmin>
            <DBUser>
              <value NAME="company\Group-Admins"></value>
              <value NAME="company\Group-Users"></value>
            </DBUser>
      </Security>
      </DocumentBaseProperties>
    10. If IXIA CCMS Customer Support instructed you to change any other values in the TextmlServerCfg.xml file in version 4.3 to meet your deployment's needs, please contact IXIA CCMS Customer Support to determine if you still need to replace those same parameter values in the 4.4 version with those from version 4.3.
    11. Save the TextmlServerCfg.xml file for TEXTML Server version 4.4.
  3. If you use the Secure Sockets Layer (SSL) protocol to provide secure communications in the deployment and you installed TEXTML Server version 4.4 on a different machine from where version 4.3 is installed, copy the root and intermediate certificates in hash format from TEXTML Server version 4.3 and paste it in the matching location in the version 4.4 installation. For example, in Windows you would copy the C:\ProgramData\IxiaSoft\TextmlProxy folder.
  4. Verify the TEXTML Server license uses the same license.
    Note: Both TEXTML Server versions use the same license. If you installed TEXTML Server 4.4 on the same machine as TEXTML Server 4.3 and the license is in the default location, such as C:\ProgramData\IxiaSoft\Licensesin Windows, then you do not need to make any further changes. If TEXTML Server 4.4 is not installed on the same machine, then contact MadCap Software for a new license.
  5. Start the IXIA TEXTML Server server 4.4 service.
  6. Examine the logs to confirm that TEXTML Server 4.4 successfully started. For example, in Windows open the textml_log.txt file in C:\ProgramData\IxiaSoft\TextmlServer44\Log\ and look for error messages.