offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2,
6,490,593 and 6,289,352.
TrademarksBusiness Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise
are trademarks or registered trademarks of Business Objects SA or its affiliated
companies in the United States and other countries. All other names mentioned herein
may be trademarks of their respective owners.
Third-party contributorsBusiness Objects products in this release may contain redistributions of software
licensed from third-party contributors. Some of these individual components may
also be available under alternative licenses. A partial listing of third-party
contributors that have requested or permitted acknowledgments, as well as required
notices, can be found at: http://www.businessobjects.com/thirdparty
2
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 5
Preface
About
BusinessObjects
Watchlist Security XI
Release 2
Interdiction listsInterdiction lists, or “watch” lists, are issued by certain domestic, international,
All businesses (insurance companies and financial institutions to name a few)
need to make sure that they comply with certain government and industry
requirements that prevent them from doing business with specific terrorist
organizations and persons.
and financial organizations (like the FBI, OFAC, BIS, UN, FinCEN, and others).
In this document, the term “interdiction” and “watch” lists are used to refer to
these lists.
Interdiction lists contain names of certain regions, governments, and persons who
have been known to participate in various (usually illegal) acts. Financial
institutions and other business types are prohibited from doing business with
persons, countries, or other entities on these lists through the United States’
Patriot Act.
There are several lists that Business Objects supports in Watchlist Security.
Business Objects keeps these lists up to date and sends you messages when there
are updates to the lists.
About this guideThis document is intended for the application developer who will integrate the
Watchlist Security Web Service functionality into a custom application. It
includes information about integrating BusinessObjects Watchlist Security XI
Release 2 functionality into your own custom applications through the Watchlist
Security Web Service. This guide includes information about the sample included
with the web service and a reference for all of the web service methods you’ll use
in your application.
This guide does not include installation instructions. For more instructions about
installing, see the BusinessObjects Watchlist Security XI Release 2 System Administrator’s Guide.
See the BusinessObjects Watchlist Security XI Release 2User’s Guide or the
online help for detailed instructions about how to use Watchlist Security based on
your user role.
DocumentationBelow is a list of Watchlist Security documentation.
BusinessObjects Watchlist Security XI Release 2 Release Notes
BusinessObjects Watchlist Security XI Release 2 System Administrator’s
Guide
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide (this
book)
BusinessObjects Watchlist Security XI Release 2 User’s Guide
Note: For the sake of brevity, the product’s name is shortened to “Watchlist
Security” throughout the documentation.
5
Page 6
Access the latest
documentation
You can access product documentation in several places:
On your computer. Release notes, manuals, and other documents for each
product that you have installed are available in the Documentation folder.
Choose Start > Programs > BusinessObjects XI Release 2 > Watchlist Security 11.6 > Documentation.
On the Customer Portal. Go to www.firstlogic.com/customer, and then
click the Documentation link to access all the latest product documentation.
You can view the PDFs online or save them to your computer for viewing or
printing.
ConventionsThis document follows these conventions:
ConventionDescription
BoldWe use bold type for file names, paths, emphasis, and text that you
should type exactly as shown. For example, “Type
ItalicsWe use italics for emphasis and text for which you should substitute
your own data or values. For example, “Type a name for your file, and
the
.txt
extension (
testfile
.txt
).”
cd\dirs
.”
Menu
commands
!
We indicate commands that you choose from menus in the following
format:
New
Menu Name > Command Name
.”
. For example, “Choose
File >
We use this symbol to alert you to important information and potential
problems.
We use this symbol to point out special cases that you should know
about.
We use this symbol to draw your attention to tips that may be useful to
you.
6
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 7
Chapter 1:
Integration sample
To help you integrate Watchlist Security into your application, there is an
integration sample that you can run and examine its code. This section describes
how to set up and use the sample.
Chapter 1: Integration sample
7
Page 8
Set up the integration sample
Watchlist Security includes a sample application, called the Watchlist Security
Integration Sample, that connects to your Watchlist Security Web Service. Use
this sample as a reference when you create your own custom applications. This
sample was created with Microsoft Visual Studio .NET 2003, and includes all of
the necessary project files that you can use if you own Visual Studio .NET.
All of the functionality available in the administration sample is available as
public web methods, so you can integrate any of the Watchlist Security features
of the sample into your own custom application. For more information, see
“Integration SDK reference” on page 11.
Set up and run the
integration sample
The integration sample is provided as a zipped file on your Watchlist Security
product CD. After you unzip the file, you can access and view the sample
immediately without compiling.
Install Watchlist Security. Before you run the integration sample, you must
have installed and set up Watchlist Security.
1.On your Watchlist Security product CD, open the WLS_Integration_Sample
folder. The integration sample is contained in the
WLS_Integration_Sample.zip file.
2.Copy the WLS_Integration_Sample.zip file to your computer and unzip the
file.
3.Using Microsoft Visual Studio, open the WLS_Integration_Sample file (of
type Visual C# Project) file.
4.If you have installed Watchlist Security and Data Quality to your local
machine, proceed to step 8.
If Watchlist Security and Data Quality are installed to a remote computer,
you’ll have to configure the integration sample to connect to them remotely.
5.In the Solution Explorer in Microsoft Visual Studio, right-click
Dashboard.cs and select View Code.
6.Locate the Watchlist Security and Data Quality connection values
(WLS_URL and DQXI_URL respectively), and modify the URL to the
location where they are installed.
By default, the connection values are set as follows:
public static string WLS_URL="http://localhost/
compliancesolutionws/compliancesolutionws.asmx";
public static string DQXI_URL="http://localhost/
FirstlogicIQService/FirstlogicIQService.asmx";
7.Recompile the code.
8.Click Start to run the Watchlist Security integration sample. For more
information about running the sample, see “Use the integration sample” on
page 9.
8
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 9
Use the integration sample
The tasks that you can perform in the Watchlist Security integration sample are a
subset of the functionality available in the Watchlist Security client application.
The sample demonstrates how you can create web pages that replicate Watchlist
Security functionality. For more detailed information about these and other
Watchlist Security tasks, see the BusinessObjects Watchlist Security XI Release 2 User’s Guide.
The following sections explain some tasks that you can perform with the
integration sample. They assume that you have already opened the sample and set
the connection settings.
Run a transaction
match
Run a batch match
You can match a single file against interdiction lists and custom lists via the
integration sample.
1.In the Watchlist Security Integration sample, click the Tra ns actio n
Matching button.
2.In the Transaction window, enter all known information about the individual
or organization.
3.Click the Check Individual button
4.After the match process completes, the results pane at the bottom of the
window displays the record that you entered and any interdiction or custom
list records that matched it.
If no records matched, the pane displays “No matches found” in the match
description.
5.If you want to save the match results so that a reviewer can later research the
match and identify whether it is a true match, click Save to Match History.
6.Close the window.
You can match a batch file against interdiction lists and custom lists via the
integration sample.
1.In the Watchlist Security Integration sample, click the Batch Matching
button.
2.In the Run Batch File window, select a file that contains the records you want
to match against the interdiction and custom lists.
3.Click the Process a File button. The Batch Match Results Progress pane
displays the status of the match process.
4.After the match process completes, the pane displays the number of matches
that were found.
5.Close the window.
Chapter 1: Integration sample
9
Page 10
Review matches
You can review the potential matches that were identified in the match process to
identify whether they are true matches and whether your organization should do
business with the individual or organization.
This feature displays all of the records that have been processed in Watchlist
Security, not just the records processed through the integration sample.
1.In the Watchlist Security Integration sample, click the Review Matches
button.
2.In the Review window, select the start and end time of the time period that
the potential matches were processed against the interdiction and customer
lists.
3.Select the user and group that ran the match process that you want to review.
4.Select whether you want to review individual records, organization record, or
both.
5.Select the type of task that you want to review: batch file, FinCEN,
transaction, wire transfer, or all.
6.Click the Search button. The results pane displays the first set of records that
were identified as potential matches.
7.Select the records that you’ve researched.
8.Click the Accept button if the record is not a true match to a record on the
interdiction or custom list. This indicates that your organization may do
business with this individual or organization.
Click the Do Not Accept button if the record matches a record on the
interdiction or custom list. This indicates that your organization should not
do business with this individual or organization, and you should follow your
organization’s procedures to report it to the appropriate agency.
9.Click the Next Record button to review the next set of potential matches or
the Previous Record button to review the previous set.
10
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 11
Chapter 2:
Integration SDK reference
This section explains how to use the Integration SDK for Watchlist Security. It
includes syntax and descriptions of the methods and their parameters.
Chapter 2: Integration SDK reference
11
Page 12
About the Watchlist Security SDK
Watchlist Security has a .NET web service.
Data Quality SDKWatchlist Security supports the .NET Data Quality Web Service. Watchlist
Security uses the following Data Quality methods:
runTransactionDataflowWithXmlData
getDataflowStatus
runBatchDataflow
stopDataflow
getDataflowHistorySummaryPrivate
For more information about the Data Quality SDK, see the “Web method
reference” section in the BusinessObjects Data Quality XI Release 2 Integrator’s Guide.
12
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 13
Web Service API reference
The Web Service API for the Watchlist Security Integration SDK consists of the
following methods:
ClassDescription
AddMatchHistoryAdds a match history record to the TblMatchHistory
ChangePasswordChanges the password or password hint for a user.
DeleteComplianceFormsRemoves all compliance forms from the TblCompli-
DeleteCustomListDataDeletes custom list data for a given list ID from the
DeleteCustomListNameRemoves a custom list name from TblCustomRefer-
table. Use this for transaction or wire transfer records.
anceForms table.
TblCustomReferenceLists table.
enceLists.
DeleteCustomSelectReferenceListOptions
DeleteMatchHistoryByDataflowID
DeleteMatchHistoryByMatchID
DeleteMatchHistoryRecordRemoves a match history record from the TblMatch-
DeleteReferenceDataVersionRemoves a version of the reference data for a given
DeleteUserRemoves a user with the given user name in the TblU-
DeleteUserReviewGroupRemoves an existing review group from the TblRe-
DeleteWireTransferUserDataRemoves the wire transfer record with given ID from
GetAuditDetailReportDataReturns an XML document that is used to generate a
Removes the custom list options record in the TblCustomSelRefListsOptions table for a given list ID.
Deletes match history record(s) from the TblMatchHistory table with a specific dataflow ID.
Deletes match history record(s) from the TblMatchHistory table for a given match ID.
History table for a given ID.
version number. The application stores up to two versions of reference data that can be matched against.
serInfo table.
viewGroups table.
the TblWireTransferUserData table.
detailed audit report with options to filter on task type,
who processed the records and time period.
GetAuditSummaryReportData Returns an XML document that is used to generate a
detailed audit report with options to filter on task type,
who processed the records and time period.
GetAutoUpdateInfoReturns an XML document that contains the auto
update information in the TblAutoUpdateInfo table.
GetComplianceFormsRetrieves the list of compliance form names and the
associated URL used to report matches on the various
government-supplied compliance lists.
Chapter 2: Integration SDK reference
13
Page 14
ClassDescription
GetCustomDataRecordCountQueries the number of records in the TblCustomRefer-
enceData table, which stores the reference data for
user-supplied custom lists.
GetCustomReferenceListsRetrieves information about your custom lists that are
uploaded into the system.
GetCustomSelectReferenceListOptions
Retrieves settings used to turn on/off matching for each
of your custom lists for the three matching processes:
transaction, batch, and wire transfer.
GetDistinctUnReviewedMatchIDs
Retrieves a list MatchID of distinct unreviewed
records. These records are from the TblMatchHistory
table.
GetIQ8ServerSettingsReturns the settings for the dqxi server that are used for
Watchlist Security to connect to the dqxi server and the
dqxi server to connect to the Watchlist Security database.
GetMatchConfidenceThresholdsOptionsInfo
Retrieves confidence thresholds from the TblMatchConfidenceThresholds table that are used to give high,
medium, and low values to any matches that are found
based on the generated match number.
GetMatchHistoryByDataflowID
Retrieves all the matched records and reference data
from a batch process. All records and reference data
are from the TblMatchHistory table.
GetMatchHistoryByMatchIDRetrieves a record and the reference data that matched
it. The reference records can be from user supplied custom list and the Watchlist Security's supplied reference
lists. These records are stored in the TblMatchHistory
table.
GetMatchHistoryFilteredDataRetrieves unreviewed match history that match a num-
ber of filtering options. These records returned are
from the TblMatchHistory table.
GetMatchOptionsInfoRetrieves the match options for three types: Given
Names, Family Names, and Organization. This is used
to configure the matching process. This information is
stored in the TblMatchOptions table and used in the
matching algorithms for each type of data.
GetProcessingHistoryChartInfo
Retrieves processing history for the last four days to
show how many records have been processed.
getPublicKeyRetrieves the public key from the web service. This
key is used to encrypt sensitive values that are passed
to the server.
GetRefDataVersionRetrieves the reference data versions that are in the
data base and which version is being currently matched
against.
GetReferenceListsRetrieves the information for each or the supplied ref-
erence lists. The information for the lists are stored in
the TblReferenceLists table.
14
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 15
ClassDescription
GetReviewGroupsRetrieves the all the review groups and their informa-
tion. The review groups are stored in the TblReviewGroups table.
GetSelectReferenceListsOptionsInfo
Retrieves settings used to turn on and off matching for
each of the provided reference lists for the three matching processes: transaction, batch, and wire transfer.
GetUserInfoRetrieves a user’s information. The user information is
stored in the TbluserInfo table.
GetUserListRetrieves all users and their information stored in the
TbluserInfo table.
GetUnreviewedMatchesChartInfo
Retrieves statistics on unreviewed records to show the
user how many are out there and how long they have
been waiting to get reviewed. Many of the governing
bodies require matches to be reviewed 7-10 days after
being found.
InsertComplianceFormAdds a compliance report form link into the system in
one of four display groupings. The forms are stored in
the TblComplianceForms table.
InsertCustomListNameInserts a new user-supplied custom list name. The
entry is stored in the TblCustomReferenceLists table.
InsertCustomSelReferListOptions
Inserts the user supplied custom list options for matching against the three types of matching: Run Single
Record, Run Entire File, and Wire Transfer. These settings are stored in the TblCustomSelRefListsOptions
table.
InsertProcessingHistoryInserts a record into the processing history in table for
a group of matches. The values are stored in the TblProcessingHistory table.
InsertRefDataRecordsupdates the reference data using an XML string con-
taining one or more rows to be inserted into the reference data. The reference data are stored in the
TblReferenceData table.
InsertUserInserts a new user into the TblUserInfo table.
InsertUserReviewGroupAdds a new review group that users can be added to.
The information is stored in the TblReviewGroups
table.
InsertWireTransferUserDataInserts the sender’s and beneficiary’s wire transaction
information into the wire match history table to be used
to match against the FinCEN list. Values are stored in
the TblWireTransferUserData table.
IsMatchGroupDirtyChecks whether a match group has been updated and
needs to be updated in the database.
UpdateAutoUpdateInfoUpdates the reference file updating process and how to
connect to the download site. These settings are stored
in the TblAutoUpdateInfo table.
Chapter 2: Integration SDK reference
15
Page 16
ClassDescription
UpdateCustomSelectReferenceListsOptions
Updates your custom list options for matching against
the three types of matching: Run Single Record, Run
Entire File, and Wire Transfer. These settings are
stored in the TblCustomSelRefListsOptions table.
UpdateIq8ServerSettingsUpdates the settings for the Data Quality Server and
the Watchlist Security database that is used to connect
Watchlist Security to the Data Quality Server and the
Data Quality Server to connect to the Watchlist Security database. These settings are stored in the
TblIQ8ServerSettings table.
UpdateMatchConfidenceThresholdsOptionsInfo
Updates the confidence settings for the matching process. Each record that is matched is given a confidence
of low, medium, or high based on the thresholds set in
the TblMatchConfidenceThresholds table. There are
six match scenarios. Each match scenario has its own
thresholds for the three confidence levels.
UpdateMatchHistoryAfterReview
Updates the review information of a match history
record in the TblMatchHistory table. After a record is
found in the matching process the record with the
matching reference data are reviewed once and
accepted or rejected with comments added to the
record to show why the records was accepted or
denied.
UpdateMatchOptionsInfoUpdates the match options for three fields that you can
match on: given name, family name, and organization.
This is used to configure the matching process. This
information is stored in the TblMatchOptions table and
used in the matching algorithms for each type of data.
UpdateProcessingHistoryUpdates a record that is stored in the processing history
in the TblProcessingHistory table for a given ID.
UpdateRefDataVersionUpdates the reference versions and change which ver-
sion to match against. There is a current version of the
reference data and a backup that is normally the previous downloaded reference file update. These values are
stored in the TblRefDataVersion table.
UpdateSelectReferenceListsOptionsInfo
Updates a row in the Select Reference Lists Options
for one of three types of matching: RunSingleRecord,
RunEntireFile, and WireTransfer. Each of the refListName entries correspond to the same numbered reference list in the Tblreferencelists table.
UpdateUserUpdates all user information for user with the given ID
number in the TblUserInfo table.
UpdateUserReviewGroupUpdates an existing review group with new values for
the group name and group description in the TblReviewGroups table.
16
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 17
AddMatchHistory
Syntax
DescriptionThis method adds a match history record to the TblMatchHistory table. Use this
for transaction or wire transfer records. (Batch, FinCEN batch, and FinCEN wire
match processing automatically adds the records found as matches to the match
history.)
Parameters
ParameterTypeMaximum
size
Description
refRecUniqueIDString20This is populated for reference data rather
than data entered by the user.
listSourceIDString3Holds the list ID foreign key for lists.
Less than 100:
100 or greater:
TblReferenceLists
TblCustomReferenceLists
recordTypeString1The type of record.
I:
Individual
O:
Organization
V:
Ves s e l
listIDNumString20An ID that identifies a specific row in the
government-supplied compliance list. It is
used to look up reference data in the compliance list.
givenNameString60First name of an individual (for example,
Mike or John).
familyNameString60Last name of an individual (for example,
Smith or Johnson).
postNameString20Post name (for example, Jr. or III).
Chapter 2: Integration SDK reference
17
Page 18
ParameterTypeMaximum
size
Description
organizationString100Organization name (for example, Business
Objects or Microsoft).
countryString30Country name (for example, United States
or France).
dobString11Date of birth. The format can be dd-mmm-
yyyy or yyyy depending on the data from
the specific interdiction list.
nationalityString60Nationality (for example, Swedish or Rus-
sian).
passportString30The passport number.
idNumString40An identification number. This can be a
passport, bank ID, Social Security number,
or other form of identification that is associated with an individual.
matchDescription String20The match type generated by a match algo-
rithm.
NAME & DOB
NAME & IDNUM
NAME & PASSPORT
ORGANIZATION & IDNUM
NAME ONLY
ORGANIZATION ONLY
WIRE BENEFICIARY
FILE
WIRE SENDER
SINGLE RECORD
matchConfidence String6The confidence of a positive match based
on set criteria. Value can be low, medium,
or high.
dataflowIDString20The name of the dataflow that generated
the match.
matchIDString36A generated unique ID that is given to an
input record and the reference data that
matched it to associate them.
lastModifiedDateString8The date that the record was last modified.
The format is yyyymmdd.
isReviewedString1The record’s review status.
1:
True
0:
False
isAcceptedString1The record’s accepted or not accepted sta-
tus.
1:
True (accepted)
0:
False (not accepted)
18
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 19
ParameterTypeMaximum
size
Description
organizationString100Organization name (for example, Business
Objects or Microsoft).
countryString30Country name (for example, United States
or France).
dobString11Date of birth. The format can be dd-mmm-
yyyy or yyyy depending on the data from
the specific interdiction list.
nationalityString60Nationality (for example, Swedish or Rus-
sian).
passportString30The passport number.
idNumString40An identification number. This can be a
passport, bank ID, Social Security number,
or other form of identification that is associated with an individual.
matchDescription String20The match type generated by a match algo-
rithm.
NAME & DOB
NAME & IDNUM
NAME & PASSPORT
ORGANIZATION & IDNUM
NAME ONLY
ORGANIZATION ONLY
WIRE BENEFICIARY
FILE
WIRE SENDER
SINGLE RECORD
matchConfidence String6The confidence of a positive match based
on set criteria. Value can be low, medium,
or high.
dataflowIDString20The name of the dataflow that generated
the match.
matchIDString36A generated unique ID that is given to an
input record and the reference data that
matched it to associate them.
lastModifiedDateString8The date that the record was last modified.
The format is yyyymmdd.
isReviewedString1The record’s review status.
1:
True
0:
False
isAcceptedString1The record’s accepted or not accepted sta-
tus.
1:
True (accepted)
0:
False (not accepted)
Chapter 2: Integration SDK reference
19
Page 20
ParameterTypeMaximum
userIDString50The name of the user that processed the
commentString150Comments that are saved with the record
taskTypeString2The type of transaction used to process the
ReturnsNone.
size
Description
record that was matched against the reference data foreign key in the TblUserInfo
table.
after it is reviewed should contain any
extra info found during the review process
to show why the user was or wasn’t a
match to the interdiction list.
record.
T:
Transaction
B:
Batch
F:
FinCEN
WS:
Wire sender
WB:
Wire beneficiary
ExceptionsIf unsuccessful, throws a SOAP exception.
See also DeleteMatchHistoryByDataflowID
DeleteMatchHistoryByMatchID
DeleteMatchHistoryRecord
GetMatchHistoryByDataflowID
GetMatchHistoryByMatchID
GetMatchHistoryFilteredData
GetUnreviewedMatchesChartInfo
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
20
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 21
ChangePassword
Syntax
DescriptionThis method changes the password or password hint for a user.
Parameters
bool ChangePassword(string userName,
byte[] password,
string
passwordHint)
ParameterTypeMaximum
size
Description
usernameString50A unique name required by Watchlist Secu-
rity.
passwordString50An encrypted password. Use the public key
from the Watchlist Security Web Service by
calling getPublicKey to encrypt the password.
passwordHintString50A hint that can help users remember their
password.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
Chapter 2: Integration SDK reference
21
Page 22
DeleteComplianceForms
Syntax
DescriptionThis method removes all compliance forms from the TblComplianceForms table.
ParametersNone.
ReturnsNone.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also GetComplianceForms
int DeleteComplianceForms()
InsertComplianceForm
22
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 23
DeleteCustomListData
Syntax
int DeleteCustomListData(string listID)
DescriptionThis method deletes custom list data for a given list ID from the
TblCustomReferenceLists table.
Parameters
ParameterTypeMaximum
size
Description
listIDString3A foreign key associated with custom list
names. Valid values are 100–109.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also DeleteCustomListName
GetCustomReferenceLists
InsertCustomListName
Chapter 2: Integration SDK reference
23
Page 24
DeleteCustomListName
Syntax
int DeleteCustomListName(string listID)
DescriptionThis method removes a custom list name from TblCustomReferenceLists.
Parameters
ParameterTypeMaximum
size
Description
listIDString3A foreign key associated with custom list names.
Valid values are 100–109.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also DeleteCustomListData
GetCustomReferenceLists
InsertCustomListName
24
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 25
DeleteCustomSelectReferenceListOptions
Syntax
int DeleteCustomSelectReferenceListOptions(string listID)
DescriptionThis method removes the custom list options record in the
TblCustomSelRefListsOptions table for a given list ID.
Parameters
ParameterTypeMaximum
size
Description
listIDString3A foreign key associated with custom list
names. Valid values are 100–109.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also GetCustomSelectReferenceListOptions
InsertCustomSelReferListOptions
UpdateCustomSelectReferenceListsOptions
Chapter 2: Integration SDK reference
25
Page 26
DeleteMatchHistoryByDataflowID
Syntax
int DeleteMatchHistoryByDataflowID(string dataflowID)
DescriptionThis method deletes match history record(s) from the TblMatchHistory table with
a specific dataflowID.
Use this method with caution; it can cause inconsistencies in your database.
!
This can cause problems if you are audited by a governing body and are
required to show due diligence. It is important to keep the entered record, the
record and list that it matched against, and the reason you chose to accept or
not accept the record.
Parameters
ParameterTypeMaximum
size
Description
dataflowIDString20A generated ID from Data Quality created by
each batch process to identify that process.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByMatchID
DeleteMatchHistoryRecord
GetMatchHistoryByDataflowID
GetMatchHistoryByMatchID
GetMatchHistoryFilteredData
GetUnreviewedMatchesChartInfo
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
26
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 27
DeleteMatchHistoryByMatchID
Syntax
int DeleteMatchHistoryByMatchID(string matchID)
DescriptionThis method deletes match history record(s) from the TblMatchHistory table for a
given match ID.
Use this method with caution; it can cause inconsistencies in your database.
!
This can cause problems if you are audited by a governing body and are
required to show due diligence. It is important to keep the entered record, the
record and list that it matched against, and the reason you chose to accept or
not accept the record.
Parameters
ParameterTypeMaximum
size
Description
matchIDString36A generated unique ID that is assigned to an
input record and the reference data that matched
it to associate them.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByDataflowID
DeleteMatchHistoryRecord
GetMatchHistoryByDataflowID
GetMatchHistoryByMatchID
GetMatchHistoryFilteredData
GetUnreviewedMatchesChartInfo
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
Chapter 2: Integration SDK reference
27
Page 28
DeleteMatchHistoryRecord
Syntax
int DeleteMatchHistoryRecord(int ID)
DescriptionThis method removes a match history record from the TblMatchHistory table for
a given ID.
Use this method with caution; it can cause inconsistencies in your database.
!
This can cause problems if you are audited by a governing body and are
required to show due diligence. It is important to keep the entered record, the
record and list that it matched against, and the reason you chose to accept or
not accept the record.
Parameters
ParameterTypeMaximum
size
Description
IDInt4A generated ID used as a primary key for match
history records.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByDataflowID
DeleteMatchHistoryByMatchID
GetMatchHistoryByDataflowID
GetMatchHistoryByMatchID
GetMatchHistoryFilteredData
GetUnreviewedMatchesChartInfo
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
28
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 29
DeleteReferenceDataVersion
Syntax
DescriptionThis method removes a version of the reference data for a given version number.
int DeleteReferenceDataVersion(string versionNumber)
The application stores up to two versions of reference data that can be matched
against.
Parameters
ParameterTypeMaximum
size
Description
versionNumber Int6A version number assigned to differentiate the
version of supplied reference data.
Returns
ExceptionsIf unsuccessful, throws a SOAP exception.
See also GetRefDataVersion
None.
UpdateRefDataVersion
Chapter 2: Integration SDK reference
29
Page 30
DeleteUser
Syntax
DescriptionThis method removes a user with the given user name in the TblUserInfo table.
int DeleteUser(string userName)
Use this method with caution; it can cause inconsistencies in your database
!
that can cause problem down the line if you are audited by a governing body
and required to show due diligence. If you remove a user from the system,
you can no longer associate any of the records that the user matched with a
user’s information.
We recommend that you set the user as inactive using the UpdateUser
method to keep associations with match history records.
Parameters
ParameterTypeMaximum
size
Description
usernameString50The name of the user.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also InsertUser
UpdateUser
30
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 31
DeleteUserReviewGroup
Syntax
DescriptionThis method removes an existing review group from the TblReviewGroups table.
int DeleteUserReviewGroup(string reviewGroupName)
Use this method with caution; it can cause inconsistencies in your database.
!
This can cause problems if you are audited by a governing body and are
required to show due diligence. It is important to keep the entered record, the
record and list that it matched against, and the reason you chose to accept or
not accept the record.
Parameters
ParameterTypeMaximum
size
Description
reviewGroupNameString 50The name of the review group that a user is
assigned to. A value must exist in the TblReviewGroups table.
Returns
ExceptionsIf unsuccessful, throws a SOAP exception.
None.
See also InsertUserReviewGroup
GetReviewGroups
UpdateUserReviewGroup
Chapter 2: Integration SDK reference
31
Page 32
DeleteWireTransferUserData
Syntax
DescriptionThis method removes the wire transfer record with given ID from the
int DeleteWireTransferUserData(int wireID)
TblWireTransferUserData table.
Use this method with caution; it can cause inconsistencies in your database.
!
This can cause problems if you are audited by a governing body and are
required to show due diligence. It is important to keep the entered record, the
record and list that it matched against, and the reason you chose to accept or
not accept the record.
Parameters
ParameterTypeMaximum
size
Description
wireIDInt4A generated ID used as a primary key for a wire
transaction record.
Returns
ExceptionsIf unsuccessful, throws a SOAP exception.
None.
See also InsertWireTransferUserData
32
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 33
GetAuditDetailReportData
Syntax
DescriptionThis method returns an XML document that is used to generate a detailed audit
The IQ8DataSourceName tag consists of a byte array that includes:
datasource name
user name
password
host name
port name
schema name
Look at the integration sample for implementation details.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also UpdateIq8ServerSettings
Chapter 2: Integration SDK reference
41
Page 42
GetMatchConfidenceThresholdsOptionsInfo
Syntax
string GetMatchConfidenceThresholdsOptionsInfo()
DescriptionThis method retrieves confidence thresholds from the
TblMatchConfidenceThresholds table that are used to give high, medium, and
low values to any matches that are found based on the generated match number.
ParametersNone.
ReturnsReturns an XML document with the values stored in the
ExceptionsIf unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByDataflowID
DeleteMatchHistoryByMatchID
Chapter 2: Integration SDK reference
43
Page 44
DeleteMatchHistoryRecord
GetMatchHistoryByMatchID
GetMatchHistoryFilteredData
GetUnreviewedMatchesChartInfo
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
44
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 45
GetMatchHistoryByMatchID
Syntax
GetMatchHistoryByMatchID(string MatchID)
DescriptionThis method retrieves a record and the reference data that matched it. The
reference records can be from user supplied custom list and the Watchlist
Security's supplied reference lists. These records are stored in the
TblMatchHistory table.
Parameters
ParameterTypeMaximum
size
Description
MatchIDString36A unique generated string used to associate a
record with reference data that matched it.
Returns
Returns an XML document that contains the match history records that match the
given MatchID in the TblMatchHistory table.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByDataflowID
DeleteMatchHistoryByMatchID
48
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 49
DeleteMatchHistoryRecord
GetMatchHistoryByDataflowID
GetMatchHistoryByMatchID
GetUnreviewedMatchesChartInfo
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
Chapter 2: Integration SDK reference
49
Page 50
GetMatchOptionsInfo
Syntax
string GetMatchOptionsInfo()
DescriptionThis method retrieves the match options for three types: Given Names, Family
Names, and Organization. This is used to configure the matching process. This
information is stored in the TblMatchOptions table and used in the matching
algorithms for each type of data.
ParametersNone.
ReturnsReturns an XML document with the values stored in the TblMatchOptions table.
The database stores two versions of the reference data. SelectedVersion indicates
the version to match with. The selected version can point to either the current
version (RefDataVersion) or the backup version (BackupDataVersion).
ExceptionsIf unsuccessful, throws a SOAP exception.
See also DeleteReferenceDataVersion
UpdateRefDataVersion
Chapter 2: Integration SDK reference
53
Page 54
GetReferenceLists
Syntax
string GetReferenceLists()
DescriptionThis method retrieves the information for each or the supplied reference lists. The
information for the lists are stored in the TblReferenceLists table.
ParametersNone.
ReturnsReturns an XML document containing the values for each interdiction list in the
DescriptionThis method retrieves statistics on unreviewed records to show the user how
many are out there and how long they have been waiting to get reviewed. Many
of the governing bodies require matches to be reviewed 7-10 days after being
found.
Parameters
ParameterTypeMaximum
size
Description
todayStrString 10Today’s date in the format mm/dd/yyyy.
reviewGroup String50A review group name for statistics on a specific
group. For all review groups, this can be "" for
DB2 or "%" for SQL Server and Oracle.
Returns
Returns an XML document that includes values that represent the unreviewed
match history records in the TblMatchHistory table for the specified time spans.
sumToday
sum1To6Days
sum7orMoreDays
ExceptionsIf unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByDataflowID
DeleteMatchHistoryByMatchID
DeleteMatchHistoryRecord
GetMatchHistoryByDataflowID
GetMatchHistoryByMatchID
GetMatchHistoryFilteredData
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
Chapter 2: Integration SDK reference
59
Page 60
InsertComplianceForm
Syntax
DescriptionThis method adds a compliance report form link into the system in one of four
int InsertComplianceForm(string Type,
string formName,
string URL)
display groupings. The forms are stored in the TblComplianceForms table.
Parameters
ParameterTypeMaximum
size
Description
TypeString 4Compliance forms are grouped by their types and
the government bodies that require them to be
submitted.
OFAC:
Office of Foreign Assets Control transac-
tions and blocked property forms.
CTRS:
Currency Transaction Reports.
SAR:
Suspicious Activity Reports.
FORM:
Other forms.
formNameString 200The name of a compliance form.
URLString 200The web page where a compliance form is
located.
Returns
ExceptionsIf unsuccessful, throws a SOAP exception.
See also DeleteComplianceForms
None.
GetComplianceForms
60
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 61
InsertCustomListName
Syntax
DescriptionThis method inserts a new user-supplied custom list name. The entry is stored in
int InsertCustomListName(string listID,
string listSource,
string listFullName)
the TblCustomReferenceLists table.
Parameters
ParameterTypeMaximum
size
Description
listIDString 3A foreign key associated with custom list names.
Valid values are 100–109.
listSourceString 80The name of a custom list as it is displayed in
Watchlist Security.
listFullName String 200A custom list’s full name with any extra version
or other information that is not displayed in
Watchlist Security.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also DeleteCustomListData
DeleteCustomListName
GetCustomReferenceLists
Chapter 2: Integration SDK reference
61
Page 62
InsertCustomSelReferListOptions
Syntax
DescriptionThis method inserts the user supplied custom list options for matching against the
int InsertCustomSelReferListOptions(string listID,
Security database that is used to connect Watchlist Security to the Data Quality
Server and the Data Quality Server to connect to the Watchlist Security database.
These settings are stored in the TblIQ8ServerSettings table.
For more information, see the BusinessObjects Data Quality XI Release 2
documentation.
Parameters
ParameterTypeMaximum
size
Description
itemIDInt4A generated ID used as a primary key.
iq8HostNameString 100The name of the machine where the
Data Quality Server that Watchlist
Security uses is installed.
iq8PortNumberInt4The Data Quality Server port number.
iq8ReposPathString 1024The Data Quality Server repository
iq8DataSourceNameString 512Stores the connection settings for the
iq8DriverNameString 50The Data Quality-supplied driver that
iq8FirstlogicIQService
String 1024The Data Quality Web Service URL
URL
Returns
ExceptionsIf unsuccessful, throws a SOAP exception.
None.
path.
Watchlist Security database: data
source name, user name, password,
host name, port name, and schema
name. Look at the integration sample
for implementation details.
Data Quality Server uses to connect to
the Watchlist Security database.
that Watchlist Security uses to connect
to Data Quality.
See also GetIQ8ServerSettings
Chapter 2: Integration SDK reference
73
Page 74
UpdateMatchConfidenceThresholdsOptionsInfo
Syntax
DescriptionThis method updates the confidence settings for the matching process. Each
int UpdateMatchConfidenceThresholdsOptionsInfo(int itemID,
string matchScenarioName,
string isHighConfidence,
string isMediumConfidence,
string isLowConfidence,
int highConfidenceLowerBound,
int highConfidenceUpperBound,
int mediumConfidenceLowerBound,
int mediumConfidenceUpperBound,
int lowConfidenceLowerBound,
int lowConfidenceUpperBound,
string comment)
record that is matched is given a confidence of low, medium, or high based on the
thresholds set in the TblMatchConfidenceThresholds table. There are six match
scenarios. Each match scenario has its own thresholds for the three confidence
levels.
Parameters
ParameterTypeMaximum
size
Description
matchScenarioNameString 30Indicates the type of matching sce-
nario.
NameAndDOB
NameANDIdNum
NameAndPassport
NameOnly
OrganizationAndIdNum
OrganizationOnly
74
isHighConfidenceString 1Indicates whether a match result can
isMediumConfidenceString 1Indicates whether a match result can
isLowConfidenceString 1Indicates whether a match result can
highConfidenceLower-
Int4The lower bound for the high confi-
Bound
highConfidenceUpper-
Int4The upper bound for the high confi-
Bound
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
result in a high confidence.
1:
True
0:
False
result in a medium confidence.
1:
True
0:
False
result in a low confidence.
1:
True
0:
False
dence.
dence.
Page 75
ParameterTypeMaximum
size
Description
mediumConfidenceLowerBound
mediumConfidenceUpperBound
lowConfidenceLowerBound
lowConfidenceUpperBound
ReturnsNone.
ExceptionsIf unsuccessful, throws a SOAP exception.
DescriptionThis method updates the review information of a match history record in the
TblMatchHistory table. After a record is found in the matching process the record
with the matching reference data are reviewed once and accepted or rejected with
comments added to the record to show why the records was accepted or denied.
Parameters
ParameterTypeMaximum
size
Description
IDInt4A generated primary key.
IDNumString 40Set the IDNUM if you are going to attach an
internal ID to the entity.
isReviewedString 1Indicates whether the record has been
reviewed
1:
True (reviewed)
0:
False (not reviewed)
isAcceptedString 1Indicates whether the record has been
accepted.
1:
0:
CommentString 150Indicates the reason that the reviewer
accepted or denied the record and who
reviewed it.
LastModifiedDate String 8The date of review in format yyyymmdd.
Returns
None.
ExceptionsIf unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByDataflowID
DeleteMatchHistoryByMatchID
DeleteMatchHistoryRecord
GetMatchHistoryByDataflowID
True (accepted)
False (not accepted)
76
GetMatchHistoryByMatchID
GetMatchHistoryFilteredData
GetUnreviewedMatchesChartInfo
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 77
IsMatchGroupDirty
Chapter 2: Integration SDK reference
77
Page 78
UpdateMatchOptionsInfo
Syntax
DescriptionThis method updates the match options for three fields that you can match on:
given name, family name, and organization. This is used to configure the
matching process. This information is stored in the TblMatchOptions table and
used in the matching algorithms for each type of data.
Parameters
ParameterTypeMaximum
size
Description
itemIDInt4A generated ID used as a primary key.
matchFieldNameString 30A description of the three types of match-
ing that you can set options for.
GivenName: An individual’s first name.
FamilyName: An individual’s last name.
Organization: Name of an organization.
similarityThreshold
Int4A threshold that is used to set the similarity
where two words are considered a match.
The higher the value, the more strict the
matching is.
initialsMatchInt1Indicates whether initials match spelled out
words (for example, William G. Barney
and W. G. Barney).
1:
True
0:
False
substringMatchInt1Indicates whether substrings of words are
considered a match (for example, Ibrahim
Salih Mohammad Al Yacoub and Ibrah
Moham Al Yacoub).
1:
True
0:
False
abbreviationMatchInt1Indicates whether abbreviations are consid-
ered a match (for example, International
Health Providers and Intl Health Prov.).
1:
True
0:
False
commentString 100Stores comments about why match options
are set to the values specified.
Returns
78
None.
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 79
ExceptionsIf unsuccessful, throws a SOAP exception.
See also GetMatchOptionsInfo
Chapter 2: Integration SDK reference
79
Page 80
UpdateProcessingHistory
Syntax
DescriptionThis method updates a record that is stored in the processing history in the
int UpdateProcessingHistory(int id,
string userID,
string workTypeName,
int recordProcessed,
string dateOfEntry)
TblProcessingHistory table for a given ID.
Parameters
ParameterTypeMaximum
size
Description
IDInt4A generated primary key.
userIDString50The name of the user that ran the matching
process for the record.
workTypeNameString50The processing type used in the match pro-
cess.
TRANSACTION:
FINCEN:
BATCH:
FinCEN
Batch file
WIRE_TRANSFER:
Single record
Wire transfer
recordsProcessedInt4The number of records that were run
through the matching process for the specified processing history record.
dateOfEntryString8The date that a record was entered using the
format yyyymmdd.
Returns
ExceptionsIf unsuccessful, throws a SOAP exception.
See also GetProcessingHistoryChartInfo
None.
InsertProcessingHistory
80
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 81
UpdateRefDataVersion
Syntax
DescriptionThis method updates the reference versions and change which version to match
int UpdateRefDataVersion(string oldRefDataVersion,
string newRefDataVersion,
string selectedVersion)
against. There is a current version of the reference data and a backup that is
normally the previous downloaded reference file update. These values are stored
in the TblRefDataVersion table.
Parameters
ParameterTypeMaximum
size
Description
oldRefDataVersionString 6Stores the backup version of the reference
data.
newRefDataVersionString 6Stores the newest version of the reference
data.
selectedVersionString 7Indicates which version of reference data
to match
Current:
Backup:
Current version.
Previous version.
Returns
ExceptionsIf unsuccessful, throws a SOAP exception.
See also DeleteReferenceDataVersion
None.
GetRefDataVersion
Chapter 2: Integration SDK reference
81
Page 82
UpdateSelectReferenceListsOptionsInfo
Syntax
int UpdateSelectReferenceListsOptionsInfo(int itemID,