Tuning conversion performance for HCL Docs

To tune conversion performance for the first time a user views a document, make sure to complete the procedure for each Conversion server.

Procedure

  1. Stop the server instances:
    1. Log into the IBM Conversion Server with an administrator account.
    2. Navigate to Start > Administrative Tools > Task Scheduler.
    3. Click Task Scheduler Library.
    4. Right-click the following tasks and select End.
      • sym_monitor
      • kill_timeout
    5. Right-click the following tasks and select Disable.
      • sym_monitor
      • kill_timeout
    6. Stop the WebSphere Application server instance on the Conversion server.
    7. Open Task Manager and confirm that all soffice.bin process are terminated.
  2. Modify the instance parameters:
    1. Open the directory conversion_install_root(for example, C:\IBM\IBMConversion\\symphony.
    2. By default, four instances of the IBMConversion process are created. This can be increased as needed.
    3. Copy the inst0 directory and duplicate it so that there is one directory for each conversion instance. For example if you want eight instances, you should have directories inst0 to inst7.
    4. Open the following file with a text editor:
      C:\IBMConversion\symphony\sym_monitor\instances.cfg
    5. Add the following line, modifying the instance ID and port number. The instance ID number should match that last number of the port number. Repeat this process until there is one line corresponding to each directory instance created in the previous step.
    6. Save the file and close the editor.
    7. On deployment manager, open file ${WAS_ROOT}/profiles/Dmgr01/config/cells/${CellName}/IBMDocs-config/conversion-config.json
    8. Locate the line containing: {"host":"127.0.0.1","port":8100},{"host":"127.0.0.1","port":8101},{"host":"127.0.0.1","port":8102},{"host":"127.0.0.1","port":8103}
    9. Add the following information to the end of the line, one for each port number which corresponds to the new instance: {"host":"127.0.0.1","port":<port>}
      Example
      {"host":"127.0.0.1","port":8100},{"host":"127.0.0.1","port":8101},{"host":"127.0.0.1","port":8102},
      {"host":"127.0.0.1","port":8103},{"host":"127.0.0.1","port":8104},{"host":"127.0.0.1","port":8105},
      {"host":"127.0.0.1","port":8106},{"host":"127.0.0.1","port":8107}
    10. Update the used-host-count property to be the value of primary instances (1/2 the total instances deployed - so in this example, you would update it to a value of 4).
  3. Update the number of conversion library instances.
    An additional setting (new in release 1.0.5) that can be modified is the number of conversion library instances. Perform the following steps to update this setting:
    1. On deployment manager, open file ${WAS_ROOT}/profiles/Dmgr01/config/cells/${CellName}/IBMDocs-config/conversion-config.json.
    2. Locate the line containing: maxInstanceNum
    3. Update the number of instances up to twice the number of cores on the host.
    4. Save the file and close the editor.
  4. Restart the server instances
    1. Log into the IBM Conversion Server with an administrator account.
    2. Navigate to Start > Administrative Tools > Task Scheduler.
    3. Click Task Scheduler.
    4. Right-click the following tasks and select Enable.
      • sym_monitor
      • kill_timeout
    5. Right-click the following tasks and select Run.
      • sym_monitor
      • kill_timeout
    6. Synchronize the Conversion nodes.
    7. Start the WebSphere Application server instance on the Conversion server.
    8. Verify that the tuning is complete by uploading a new ODT document to Files. Click Edit in HCL Docs. If the document opens in HCL Docs, the tuning is successful.