Instance Configuration – Enhanced
System Web Console
>
SymXchange Web Services – Enhanced
>
Instance Configuration – Enhanced
There are optional and required settings you can configure for SymXchange instances in System Web Console.
PROMPT | DESCRIPTION | VALUE OPTION | REQUIRED |
---|---|---|---|
Name | The name of the SymXchange instance | Up to 20 alpha or numeric characters The name must be unique to other instances’ name in the selected SYM | Yes |
Internal Key Configuration | The name of the keystore that has the public key certificates SymXchange uses to connect to external clients | Up to 40 characters | No |
HTTP(s) Port Number | Web server port number | 2001 to 65535 | Yes |
Protocol | Web service protocol | http or https | Yes |
Key Configuration Name | Key configuration name for setting up https | Any key configuration set up in the System Web Console | Yes, if protocol is https |
Key Alias | Key alias in the selected key configuration for setting up https | Any key alias in the selected key configuration | Yes, if protocol is https |
Authenticate Client | Two-way authentication method option | Yes/No | No |
Client Certificate Mapping | Configures a map of the client number to the trust store alias (trusted certificate). SymXchange will authenticate a client using the client’s public key certificate and its client number in the request. The client number is obtained from the Device Mapping configuration. | N/A | Yes, if Authenticate Client is yes |
White List | A list of IPv4 addresses or address ranges from clients who can connect to the web server | Each entry is represented in dot-decimal notation which consists of four decimal numbers, each ranging from 0 to 255, separated by dots Address range is allowed for each decimal number field in the format of mmm-nnn The format above represents an inclusive range of absolute values, with the following shorthand notations: nnn- = nnn-255 -nnn = 0-nnn - = 0-255 | Yes |
Device Number | Number of the device | 0 to 32767 | Yes |
Client Number | Client number to a specific instance | 0 to 39 Important: Requests using client numbers greater than 19 are unable to perform transactions that post a check. | Yes |
The 0 value indicates that balancing is not performed for this device | Yes | ||
Note | Description for the entry | It can be a string of 40 characters or less | No |
PROMPT | DESCRIPTION | VALUE OPTION |
---|---|---|
Max Search Response List Count | The maximum number of records of a single operation type SymXchange can retrieve from a response | 1 to 10000 (default is 1000) |
SymXchange Web Service Posters | The number of posters to run SymXchange web service | 1 to 300 (default is 5) |
Poster Pool Request Timeout ms | The amount of time in milliseconds for the poster pool to respond to a request | 1 to 2000 (default is 2000) |
Logging Threshold CRUD Ops ms | The amount of time in milliseconds for logging CRUD operations | 0 to 60000 (default is 1000) |
Logging Threshold PowerOn Ops ms | The amount of time in milliseconds for logging PowerOn operations | 0 to 60000 (default is 1000) |
Logging Threshold Transactions Ops ms | The amount of time in milliseconds for logging transactions operations | 0 to 60000 (default is 1000) |
Logging Threshold All Other Ops ms | The amount of time in milliseconds for logging all other operations | 0 to 60000 (default is 1000) |
Token Validity minutes | The amount of time in minutes to allow a token to be used as a credentialing method | 1 to 1440 |
Maximum JVM Heap Size mb | The maximum amount of memory allowed for Java™ virtual machine (JVM) settings for the SymXchange instance | 1200 to 5120 |
Minimum JVM Heap Size mb | The minimum amount of memory allowed for Java virtual machine (JVM) settings for the SymXchange instance | 480 to 2048 |
Last updated Fri Mar 3 2023