Developer Programs

Learn

Docs

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.

PROMPTDESCRIPTIONVALUE OPTIONREQUIRED
NameThe name of the SymXchange instanceUp to 20 alpha or numeric characters The name must be unique to other instances’ name in the selected SYMYes
Internal Key ConfigurationThe name of the keystore that has the public key certificates SymXchange uses to connect to external clientsUp to 40 charactersNo
HTTP(s) Port NumberWeb server port number2001 to 65535Yes
ProtocolWeb service protocolhttp or httpsYes
Key Configuration NameKey configuration name for setting up httpsAny key configuration set up in the System Web ConsoleYes, if protocol is https
Key AliasKey alias in the selected key configuration for setting up httpsAny key alias in the selected key configurationYes, if protocol is https
Authenticate ClientTwo-way authentication method optionYes/NoNo
Client Certificate MappingConfigures 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/AYes, if Authenticate Client is yes
White ListA list of IPv4 addresses or address ranges from clients who can connect to the web serverEach 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-255Yes
Device NumberNumber of the device0 to 32767Yes
Client NumberClient number to a specific instance0 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 deviceYes
NoteDescription for the entryIt can be a string of 40 characters or lessNo
PROMPTDESCRIPTIONVALUE OPTION
Max Search Response List CountThe maximum number of records of a single operation type SymXchange can retrieve from a response1 to 10000 (default is 1000)
SymXchange Web Service PostersThe number of posters to run SymXchange web service1 to 300 (default is 5)
Poster Pool Request Timeout msThe amount of time in milliseconds for the poster pool to respond to a request1 to 2000 (default is 2000)
Logging Threshold CRUD Ops msThe amount of time in milliseconds for logging CRUD operations0 to 60000 (default is 1000)
Logging Threshold PowerOn Ops msThe amount of time in milliseconds for logging PowerOn operations0 to 60000 (default is 1000)
Logging Threshold Transactions Ops msThe amount of time in milliseconds for logging transactions operations0 to 60000 (default is 1000)
Logging Threshold All Other Ops msThe amount of time in milliseconds for logging all other operations0 to 60000 (default is 1000)
Token Validity minutesThe amount of time in minutes to allow a token to be used as a credentialing method1 to 1440
Maximum JVM Heap Size mbThe maximum amount of memory allowed for Java™ virtual machine (JVM) settings for the SymXchange instance1200 to 5120
Minimum JVM Heap Size mbThe minimum amount of memory allowed for Java virtual machine (JVM) settings for the SymXchange instance480 to 2048
Last updated Fri Mar 3 2023