Return Values - trillium_quality

Table below lists the values returned by the Trillium Director to an API call when an abnormal event or system error occurs. Unless otherwise noted, a return value of zero (0) indicates the API call succeeded.

Trillium Director returns the same codes regardless of the calling language; the following table is applicable to all languages.

Note: If a client application requests return of a field that does not exist in the repository, an error code is not returned. Instead, a value of ‘DDL Field Not Found’ will be returned for that field’s value.

Table 1. Return Values
Code	Description	Returned By
1 – 8	Postal Matcher Fail Level. See Table: Table 1	cleanse, cleanseEx
1	Invalid state for request. Matcher session was either never opened or was closed. (Check the Fail Level field to determine if the return value is a Postal Matcher fail level. See Table: Table 1	Matcher functions
2	A street name failure or an incompatible version, which occurs when a client attempts to pass an encoding parameter to a pre-v10.5 cleanser. (Check the Fail Level field to determine if the return value is a Postal Matcher fail level. See Table: Table 1	cleanse, various cleanser functions
6	Out of memory. (Check the Fail Level field to determine if the return value is a Postal Matcher fail level. See Table: Table 1	attach, cleanse, addDirector
7	A line within the field list parameter is missing a description keyword. For example, this code will be returned if the following line: `zip_code scores(100) routines(absolute) fldnames(pr_ gout_postal_code)` is missing the word zip_code. (Check the Fail Level field to determine if the return value is a Postal Matcher fail level. See Table: Table 1	Matcher initialization
9	The Cleanser was not able to identify the country and it has defaulted to the first one in the list.	cleanse
12	Director Monitor error (Linux).	Director Monitor
14	Director Monitor error (Windows).	Director Monitor
102	Unable to attach to the Director. This can occur: If the Director is not running. If the TRILLDIRADDR and TRILLDIRPORT environment variables are not set correctly on the client. If the network connection between the client and server machines is down.	attach, cleanseEx, openMatcherEx
110	Director time out (Linux). This may be caused by a large match window or matcher performance.	Various functions
145	UNIX network error. Connection timed out. The client sent a request to the Director and did not get a response within 10 seconds. You can find this documented in the errno.h file on your server, which should be in a folder such as /usr/include/sys/errno.h.	Various functions
146	(UNIX) The machine on the other end abnormally terminated the connection. Possible causes include: The user turned off or rebooted the system while being connected. The cleanser or matcher server is configured to use a different port than the one specified by the Director. The cleanser went down but the Director is up.	Various functions
183	Director Monitor error (Windows).	Director Monitor
201	The TRILLCONFIG variable is not set. On the client, set the TRILLCONFIG environment variable to point to the XML configuration file (e.g., TrilXML.cfg).	Various functions
202	The input XML format does not match the TrilXML.cfg.	Various functions
210	The XML request is malformed, for example, it contains a mismatch of XML tags.	cleaseXML, matchCandidateXML
212	The XML configuration file cannot be loaded. This can be caused by a variety of conditions, such as the TRILLCONFIG environment variable cannot be found, the configuration file cannot be found, or the root tag cannot be found.	cleanseXML, matchCandidateXML
701	The port number is out of range. The port number cannot be greater than 65535.	addDirector, removeDirector
702	An invalid transport layer protocol was used. The only transport layer protocols supported are T (TCP) and U (UDP).	addDirector
703	Cannot find the Director in the hostandport.ini list.	removeDirector
704	The maximum window size is invalid. The maximum window size value must be a positive number.	setWindowSize
705	The number of records added to the match window has exceeded the maximum window size.	addToMatchWindow
706	This error can occur if: AddToMatchWindow calls do not use the same list of field names, or the fields are not in the same order. A MatchCandidate call does not use the same field names or field order as those used in the AddToMatchWindow call. When processing an XML request, the name and value tags are reversed. The name and value tags must be the attribute name of the match field and the value for the field, respectively. An element is missing from an XML request, for example, a < is missing in a tag, or a closing tag is missing.	addToMatchWindow, matchCandidate, matchCandidateWithSuspects
4101	The DELIVERY_TYPE or DISPLAY_BASEDATA setting for one of the countries has not been set correctly.	Initialization of UCA
4401	The client application was able to find the Director, but it was not able to locate the Cleanser or Matcher service. This can happen if: The Cleanser or Matcher service is not running. The System ID or the Server Name specified in the client's application does not match what the Cleanser or Matcher is using. The network connection between the Director machine and the Cleanser/Matcher machine is down. The server is currently processing the maximum number of concurrent requests.	attach, cleanseEx, OpenMatcherEx, setWindowSize
4402	Server name exceeds eight characters.	Various functions
10048	ListenOnSocket returned an error.	Various functions
10053	Director Monitor error (Windows).	Director Monitor
10054	Connection terminated. The most common cause is that the server terminated.	TCP/IP error
10060	Network timeout. The most common cause is that a server terminated.	Common Windows OS return code (any function)
65525	The cleanser or matcher encountered a memory access error.	Various functions
65526	The cleanser or matcher encountered a data type misalignment.	Various functions

Return Values - trillium_quality - 17.1

Trillium Director SDK Reference Guide