Configuration file

All API versions load a configuration file at startup during the initialize request. Parameters in the file override hardcoded default values. They fall into the following categories:
  • Infrastructure
  • Diagnostics
Notes:
  1. All parameters are optional.
  2. Several parameters can also be overwritten by the client.
The following table shows the parameters that you can use in the configuration file.
Table 1. Configuration file parameters
Name Description Type Default Java™ API
Process Server Primary Host Business Rules Server primary host to which to connect. String 127.0.0.1 Infrastructure
Process Server Primary Port Port number for the primary host. Decimal 2005 Infrastructure
Process Server Secondary Host Business Rules Server secondary host to which to connect. It is used when the primary host is not available. String MY-MACHINE-NAME Infrastructure
Process Server Secondary Port Port number for the secondary host. Decimal 2005 Infrastructure
Decision Response Timer Amount of time to wait for a general response from the Business Rules Server. Decimal 2000 Infrastructure
Decision Request Timer Maximum time the Business Rules Server remains inactive between decision requests. Decimal 20000 Infrastructure
Workflow Name of the workflow to use String Sample1 Workflow Infrastructure
ClientRef Client Reference identifies the application or workstation. String JavaApi (for Java applications) Infrastructure
Log File Name Path and name of the log file to be used. String PayDrAPI.log * Infrastructure
Trace Use this parameter to see more information in the log. However, turning on tracing can cause a sorter to have lates. Boolean FALSE N/A
Timer Enables timing collection Boolean FALSE Diagnostics
Timer File Name Path and name of the timer file to be used. String PayDrAPI.tmr * Diagnostics
Timer Iterations Number of timing buffer entries. Decimal 1000 Diagnostics
Timer Groupings Number of timings to group for each line of output to the file. Decimal 1000 Diagnostics
Remote Spx Enables SPX buffers to be sent to the Business Rules Server. Boolean FALSE N/A
Remote Npr Enables normalized payment record data fields to be sent to and received from the Business Rules Server. Boolean FALSE N/A
Message Buffer Count Number of active message buffers. Decimal 8 N/A
Dump File Name Name of snapshot file. String   N/A
Dump Retain Init Message Keep the initialize message upon message buffer wrap. Boolean FALSE N/A
Dump Format File Too Write a formatted ASCII version of the dump file in addition to the binary form. Boolean FALSE N/A
Dump Trigger On Term Take a snapshot when the terminate message is received. Boolean FALSE N/A
Disable Auto Term Set to on to run PayDrApi under Sort Logic in a multi-process manner Boolean FALSE N/A
* - This parameter is a full path name, which differs between different operating systems.