Configure the Java wrapper

The Java wrapper allows Java applications to run as independent services (in Windows) or daemons (in Linux). The Output Generator's wrapper.conf file is used to identify the Output Generator's Java libraries and maximum Java heap size.

It can also be used to customize the Output Generator Windows service name and description.

To configure the Output Generator's Java wrapper:

  1. Open the %OutputGenDir%/conf/wrapper.conf file.
    Note: If this is the first time that you are installing the Output Generator, open the wrapper.conf.empty file and save it as wrapper.conf (remove the empty suffix).
  2. Set the wrapper.java.command value to point to the Java executable on the host server.

    For example:

    Windows example:
    #********************************************************************
    # Wrapper Java Properties
    #********************************************************************
    # Java Application
    wrapper.java.command=C:\Program Files\Java\jre7\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\jre7\bin\java.exe
    wrapper.java.command=/usr/java/latest/bin/java
    #wrapper.java.command=java
    Some notes:
    • If you keep the default value (wrapper.java.command=java), the Output Generator will use the Java executable specified in the PATH variable. While this may work, IXIASOFT 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.
  3. Configure the Java heap size.

    For example:

    # 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 Output Generator activities. As a rule of thumb, IXIASOFT 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 your observe performance 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 will compromise the Output Generator's performance.
  4. (Optional, for Windows only): Customize the Output Generator Windows service name and description.
    1. Modify the name of the service:

      For example:

      # Name of the service
      wrapper.ntservice.name=OutGen 
      Note: Embedded space characters are not allowed.
    2. Modify the display name of the service:

      For example:

      # Display name of the service
      wrapper.ntservice.displayname=Ixiasoft OutGen 
    3. Modify description of the service:

      For example:

      # Description of the service
      wrapper.ntservice.description=DITA CMS Output Generator
  5. Save and close wrapper.conf.

While you can change the logging level for Output Generator events in the wrapper.conf file, this is not recommended. To change the logging level, use the log4j.properties file in the Output Generator's configuration directory.