Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Externalized OpenCDS configuration options are stored in the locations below:

  • If running as a non-system user:

    %HOME%\.opencds\opencds.properties
    NOTE:


  • If OpenCDS is running on tomcat as a service on a Windows system, the configuration will likely have to live at the root (i.e., C:\as the system user:

    C:\Windows\System32\config\systemprofile\.opencds\opencds.properties), as there is no default user.


This file must contain the first

...

three lines below. 

...

The fourth and fifth lines are optional.
Code Block
languagetext
knowledge-repository.type=<repository type>
knowledge-repository.path=<repository path>
config.security=<path to security config file>
log4j.logfile=<full path to log file>
km.threads=4
  • knowledge-repository.type may be either one of the two three following values:

    • STORE

    • SIMPLE_FILE

    • CLASSPATH

  • knowledge-repository.path is the absolute or relative path to the configuration, depending upon which type is chosen (above).
    • Example configurations for SIMPLE_FILE may include:
      • C:/opencds/opencds-knowledge-repository-data/resources_v1.3
      • C:/opencds-knowledge-repository-data/resources_v1.3
      • etc.
    • The path for the CLASSPATH type is relative to the classpath of the running JVM (e.g., Tomcat).
      • resources_v1.3
  • config.security is the location of the security configuration for the REST services.
  • log4j.logfile is the location used by OpenCDS to write the logs.  This line is optional.  Typical values may include:
    • C:/opencds/opencds.log
    • etc.
  • km.threads is the number of threads per knowledge module.
    • This can increase throughput of the system, depending upon the number of rules being run for each request. 
    • Best practice shows that the number of km.threads should be kept to the same number of CPUs (or CPU cores).

PLEASE NOTE: The paths provided in opencds.properties on a Windows-based system must have either (1) all back-slashes escaped or (2) forward-slashes in place of back-slashes, otherwise the system will not start properly.  For example, if your repository path is at the root folder in C:, e.g., C:\opencds-kr\resourceAttributes, the path configured for knowledge-repository.path must be either C:\\opencds-kr\\resourcesAttributes or C:/opencds-kr/resourcesAttributes (note the forward-slashes).