MPI Configuration Properties

A config.properties file in the $MPI_CONFIG_HOME directory is used to set configuration options for the MPI.

The available configuration options and their default values are listed below.

Note: If you don't configure a value for one of the properties in your config.properties, the default value as shown below will be used.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
#
# The resource location of the MPI configuration XML (e.g. file:/etc/mpi/mpi.xml)
#
# Use a "file:" prefix for resources located on the file system.
# Use a "http:" prefix for resources loaded from an URL.
# Use a "classpath:" prefix for resources located on the classpath.
#
# If not specified (i.e. empty) this defaults to file:${mpi.config.home}/mpi.xml
# (${mpi.config.home} is the value of the system property "mpi.config.home")
#
# If not specified and the system property "mpi.config.home" is not set this
# defaults to file:${user.home}/.mpi/mpi.xml
# (${user.home} is the user's home directory)
#
mpiConfigXml.resourceLocation=
 
#
# Whether keystore passwords and merchant acquirer passwords (used to authenticate during DS communication)
# in the MPI configuration XML are obfuscated or not.
#
# Make sure to use the mpitool.sh script for obfuscating passwords
# in your MPI configuration when activating this option.
#
mpiConfigXml.useObfuscatedPasswords=false
 
#
# The resource location of the MPI license (e.g. file:/etc/mpi/mpi.lic)
#
# Use a "file:" prefix for resources located on the file system.
# Use a "http:" prefix for resources loaded from an URL.
# Use a "classpath:" prefix for resources located on the classpath.
#
# If not specified (i.e. empty) this defaults to file:${mpi.config.home}/mpi.lic
# (${mpi.config.home} is the value of the system property "mpi.config.home")
#
# If not specified and the system property "mpi.config.home" is not set this
# defaults to file:${user.home}/.mpi/mpi.lic
# (${user.home} is the user's home directory)
#
license.resourceLocation=
 
#
# Should MPI send 3-D Secure error messages to the Access Control Servers
# when they send invalid 3-D Secure messages.
#
errorNotifier.sendErrorMessagesToAcs=true
 
 
#
# Should MPI send 3-D Secure error messages to the Directory Servers
# when they send invalid 3-D Secure messages.
#
errorNotifier.sendErrorMessagesToDs=true
 
#
# The max number of threads in the thread pool of the error notifier.
#
# The error notifier is responsible for asynchronously sending error messages to the
# Directory Server or the ACS, whenever the MPI detects an error in a 3-D Secure
# protocol message received from either the Directory Server or the ACS.
#
errorNotifier.maxThreadPoolSize=10
 
#
# The maximum number of Directory Server clients to cache.
#
# Directory Server clients are cached per client certificate due to the
# expensive setup of the underlying SSL socket factory.
#
dsClient.maxCachedInstances=100
 
#
# The maximum number of connections per-route (i.e Directory Server host)
# held in the connection pool of a Directory Server client.
#
dsClient.maxConnectionPoolPerRouteSize=20
 
#
# The maximum number of connections held in all per-route connection pools.
#
dsClient.maxNumberOfConnectionsOverall=40
 
#
# The time for which the RestTemplate cache would expire, expressed in days.
#
dsClient.cachedInstanceExpiryInDays=1
 
 
#
# The https protocols (i.e. TLS versions) the MPI should use when establishing a connection to the directory servers.
#
dsClient.httpsProtocols=TLSv1.2,TLSv1.1,TLSv1
 
#
# The proxy to use for connecting to the Directory Server (leave empty if not using a proxy).
#
# When specifying an HTTP proxy, HTTPS connections will be tunneled through via the HTTP CONNECT method.
# You may specify a user/password combination in the URL in case your proxy requires authentication.
#
#
# host    : proxy.org
# port    : 8888 (optional; if not specified, the scheme default port will be used)
# scheme  : http
# user    : foo (optional; only specify a user in case your proxy requires authentication)
# password: bar (optional; only specify a password in case your proxy requires authentication)
#
dsClient.proxy=
 
#
# Defines the connection timeout in milliseconds for establishing a TCP/IP connection to the Directory Server.
#
# A timeout value of zero is interpreted as an infinite timeout.
#
dsClient.connectionTimeoutInMilliseconds=3000
 
#
# Defines the socket timeout in milliseconds for communication with the Directory Server.
#  (The socket timeout is the timeout for waiting for data  or, put differently,
#   the maximum period of inactivity between two consecutive data packets).
#
# A timeout value of zero is interpreted as an infinite timeout.
#
dsClient.socketTimeoutInMilliseconds=5000
 
#
# Defines if the MPI should send the mastercard tokenization extension in VEReq for all MasterCard PAN/Token requests.
#
dsClient.mastercard.useTokenizationExtension=true
 
#
# Proxy used for connecting to UnionPay inquiry server.
# See details about proxy settings above (dsClient.proxy).
#
upopClient.proxy=
 
#
# Defines the connection timeout in milliseconds for establishing a TCP/IP connection to the UnionPay Server.
#
# A timeout value of zero is interpreted as an infinite timeout.
#
upopClient.connectionTimeoutInMilliseconds=3000
 
#
# Defines the socket timeout in milliseconds for communication with the UnionPay Server.
#
# A timeout value of zero is interpreted as an infinite timeout.
#
upopClient.socketTimeoutInMilliseconds=5000
 
