Initializing help system before first use

Editing the application.properties Files

The Xpress Insight application has numerous settings that can be configured to adjust the behavior of the system. These settings are defined in the application.properties file for the Insight Server, or the application.properties file for the Insight Worker.
Note:
  • These files are located in the <SERVER_CONFIG_DIR> and <WORKER_CONFIG_DIR>, respectively. For more on these locations see Important Note about this Guide.
  • The application.properties files are read on service start up. The Insight Server or Worker process must be restarted in order for any configuration changes you make to take effect.

The application.properties file format

The following rules should be adhered to when editing the .properties file:

  • Comment lines begin with a ‘#’.
  • Lines with "properties" contain a key and a value separated by a delimiting character. There are 3 delimiting characters: '=' (equal), ':' (colon) and ' ' (space).

    We recommend using ‘=’.

    For example: insight.server.system.url=http://localhost:8080

  • A word on a line will just create a key with no value.
  • White space that appears between the key, the value and the delimiter is ignored.
    These are equivalent:
    • insight.server.system.environment.type=development
    • insight.server.system.environment.type = development
  • Keys with the same name will be overwritten by the key that occurs later in a file.

    Even if there are different values, in the following example, the value will be 9080.

    • server.port=8080
    • server.port=9080
  • Adding a \ at the end of the line means the value continues on the next line.

    For example, insight.server.persistence.portation-path=./a/very/very/very/\

    very/long/path

  • If you want the value to include a \ then it needs to be escaped by another \. For the value to continue over the next line there must therefore be an odd number of \ at the end.

    For example, compare the following two lines:

    insight.server.persistence.portation-path=C:\\my\\path

    insight.server.persistence.portation-path=C:\\my\\\

    path

  • Whitespace characters at the beginning of a line are stripped.
  • Use \n and \r to include newlines and carriage returns in a value.

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.