Configure the CCMS Output Generator's Java wrapper

The fifth task when you install a new IXIA CCMS Output Generator is to configure the Java wrapper, which allows Java applications to run as independent services in Windows daemons in Linux.

1. Open the %OutputGenDir%/conf/wrapper.conf directory.
2. Choose one of the following actions:
   • If this is a first-time installation of the CCMS Output Generator, locate the wrapper.conf.empty file, remove the empty suffix, and save it as wrapper.conf.
   • If you already have a wrapper.conf file installed with your customized configurations, you must migrate content from the wrapper.conf.empty file provided in the install zip file into the wrapper.conf already in use by taking the following actions:
     1. From the wrapper.conf.empty file in the install zip file, copy the Wrapper Licensed Properties content exactly as it is from line 5 to line 22, and then paste it into your existing wrapper.conf file, replacing the current content from lines 5 to 9.

        
        #********************************************************************# Wrapper License Properties
        #********************************************************************
        # Professional and Standard Editions of the Wrapper require a valid
        # License Key to start. Licenses can be purchased or a trial license
        # requested on the following pages:
        # http://wrapper.tanukisoftware.com/purchase
        # http://wrapper.tanukisoftware.com/trial
        
        # The Wrapper will look for either of the following optional files for a
        # valid License Key. License Key properties can optionally be included
        # directly in this configuration file.
        #include ../conf/wrapper-license.conf
        
        # The following property will output information about which License Key(s)
        # are being found, and can aid in resolving any licensing problems.
        #wraper.license.debug=TRUE
        #********************************************************************

     2. Copy the wrapper-license.conf file from the 7.3 CCMS Output Generator upgrade kit into the existing conf directory.
3. Set the wrapper.java.command value to point to the Java executable on the host server.
   Windows example:

   #********************************************************************
   # Wrapper Java Properties
   #********************************************************************
   # Java Application
   wrapper.java.command=C:\Program Files\Java\jdk-11\bin\java.exe
   #wrapper.java.command=/usr/java/latest/bin/java
   #wrapper.java.command=java

   Linux example:

   #********************************************************************
   # Wrapper Java Properties
   #********************************************************************
   # Java Application
   #wrapper.java.command=C:\Program Files\Java\jdk-11\bin\java.exe
   wrapper.java.command=/usr/java/latest/bin/java
   #wrapper.java.command=java

   Some notes:

   • If you keep the default value of the last line as it is, wrapper.java.command=java, the CCMS Output Generator uses the Java executable specified in the PATH variable. While this may work, recommends that you point to the Java executable that you want to use.
   • The examples above specify an absolute path to the Java executable, but you can also specify a relative path.
4. Configure the Java heap size.

   # Maximum Java Heap Size (in MB)
   wrapper.java.maxmemory=2048

   Tip: Maximum heap size is the maximum amount of memory the Java Virtual Machine (JVM) is allowed to allocate for CCMS Output Generator activities. MadCap Software recommends a value of 2048 MB for a 64-bit system, or 1024 MB for a 32-bit system. You can increase this value if you observe out-of-memory issues.

   Restriction: The 64-bit Java has no predefined upper limit for Java heap size. Be careful to set the maximum value of the heap size so that it does not exceed the physical memory. Otherwise, the machine will swap out the memory to disk, which compromises the CCMS Output Generator's performance.
5. When SSL is enabled on IXIA TEXTML Server, update the configuration of the Java wrapper for CCMS Output Generator to connect to a Content Store by taking the following actions:
   1. In the wrapper.conf file, uncomment the following lines after line 60, which define the keystore location and password properties, by removing # from the beginning of the line.

      wrapper.java.additional.4=-Djacorb.security.keystore=%JAVA_HOME%/lib/security/cacerts
      	wrapper.java.additional.5=-Djacorb.security.keystore_password=changeit

   2. Change the variable %JAVA_HOME% to the actual path of the Java installation used by the CCMS Output Generator.
6. In an instance where you do not want the service to automatically restart, such as on a test server, find wrapper.ntservice.starttype and change the default setting of AUTO_START to DEMAND_START.
7. Optional: Customize the CCMS Output Generator Windows service name and description.
   1. Modify the name of the service.

      # Name of the service
      wrapper.ntservice.name=OutGen 

      Note: Embedded space characters are not allowed.
   2. Modify the display name of the service.

      # Display name of the service
      wrapper.ntservice.displayname=IXIA OutGen 

   3. Modify the description of the service.

      # Description of the service
      wrapper.ntservice.description=Output Generator

8. Save and close the wrapper.conf file.