#
# Should MPI use an internal session, used to validate PARes messages,
# or should the external SessionData be provided through the API as part of PaResValidationRequest.
#
sessionEnabled=true
 
#
# The resource location of the session Ehcache configuration XML (e.g. file:/etc/mpi/ehcache.xml)
#
# If the 'sessionEnabled' property (see above) is set to 'false', this property is ignored.
#
# Use a "file:" prefix for resources located on the file system.
# Use a "http:" prefix for resources loaded from an URL.
# Use a "classpath:" prefix for resources located on the classpath.
#
# If not specified (i.e. empty) this defaults to file:${mpi.config.home}/ehcache.xml
# (${mpi.config.home} is the value of the system property "mpi.config.home")
#
# If not specified and the system property "mpi.config.home" is not set this
# defaults to file:${user.home}/.mpi/ehcache.xml
# (${user.home} is the user's home directory)
#
# NOTE: If the 'sessionEnabled' property (see above) is set to 'false', this property is ignored.
#
sessionEhcacheConfigXml.resourceLocation=
 
#
# On the dashboard there is a section with certificates that soon will expire.
# This configuration defines the maximum months that the certificate can be valid and displayed in this section
#
dashboard.certificateWarningExpireTimeInMonths=3
 
#
# On the dashboard in the error sections, for every error type there are details exceptions.
# This configuration defines the maximum number of detailed exception per exception type.
#
dashboard.maxNumberOfDetailedExceptions=3
 
#
# On the dashboard, in the error and transaction sections, the statistics are grouped by time frames.
# This configuration defines the time frames in minutes separated by comma.
# For example, in order to have time frames: 1 min, 1h, 8h 24h the configuration values should be:1,60,480,1440
#
dashboard.runtimeStatisticsTimeFramesInMinutes=1,60,480,1440
 
#
# On the dashboard there is license section showing when the license will expire.
# This configuration property defines how many months before expiration date the license will be checked to show warning on the dashboard. 
#
dashboard.licenseWarningExpireTimeInMonths=1
 
#
# Should the dashboard display failed transaction statistics.
#
dashboard.showTimingStatisticsForFailedTransactions=false
 
#
# Should the HTTP scheme be considered a valid one, when validating the ACS url.
#
# Note: This should not be allowed in a production environment.
#
acsUrlValidation.allowHttpScheme=false
 
#
# Should the MPI start in simulation mode, with no communication to the DS Server.
#
dsResponseSimulation=false
 
#
# The resource location for the Directory Server response simulation file, containing entries in the following format:
#
# <pan>=<enrollment-status>,<acs-url>
#
# Possible values to be used for enrollment status are: Y, N or U
#
# When configuring the response simulation file resource location:
# Use a "file:" prefix for resources located on the file system.
# Use a "http:" prefix for resources loaded from an URL.
# Use a "classpath:" prefix for resources located on the classpath.
#
# If not specified (i.e. empty) this defaults to file:${mpi.config.home}/dsResponseSimulation.properties
# (${mpi.config.home} is the value of the system property "mpi.config.home")
#
# If not specified and the system property "mpi.config.home" is not set this
# defaults to file:${user.home}/.mpi/dsResponseSimulation.properties
# (${user.home} is the user's home directory)
#
dsResponseSimulation.resourceLocation=
 
#
# Regular expression used to validate PANs and resolve the VISA scheme from a PAN.
# For PAN validation within the MPI the PAN must resolve to a supported scheme
# (i.e. the PAN must match one of the configured regular expressions for scheme resolution).
#
panRegex.visa=4[0-9]*
 
#
# Regular expression used to validate PANs and resolve the MasterCard scheme from a PAN.
# For PAN validation within the MPI the PAN must resolve to a supported scheme
# (i.e. the PAN must match one of the configured regular expressions for scheme resolution).
#
panRegex.masterCard=(2|5|6)[0-9]*
 
#
# Regular expression used to validate PANs and resolve the American Express scheme from a PAN.
# For PAN validation within the MPI the PAN must resolve to a supported scheme
# (i.e. the PAN must match one of the configured regular expressions for scheme resolution).
#
panRegex.americanExpress=(34|37)[0-9]*
 
#
# Regular expression used to validate PANs and resolve the JCB scheme from a PAN.
# For PAN validation within the MPI the PAN must resolve to a supported scheme
# (i.e. the PAN must match one of the configured regular expressions for scheme resolution).
#
panRegex.jcb=35[0-9]*
 
#
# Regular expression used to validate PANs and resolve the Diners scheme from a PAN.
# For PAN validation within the MPI the PAN must resolve to a supported scheme
# (i.e. the PAN must match one of the configured regular expressions for scheme resolution).
#
panRegex.diners=36[0-9]*
 
#
# Should the MPI strictly enforce the XML signature syntax requirements as defined by VISA.
#
# There are some ACSs that don't respect the VISA XML signature syntax requirements
# and for example send a SignedInfo.Reference.Transforms element in the PARes.
# Setting this property to false relaxes the XML signature syntax validation to also
# allow such signatures.
#
# If not specified this defaults to true
#
validation.xmlSignatureSyntax.enforceRequirements=true
 
 
#
# Should the MPI strictly enforce the PARes validation.
#
# There are some ACSs that don't respect the Visa syntax requirements
# and for example send a zeroed out pan element in the PARes, for all TransactionStatuses.
# Setting this property to false relaxes the PARes validation to also allow such responses.
#
# If not specified this defaults to true
#
validation.paRes.enforceRequirements=true