Miscellaneous Settings
<threads>0</threads>
By default - or if 0 is specified for the number of threads - each Syniti Match API engine will use all available processor cores. If running multiple processes simultaneously, or if a single process contains two Syniti Match API engines running simultaneously, then the number of processing threads can be set to a specific value. For example, if the machine has a total of 16 cores, for maximum efficiency two simultaneous processes should be set to use 8 threads each; if both used 16 threads, then efficiency could be significantly decreased due to the 32 threads fighting for limited processor resources.
<debug enabled="false"
pathname="C:\Temp\matchIT_Hub_debug.log"
truncate="false"
daily="false"
maxDays="7"
data="true"
generate="true"
compare="true"
errors="false" />
Should a process that uses Syniti Match API unexpectedly crash, the engine can be configured to create a debug log of all data loaded and all operations performed on the data. This can help identify problematic data, which can then be provided to Syniti Support for analysis, or cleaned/purged from the original data source.
Once debug mode has been enabled, restart the process. The specified file will be created and written to as data is added and processed. Performance will be impacted because a lot of information will be logged, so debug mode should be enabled only temporarily until the problematic data has been identified. A utility can be provided, upon request, to help analyze the debug log; please contact Syniti Support for further details.
pathname: The full path and filespec of where to write the log.
truncate: By default, debug information is appended to the debug file. Enabling truncation will cause the file to be cleared of all data when the engine is started, which will ensure that the file contains only the data leading up to the crash. Please enable truncation before providing a debug file to Syniti Support for analysis.
daily: Enable this option to have Match API write to different log files each day. Daily log file names are generated by appending the date to the name of the file specified, e.g.
- matchIT_Hub_debug-2019-10-29.log
- matchIT_Hub_debug-2019-10-30.log
- matchIT_Hub_debug-2019-10-31.log
- ...
maxDays: Use this option in conjunction with the daily option to specify how many daily log files to keep. Files older than maxDays will be automatically deleted.
data, generate, compare: These options enable/disable three kinds of debug logging. Only enable these, if asked to by Syniti Support to help diagnose a data-related problem. These log pairs of messages before and after calls to different areas of code.
data: Logs incoming record data before and after processing.
86 t0 d0: 0A,1,MR G K CHILVERS,LASER MANAGER,...,BRISTOL,BS12 4EU
90 t0 d0: OK
Where the layout is:
<uptime in ms> t<thread number> d<record number>:<data>
<uptime in ms> t<thread number> d<record number>: OK
generate: Logs uniqueRef/RecordID of records before and after calling generate.
86 t0 g1
88 t0 g1: OK
Where the layout is:
<uptime in ms> t<thread number> g<uniqueRef/recordID>
<uptime in ms> t<thread number> g<uniqueRef/recordID>: OK/ERROR
compare: Logs uniqueRef/RecordID of records before and after calling compare.
189 t10 c59_w49
190 t10 c59_w49: OK
Where the layout is:
<uptime in ms> t<thread number> c<uniqueRef/recordID>_w<uniqueRef/recordID>
<uptime in ms> t<thread number> c<uniqueRef/recordID>_w<uniqueRef/recordID>: OK/ERROR
errors: Enable this option to redirect error messages to the debug log that are normally collected via the API method GetNextError()/getNextError().
When any engine method fails and returns an error code, additional information about the failure can be logged as an error.
Internal processing failures and warnings will also be logged. Any large clusters encountered during processing are also logged (refer to the Configuration Guide for details on large clusters).
By default, debug information is appended to the debug file. Enabling truncation will cause the file to be cleared of all data when the engine is started, which will ensure that the file contains only the data leading up to the crash. Please enable truncation before providing a debug file to Syniti Support for analysis.
Syniti Match API must be initialized with a nationality. Refer to Appendix F for a list of available nationalities.
<advanced><nationality>USA</nationality>...</advanced>
nationality: Choose the nationality that represents the majority of the data being processed. If processing international data from multiple countries, specify Other. The nationality setting aids with the parsing of all input data.
Further mAPI settings can be configured if necessary. Refer to the Advanced Configuration Guide for full details.