Tuning Java memory allocation

Allocating more memory to Java often improves the performance of RICOH ProcessDirector. However, it is imperative that you take several factors into consideration before you change this configuration.
Run with the default setting for a while before you consider changing the Java memory allocation. If you repeatedly experience Java out of memory errors, consider increasing the allocation.
Important: We recommend allocating no more than 50% of the available system memory on your system to RICOH ProcessDirector Java processes. This recommendation takes into consideration the memory needs of other parts of RICOH ProcessDirector, such as the database, transforms, custom code, and other components. The recommendation also ensures that the operating system and other tools and utilities have the resources they require to operate.

To tune Java memory allocation:

  1. Check the amount of RAM installed on your system. Divide that number by 2 and write it down.
  2. Check how much memory is allocated to other applications that run on this system.
    Reduce the number you wrote down by the amount of memory each application uses. The resulting value is the total amount of heap memory that is available for you to allocate to Java for all running RICOH ProcessDirector primary and secondary processes.
      Note:
    • If your RICOH ProcessDirector solution requires more memory than the amount determined in this step, we recommend upgrading the system memory to meet the stated guidelines. Allocating more than 50% of available memory to the RICOH ProcessDirector Java heap negatively impacts performance.
  3. Log in to the primary computer as the user who installed RICOH ProcessDirector.
  4. Open %AIWDATA%\config\jvmsettings.cfg in a text editor.
    By default, %AIWDATA% is \aiw\aiw1.
  5. Find the line that looks like this:
    primary=-Xmx2048m -Djava.net.preferIPv4Stack=true -Djava.awt.headless=true

    The value after primary=-Xmx is the maximum amount of heap memory the RICOH ProcessDirector Java run time environment is allowed to use for the RICOH ProcessDirector primary process. In this example, the primary server can use 2048MB (2GB) of RAM for its heap.

  6. Update the -Xmx value to the number you determined in step .
    For example, to allow the primary server use 8GB of heap space, you can specify -Xmx8192m or -Xmx8g
  7. Save and close the file.
  8. Restart RICOH ProcessDirector to apply the changes.

Related information:

Memory usage
Tuning step templates
Parent topic: Performance