Business objects WATCHLIST SECURITY XI 12.0.0.0 User Manual

Page 1

BusinessObjects Watchlist Security XI Release 2

Integrator’s Guide

BusinessObjects Watchlist Security XI Release 2
Version 11.6.0.0
May 2007
Page 2
If you find any problem with this documentation, please report it to Business Objects in writing at
Copyright Copyright © 2007 Business Objects. All rights reserved.
Patents Business Objects owns the following U.S. patents, which may cover products that are
.
offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2, 6,490,593 and 6,289,352.
Trademarks Business 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 contributors Business 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
Page 3

Contents

Preface .............................................................................................................5
Documentation...........................................................................................5
Access the latest documentation................................................................6
Chapter 1:
Integration sample......................................................................................... 7
Set up the integration sample ...........................................................................8
Set up and run the integration sample........................................................8
Use the integration sample ...............................................................................9
Run a transaction match.............................................................................9
Run a batch match .....................................................................................9
Review matches .......................................................................................10
Chapter 2:
Integration SDK reference ......................................................................... 11
About the Watchlist Security SDK ................................................................12
Data Quality SDK....................................................................................12
Web Service API reference ............................................................................13
AddMatchHistory...........................................................................................17
ChangePassword ............................................................................................21
DeleteComplianceForms................................................................................22
DeleteCustomListData ...................................................................................23
DeleteCustomListName .................................................................................24
DeleteCustomSelectReferenceListOptions ....................................................25
DeleteMatchHistoryByDataflowID ...............................................................26
DeleteMatchHistoryByMatchID ....................................................................27
DeleteMatchHistoryRecord............................................................................28
DeleteReferenceDataVersion .........................................................................29
DeleteUser......................................................................................................30
DeleteUserReviewGroup ...............................................................................31
DeleteWireTransferUserData.........................................................................32
GetAuditDetailReportData.............................................................................33
GetAuditSummaryReportData.......................................................................34
GetAutoUpdateInfo........................................................................................35
GetComplianceForms.....................................................................................36
GetCustomDataRecordCount.........................................................................37
GetCustomReferenceLists..............................................................................38
GetCustomSelectReferenceListOptions.........................................................39
GetDistinctUnReviewedMatchIDs.................................................................40
GetIQ8ServerSettings.....................................................................................41
GetMatchConfidenceThresholdsOptionsInfo ................................................42
GetMatchHistoryByDataflowID ....................................................................43
GetMatchHistoryByMatchID.........................................................................45
GetMatchHistoryFilteredData........................................................................47
GetMatchOptionsInfo.....................................................................................50
GetProcessingHistoryChartInfo .....................................................................51
Contents
3
Page 4
getPublicKey.................................................................................................. 52
GetRefDataVersion........................................................................................ 53
GetReferenceLists.......................................................................................... 54
GetReviewGroups.......................................................................................... 55
GetSelectReferenceListsOptionsInfo............................................................. 56
GetUserInfo ................................................................................................... 57
GetUserList....................................................................................................58
GetUnreviewedMatchesChartInfo ................................................................. 59
InsertComplianceForm .................................................................................. 60
InsertCustomListName ..................................................................................61
InsertCustomSelReferListOptions ................................................................. 62
InsertProcessingHistory .................................................................................63
InsertRefDataRecords.................................................................................... 64
InsertUser....................................................................................................... 65
InsertUserReviewGroup ................................................................................ 66
InsertWireTransferUserData..........................................................................67
IsMatchGroupDirty........................................................................................ 69
UpdateAutoUpdateInfo.................................................................................. 70
UpdateCustomSelectReferenceListsOptions ................................................. 72
UpdateIq8ServerSettings ............................................................................... 73
UpdateMatchConfidenceThresholdsOptionsInfo ..........................................74
UpdateMatchHistoryAfterReview ................................................................. 76
UpdateMatchOptionsInfo .............................................................................. 78
UpdateProcessingHistory............................................................................... 80
UpdateRefDataVersion.................................................................................. 81
UpdateSelectReferenceListsOptionsInfo....................................................... 82
UpdateUser ....................................................................................................84
UpdateUserReviewGroup.............................................................................. 85
Index..............................................................................................................87
4
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 5

Preface

About BusinessObjects Watchlist Security XI Release 2
Interdiction lists Interdiction 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 guide This 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.

Documentation Below 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.
Conventions This document follows these conventions:
Convention Description
Bold We use bold type for file names, paths, emphasis, and text that you
should type exactly as shown. For example, “Type
Italics We 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 SDK Watchlist 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:
Class Description
AddMatchHistory Adds a match history record to the TblMatchHistory
ChangePassword Changes the password or password hint for a user.
DeleteComplianceForms Removes all compliance forms from the TblCompli-
DeleteCustomListData Deletes custom list data for a given list ID from the
DeleteCustomListName Removes a custom list name from TblCustomRefer-
table. Use this for transaction or wire transfer records.
anceForms table.
TblCustomReferenceLists table.
enceLists.
DeleteCustomSelectRefer­enceListOptions
DeleteMatchHistoryByData­flowID
DeleteMatchHistoryBy­MatchID
DeleteMatchHistoryRecord Removes a match history record from the TblMatch-
DeleteReferenceDataVersion Removes a version of the reference data for a given
DeleteUser Removes a user with the given user name in the TblU-
DeleteUserReviewGroup Removes an existing review group from the TblRe-
DeleteWireTransferUserData Removes the wire transfer record with given ID from
GetAuditDetailReportData Returns an XML document that is used to generate a
Removes the custom list options record in the TblCus­tomSelRefListsOptions table for a given list ID.
Deletes match history record(s) from the TblMatchHis­tory table with a specific dataflow ID.
Deletes match history record(s) from the TblMatchHis­tory table for a given match ID.
History table for a given ID.
version number. The application stores up to two ver­sions 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.
GetAutoUpdateInfo Returns an XML document that contains the auto
update information in the TblAutoUpdateInfo table.
GetComplianceForms Retrieves 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
Class Description
GetCustomDataRecordCount Queries the number of records in the TblCustomRefer-
enceData table, which stores the reference data for user-supplied custom lists.
GetCustomReferenceLists Retrieves information about your custom lists that are
uploaded into the system.
GetCustomSelectRefer­enceListOptions
Retrieves settings used to turn on/off matching for each of your custom lists for the three matching processes: transaction, batch, and wire transfer.
GetDistinctUnReviewed­MatchIDs
Retrieves a list MatchID of distinct unreviewed records. These records are from the TblMatchHistory table.
GetIQ8ServerSettings Returns 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 data­base.
GetMatchConfidenceThresh­oldsOptionsInfo
Retrieves confidence thresholds from the TblMatch­ConfidenceThresholds table that are used to give high, medium, and low values to any matches that are found based on the generated match number.
GetMatchHistoryByDataflo­wID
Retrieves all the matched records and reference data from a batch process. All records and reference data are from the TblMatchHistory table.
GetMatchHistoryByMatchID Retrieves a record and the reference data that matched
it. The reference records can be from user supplied cus­tom list and the Watchlist Security's supplied reference lists. These records are stored in the TblMatchHistory table.
GetMatchHistoryFilteredData Retrieves unreviewed match history that match a num-
ber of filtering options. These records returned are from the TblMatchHistory table.
GetMatchOptionsInfo 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.
GetProcessingHistory­ChartInfo
Retrieves processing history for the last four days to show how many records have been processed.
getPublicKey Retrieves the public key from the web service. This
key is used to encrypt sensitive values that are passed to the server.
GetRefDataVersion Retrieves the reference data versions that are in the
data base and which version is being currently matched against.
GetReferenceLists Retrieves 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
Class Description
GetReviewGroups Retrieves the all the review groups and their informa-
tion. The review groups are stored in the TblReview­Groups table.
GetSelectReferenceListsOp­tionsInfo
Retrieves settings used to turn on and off matching for each of the provided reference lists for the three match­ing processes: transaction, batch, and wire transfer.
GetUserInfo Retrieves a user’s information. The user information is
stored in the TbluserInfo table.
GetUserList Retrieves all users and their information stored in the
TbluserInfo table.
GetUnreviewedMatches­ChartInfo
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.
InsertComplianceForm Adds a compliance report form link into the system in
one of four display groupings. The forms are stored in the TblComplianceForms table.
InsertCustomListName Inserts a new user-supplied custom list name. The
entry is stored in the TblCustomReferenceLists table.
InsertCustomSelReferListOp­tions
Inserts the user supplied custom list options for match­ing against the three types of matching: Run Single Record, Run Entire File, and Wire Transfer. These set­tings are stored in the TblCustomSelRefListsOptions table.
InsertProcessingHistory Inserts a record into the processing history in table for
a group of matches. The values are stored in the Tbl­ProcessingHistory table.
InsertRefDataRecords updates the reference data using an XML string con-
taining one or more rows to be inserted into the refer­ence data. The reference data are stored in the TblReferenceData table.
InsertUser Inserts a new user into the TblUserInfo table.
InsertUserReviewGroup Adds a new review group that users can be added to.
The information is stored in the TblReviewGroups table.
InsertWireTransferUserData Inserts 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.
IsMatchGroupDirty Checks whether a match group has been updated and
needs to be updated in the database.
UpdateAutoUpdateInfo Updates 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
Class Description
UpdateCustomSelectRefer­enceListsOptions
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.
UpdateIq8ServerSettings Updates 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 Secu­rity database. These settings are stored in the TblIQ8ServerSettings table.
UpdateMatchConfidenceTh­resholdsOptionsInfo
Updates the confidence settings for the matching pro­cess. 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.
UpdateMatchHistoryAfterRe­view
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.
UpdateMatchOptionsInfo 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.
UpdateProcessingHistory Updates a record that is stored in the processing history
in the TblProcessingHistory table for a given ID.
UpdateRefDataVersion Updates 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 previ­ous downloaded reference file update. These values are stored in the TblRefDataVersion table.
UpdateSelectReferenceList­sOptionsInfo
Updates a row in the Select Reference Lists Options for one of three types of matching: RunSingleRecord, RunEntireFile, and WireTransfer. Each of the refList­Name entries correspond to the same numbered refer­ence list in the Tblreferencelists table.
UpdateUser Updates all user information for user with the given ID
number in the TblUserInfo table.
UpdateUserReviewGroup Updates an existing review group with new values for
the group name and group description in the TblRe­viewGroups table.
16
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 17

AddMatchHistory

Syntax
Description This method adds a match history record to the TblMatchHistory table. Use this
int AddMatchHistory(string refRecUniqueID,
string listSource, string recordType, string listIDNum, string givenName, string familyName, string postName, string organization, string country, string dob, string nationality, string passport, string idNum, string matchDescription, string matchConfidence, string dataflowID, string matchID, string lastModifiedDate, string isReviewed, string isAccepted, string userID, string comment, string taskType)
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
Parameter Type Maximum
size
Description
refRecUniqueID String 20 This is populated for reference data rather
than data entered by the user.
listSourceID String 3 Holds the list ID foreign key for lists.
Less than 100: 100 or greater:
TblReferenceLists
TblCustomReferenceLists
recordType String 1 The type of record.
I:
Individual
O:
Organization
V:
Ves s e l
listIDNum String 20 An ID that identifies a specific row in the
government-supplied compliance list. It is used to look up reference data in the com­pliance list.
givenName String 60 First name of an individual (for example,
Mike or John).
familyName String 60 Last name of an individual (for example,
Smith or Johnson).
postName String 20 Post name (for example, Jr. or III).
Chapter 2: Integration SDK reference
17
Page 18
Parameter Type Maximum
size
Description
organization String 100 Organization name (for example, Business
Objects or Microsoft).
country String 30 Country name (for example, United States
or France).
dob String 11 Date of birth. The format can be dd-mmm-
yyyy or yyyy depending on the data from the specific interdiction list.
nationality String 60 Nationality (for example, Swedish or Rus-
sian).
passport String 30 The passport number.
idNum String 40 An identification number. This can be a
passport, bank ID, Social Security number, or other form of identification that is asso­ciated with an individual.
matchDescription String 20 The 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 String 6 The confidence of a positive match based
on set criteria. Value can be low, medium, or high.
dataflowID String 20 The name of the dataflow that generated
the match.
matchID String 36 A generated unique ID that is given to an
input record and the reference data that matched it to associate them.
lastModifiedDate String 8 The date that the record was last modified.
The format is yyyymmdd.
isReviewed String 1 The record’s review status.
1:
True
0:
False
isAccepted String 1 The 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
Parameter Type Maximum
size
Description
organization String 100 Organization name (for example, Business
Objects or Microsoft).
country String 30 Country name (for example, United States
or France).
dob String 11 Date of birth. The format can be dd-mmm-
yyyy or yyyy depending on the data from the specific interdiction list.
nationality String 60 Nationality (for example, Swedish or Rus-
sian).
passport String 30 The passport number.
idNum String 40 An identification number. This can be a
passport, bank ID, Social Security number, or other form of identification that is asso­ciated with an individual.
matchDescription String 20 The 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 String 6 The confidence of a positive match based
on set criteria. Value can be low, medium, or high.
dataflowID String 20 The name of the dataflow that generated
the match.
matchID String 36 A generated unique ID that is given to an
input record and the reference data that matched it to associate them.
lastModifiedDate String 8 The date that the record was last modified.
The format is yyyymmdd.
isReviewed String 1 The record’s review status.
1:
True
0:
False
isAccepted String 1 The record’s accepted or not accepted sta-
tus.
1:
True (accepted)
0:
False (not accepted)
Chapter 2: Integration SDK reference
19
Page 20
Parameter Type Maximum
userID String 50 The name of the user that processed the
comment String 150 Comments that are saved with the record
taskType String 2 The type of transaction used to process the
Returns None.
size
Description
record that was matched against the refer­ence 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
Exceptions If 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
Description This method changes the password or password hint for a user.
Parameters
bool ChangePassword(string userName,
byte[] password, string passwordHint)
Parameter Type Maximum
size
Description
username String 50 A unique name required by Watchlist Secu-
rity.
password String 50 An encrypted password. Use the public key
from the Watchlist Security Web Service by calling getPublicKey to encrypt the password.
passwordHint String 50 A hint that can help users remember their
password.
Returns
None.
Exceptions If unsuccessful, throws a SOAP exception.
Chapter 2: Integration SDK reference
21
Page 22

DeleteComplianceForms

Syntax
Description This method removes all compliance forms from the TblComplianceForms table.
Parameters None.
Returns None.
Exceptions If 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)
Description This method deletes custom list data for a given list ID from the
TblCustomReferenceLists table.
Parameters
Parameter Type Maximum
size
Description
listID String 3 A foreign key associated with custom list
names. Valid values are 100–109.
Returns
None.
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteCustomListName
GetCustomReferenceLists
InsertCustomListName
Chapter 2: Integration SDK reference
23
Page 24

DeleteCustomListName

Syntax
int DeleteCustomListName(string listID)
Description This method removes a custom list name from TblCustomReferenceLists.
Parameters
Parameter Type Maximum
size
Description
listID String 3 A foreign key associated with custom list names.
Valid values are 100–109.
Returns
None.
Exceptions If 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)
Description This method removes the custom list options record in the
TblCustomSelRefListsOptions table for a given list ID.
Parameters
Parameter Type Maximum
size
Description
listID String 3 A foreign key associated with custom list
names. Valid values are 100–109.
Returns
None.
Exceptions If unsuccessful, throws a SOAP exception.
See also GetCustomSelectReferenceListOptions
InsertCustomSelReferListOptions
UpdateCustomSelectReferenceListsOptions
Chapter 2: Integration SDK reference
25
Page 26

DeleteMatchHistoryByDataflowID

Syntax
int DeleteMatchHistoryByDataflowID(string dataflowID)
Description This 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
Parameter Type Maximum
size
Description
dataflowID String 20 A generated ID from Data Quality created by
each batch process to identify that process.
Returns
None.
Exceptions If 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)
Description This 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
Parameter Type Maximum
size
Description
matchID String 36 A generated unique ID that is assigned to an
input record and the reference data that matched it to associate them.
Returns
None.
Exceptions If 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)
Description This 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
Parameter Type Maximum
size
Description
ID Int 4 A generated ID used as a primary key for match
history records.
Returns
None.
Exceptions If 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
Description This 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
Parameter Type Maximum
size
Description
versionNumber Int 6 A version number assigned to differentiate the
version of supplied reference data.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also GetRefDataVersion
None.
UpdateRefDataVersion
Chapter 2: Integration SDK reference
29
Page 30

DeleteUser

Syntax
Description This 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
Parameter Type Maximum
size
Description
username String 50 The name of the user.
Returns
None.
Exceptions If unsuccessful, throws a SOAP exception.
See also InsertUser
UpdateUser
30
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 31

DeleteUserReviewGroup

Syntax
Description This 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
Parameter Type Maximum
size
Description
reviewGroupName String 50 The name of the review group that a user is
assigned to. A value must exist in the Tbl­ReviewGroups table.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
None.
See also InsertUserReviewGroup
GetReviewGroups
UpdateUserReviewGroup
Chapter 2: Integration SDK reference
31
Page 32

DeleteWireTransferUserData

Syntax
Description This 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
Parameter Type Maximum
size
Description
wireID Int 4 A generated ID used as a primary key for a wire
transaction record.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
None.
See also InsertWireTransferUserData
32
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 33

GetAuditDetailReportData

Syntax
Description This method returns an XML document that is used to generate a detailed audit
string GetAuditDetailReportData(string taskTypeFilter,
string userId, string dateFrom, string dateTo)
report with options to filter on task type, who processed the records and time period.
Parameters
Parameter Type Maximum
size
Description
taskTypeFilter String 10 The type of transaction used to process the
record.
'B% ':
Batch
'F% ':
FinCEN
'T% ':
Transaction
'W%':
Either the wire sender or wire benefi-
ciary for a wire transfer.
'%':
All (for SQL Server and Oracle database)
' ':
All (for DB2 database)
userId String 50 The name of the user that ran the matching pro-
cess for the record.
dateFrom String 8 The beginning date in a time span. It is in the
format yyyyddmm.
dateTo String 8 The end date in a time span. It is in the format
yyyyddmm.
Returns
Returns an XML document that contains values from the TblProcessingHistory table that match the given criteria.
ID userID workType recordsProcessed dateOfEntry
Exceptions If unsuccessful, throws a SOAP exception.
See also GetAuditSummaryReportData
Chapter 2: Integration SDK reference
33
Page 34

GetAuditSummaryReportData

Syntax
Description This method returns an XML document that is used to generate a detailed audit
string GetAuditSummaryReportData(string taskTypeFilter,
string userId, string DateFrom, string DateTo)
report with options to filter on task type, who processed the records and time period.
Parameters
Parameter Type Maximum
size
Description
taskTypeFilter String 10 The type of transaction used to process the
record.
'B% ':
Batch
'F% ':
FinCEN
'T% ':
Transaction
'W%':
Either the wire sender or wire benefi-
ciary for a wire transfer.
'%':
All (for SQL Server and Oracle database)
' ':
All (for DB2 database)
userId String 50 The name of the user that ran the matching pro-
cess for the record.
dateFrom String 8 The beginning date in a time span. It is in the
format yyyyddmm.
dateTo String 8 The end date in a time span. It is in the format
yyyyddmm.
Returns
Returns an XML document that contains values from the TblProcessingHistory table that match the given criteria.
userID workType records processed
Exceptions If unsuccessful, throws a SOAP exception.
See also GetAuditDetailReportData
34
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 35

GetAutoUpdateInfo

Syntax
string GetAutoUpdateInfo()
Description This method retrieves the settings that control the updating of the supplied
reference data.
Parameters None.
Returns This method returns an XML document that contains the auto update information
in the TblAutoUpdateInfo table.
ItemID InitialCheckDelaySeconds OngoingCheckInterval IsManualCheckOnly DefaultCheckDelaySeconds CustCareUserName CustCarePassword UseProxy ProxyAddress ProxyPort ProxyUserName ProxyPassword DefaultOngoingCheckInterval DefaultIsManualCheckOnly DefaultDataURL
Exceptions If unsuccessful, throws a SOAP exception.
See also UpdateAutoUpdateInfo
Chapter 2: Integration SDK reference
35
Page 36

GetComplianceForms

Syntax
Description This method retrieves the list of compliance form names and the associated URL
string GetComplianceForms(string type)
used to report matches on the various government-supplied compliance lists.
Parameters
Parameter Type Maximum
size
Description
type String 4 Compliance 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.
Returns
FORM:
Returns an XML document that contains values from the TblComplianceForms
Other forms.
table where Type matches the input Type parameter.
Type FormName URL
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteComplianceForms
InsertComplianceForm
36
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 37

GetCustomDataRecordCount

Syntax
Description This method queries the number of records in the TblCustomReferenceData
string GetCustomDataRecordCount()
table, which stores the reference data for user-supplied custom lists.
Parameters None.
Exceptions If unsuccessful, throws a SOAP exception.
Returns Returns an XML string that contains the number of records in the
TblCustomReferenceData table.
Chapter 2: Integration SDK reference
37
Page 38

GetCustomReferenceLists

Syntax
string GetCustomReferenceLists()
Description This method retrieves information about your custom lists that are uploaded into
the system.
Parameters None.
Returns Returns an XML document that contains values for all custom lists in the
TblCustomReferenceLists table.
ListSourceID ListSource ListFullName
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteCustomListData
DeleteCustomListName
InsertCustomListName
38
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 39

GetCustomSelectReferenceListOptions

Syntax
string GetCustomSelectReferenceListOptions()
Description This method retrieves settings used to turn on/off matching for each of your
custom lists for the three matching processes: transaction, batch, and wire transfer.
Parameters None.
Returns Returns an XML document that contains all values from the
TblCustomSelRefListsOptions table for each custom record available.
listID RunSingleRecord RunEntireFile WireTransfer
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteCustomSelectReferenceListOptions
InsertCustomSelReferListOptions
UpdateCustomSelectReferenceListsOptions
Chapter 2: Integration SDK reference
39
Page 40

GetDistinctUnReviewedMatchIDs

Syntax
Description This method retrieves a list MatchID of distinct unreviewed records. These
string GetDistinctUnReviewedMatchIDs()
records are from the TblMatchHistory table.
Parameters None.
Exceptions If unsuccessful, throws a SOAP exception.
Returns Returns an XML document that contains a list of distinct MatchIDs from the
TblMatchHistory table.
40
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 41

GetIQ8ServerSettings

Syntax
string GetIQ8ServerSettings()
Description This method returns 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.
Parameters None.
Returns Returns an XML document with the server settings from the TblIQ8Settings
table.
IQ8HostName IQ8PortNumber IQ8ReposPath IQ8DataSourceName IQ8DriverName IQ8FLIQServiceURL DefaultIQ8HostName DefaultIQ8PortNumber DefaultIQ8ReposPath DefaultIQ8DataSourceName DefaultIQ8DriverName DefaultIQ8FLIQServiceURL
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.
Exceptions If unsuccessful, throws a SOAP exception.
See also UpdateIq8ServerSettings
Chapter 2: Integration SDK reference
41
Page 42

GetMatchConfidenceThresholdsOptionsInfo

Syntax
string GetMatchConfidenceThresholdsOptionsInfo()
Description This 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.
Parameters None.
Returns Returns an XML document with the values stored in the
TblMatchConfidenceThresholds table.
ItemID matchScenarioName isHighConfidence isMediumConfidence isLowConfidence highConfidenceLB highConfidenceUB mediumConfidenceLB mediumConfidenceUB lowConfidenceLB lowConfidenceUB comments defaultIsHighConfidence defaultIsMediumConfidence defaultIsLowConfidence defaultHighConfidenceLB defaultHighConfidenceUB defaultMediumConfidenceLB defaultMediumConfidenceUB defaultLowConfidenceLB defaultLowConfidenceUB
Exceptions If unsuccessful, throws a SOAP exception.
See also UpdateMatchConfidenceThresholdsOptionsInfo
42
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 43

GetMatchHistoryByDataflowID

Syntax
string GetMatchHistoryByDataflowID(string DataFlowID)
Description This method retrieves all the matched records and reference data from a batch
process. All records and reference data are from the TblMatchHistory table.
Parameters
Parameter Type Maximum
size
Description
DataFlowID String 20 A dataflow ID generated by Data Quality that is
used to associate all of the records processed in a batch.
Returns
Returns an XML document containing the match history records that match the given DataFlowID in the TblMatchHistory table.
Values for each row include:
ID RefRecUniqueID DataflowID MatchID MatchDescription ListSource1 ListSource2 RecordType ListIDNum GivenName FamilyName PostName Organization Country DOB Nationality Passport IdNum IsReviewed IsAccepted UserID LastModifiedDate Comments reviewGroupName Task Type
Exceptions If 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)
Description This 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
Parameter Type Maximum
size
Description
MatchID String 36 A 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.
Values for each row include:
ID RefRecUniqueID DataflowID MatchID MatchDescription ListSource1 ListSource2 RecordType ListIDNum GivenName FamilyName PostName Organization Country DOB Nationality Passport IdNum IsReviewed IsAccepted UserID LastModifiedDate Comments reviewGroupName Task Type
Exceptions If unsuccessful, throws a SOAP exception.
See also AddMatchHistory
DeleteMatchHistoryByDataflowID
Chapter 2: Integration SDK reference
45
Page 46
DeleteMatchHistoryByMatchID
DeleteMatchHistoryRecord
GetMatchHistoryByDataflowID
GetMatchHistoryFilteredData
GetUnreviewedMatchesChartInfo
IsMatchGroupDirty
UpdateMatchHistoryAfterReview
46
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 47

GetMatchHistoryFilteredData

Syntax
Description This method retrieves unreviewed match history that match a number of filtering
string GetMatchHistoryFilteredData(string userId,
string reviewGroupName, string taskType, string recordTypeFlagI, string recordTypeFlagO, string recordTypeFlagV, int reviewedFlag1, int reviewedFlag2, int acceptedFlag1, int acceptedFlag2, string dateFrom, string dateTo)
options. These records returned are from the TblMatchHistory table.
Parameters
Parameter Type Maximum
size
Description
userId String 50 The name of the user that ran the matching
process for the record.
reviewGroup­Name
String 50 The name of the review group that a user is
assigned to. This filters by records matched by users in the review group.
taskType String 2 The type of transaction used to process the
record.
T:
Transaction
B:
Batch
F:
FinCEN
WS:
Wire Sender
WB:
Wire Beneficiary
recordTypeFlagI recordTypeFlagO recordTypeFlagV
String 1 The type of record.
I:
Individual
O:
Organization
V:
Ve s se l
recordTypeFlagI, recordTypeFlagO, and recordTypeFlagV are used together to select any combination of the record types.
reviewedFlag1 reviewedFlag2
String 1 Indicates whether records are reviewed or
not reviewed.
1:
True (reviewed)
0:
False (not reviewed)
reviewFlag1 and reviewFlag2 are used to select any combination of the reviewed or unreviewed records.
Chapter 2: Integration SDK reference
47
Page 48
Parameter Type Maximum
size
Description
acceptedFlag1 acceptedFlag2
String 1 Indicates whether records are accepted or
not accepted
1:
True (accepted)
0:
False (not accepted)
acceptedFlag1 and acceptedFlag2 are used to select any combination of the accepted or unaccepted records.
dateFrom String 8 Selects records more recent than dateFrom
using the format yyyymmdd.
dateTo String 8 Selects records older than dateTo using the
format yyyymmdd.
Returns Returns an XML document that contains the match history records that match the
given criteria in the TblMatchHistory table.
Values for each row include:
ID RefRecUniqueID DataflowID MatchID MatchDescription ListSource1 ListSource2 RecordType ListIDNum GivenName FamilyName PostName Organization Country DOB Nationality Passport IdNum IsReviewed IsAccepted UserID LastModifiedDate Comments reviewGroupName Task Type
Exceptions If 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()
Description This 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.
Parameters None.
Returns Returns an XML document with the values stored in the TblMatchOptions table.
ItemID MatchFieldName SimilarityThreshold InitialsMatch SubstringMatch AbbreviationMatch DefaultSimilarityThreshold DefaultInitialsMatch DefaultSubstringMatch DefaultAbbreviationMatch Comments InitialsMatch SubstringMatch AbbreviationMatch DefaultInitialsMatch DefaultSubstringMatch
DefaultAbbreviationMatch values:
1: True 0: False
Exceptions If unsuccessful, throws a SOAP exception.
See also UpdateMatchOptionsInfo
50
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 51

GetProcessingHistoryChartInfo

Syntax
string GetProcessingHistoryChartInfo(string todayStr)
Description This method retrieves processing history for the last four days to show how many
records have been processed.
Parameters
Parameter Type Maximum
size
Description
todayStr String 10 Today’s date in the format mm/dd/yyyy.
Returns
Returns an XML document that contains values from the TblProcessingHistory table.
sumToday sumYesterday sum2DaysAgo sum3DaysAgo
Exceptions If unsuccessful, throws a SOAP exception.
See also InsertProcessingHistory
UpdateProcessingHistory
Chapter 2: Integration SDK reference
51
Page 52

getPublicKey

Syntax
Description This method retrieves the public key from the web service. This key is used to
string getPublicKey()
encrypt sensitive values that are passed to the server.
Parameters None.
Returns Returns an XML string that contains the public key that is used to encrypt the
user name and password to authenticate with the Watchlist Security web service.
Exceptions If unsuccessful, throws a SOAP exception.
52
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 53

GetRefDataVersion

Syntax
string GetRefDataVersion()
Description This method retrieves the reference data versions that are in the data base and
which version is being currently matched against.
Parameters None.
Returns Returns an XML document with values from the TblRefDataVersion table.
RefDataVersion BackupDataVersion SelectedVersion
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).
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteReferenceDataVersion
UpdateRefDataVersion
Chapter 2: Integration SDK reference
53
Page 54

GetReferenceLists

Syntax
string GetReferenceLists()
Description This method retrieves the information for each or the supplied reference lists. The
information for the lists are stored in the TblReferenceLists table.
Parameters None.
Returns Returns an XML document containing the values for each interdiction list in the
TblReferenceLists table.
ListSourceID ListSource ListFullName IsInActive DefaultIsInActive
Exceptions If unsuccessful, throws a SOAP exception.
See also GetSelectReferenceListsOptionsInfo
UpdateSelectReferenceListsOptionsInfo
54
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 55

GetReviewGroups

Syntax
string GetReviewGroups()
Description This method retrieves the all the review groups and their information. The review
groups are stored in the TblReviewGroups table.
Parameters None.
Returns Returns all review groups in an XML document from the TblReviewGroups
table.
ID ReviewGroupName ReviewGroupDescription
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteUserReviewGroup
InsertUserReviewGroup
UpdateUserReviewGroup
Chapter 2: Integration SDK reference
55
Page 56

GetSelectReferenceListsOptionsInfo

Syntax
string GetSelectReferenceListsOptionsInfo()
Description This method 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.
Parameters None.
Returns Returns an XML document that has the three rows of data stored in the
TblSelectReferenceListsOptions table.
ItemID MatchTaskType Comments UseNoMatdchList RefListName1–RefListName40
Exceptions If unsuccessful, throws a SOAP exception.
See also GetReferenceLists
UpdateSelectReferenceListsOptionsInfo
56
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 57

GetUserInfo

Syntax
string GetUserInfo(string userName)
Description This method retrieves a user’s information. The user information is stored in the
TbluserInfo table.
Parameters
Parameter Type Maximum
size
Description
username String 50 The name of the user that you’re retrieving infor-
mation for.
Returns
Returns an XML document with the given users info from the TblUserInfo table.
ID UserName DisplayName RoleId Email PasswordHash PasswordSalt PasswordHint ReviewGroupName isActive
Exceptions If unsuccessful, throws a SOAP exception.
See also GetUserList
Chapter 2: Integration SDK reference
57
Page 58

GetUserList

Syntax
string GetUserList()
Description This method retrieves all users and their information stored in the TbluserInfo
table.
Parameters None.
Returns Returns an XML document with all user information stored in the TblUserInfo
table.
ID UserName DisplayName RoleId Email PasswordHash PasswordSalt PasswordHint ReviewGroupName isActive
Exceptions If unsuccessful, throws a SOAP exception.
See also GetUserInfo
58
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 59

GetUnreviewedMatchesChartInfo

Syntax
string GetUnreviewedMatchesChartInfo(string todayStr,
string reviewGroup)
Description This 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
Parameter Type Maximum
size
Description
todayStr String 10 Today’s date in the format mm/dd/yyyy.
reviewGroup String 50 A 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
Exceptions If 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
Description This 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
Parameter Type Maximum
size
Description
Type String 4 Compliance 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.
formName String 200 The name of a compliance form.
URL String 200 The web page where a compliance form is
located.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteComplianceForms
None.
GetComplianceForms
60
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 61

InsertCustomListName

Syntax
Description This 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
Parameter Type Maximum
size
Description
listID String 3 A foreign key associated with custom list names.
Valid values are 100–109.
listSource String 80 The name of a custom list as it is displayed in
Watchlist Security.
listFullName String 200 A custom list’s full name with any extra version
or other information that is not displayed in Watchlist Security.
Returns
None.
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteCustomListData
DeleteCustomListName
GetCustomReferenceLists
Chapter 2: Integration SDK reference
61
Page 62

InsertCustomSelReferListOptions

Syntax
Description This method inserts the user supplied custom list options for matching against the
int InsertCustomSelReferListOptions(string listID,
string RunSingleRecord, string RunEntireFile, string WireTransfer)
three types of matching: Run Single Record, Run Entire File, and Wire Transfer. These settings are stored in the TblCustomSelRefListsOptions table.
Parameters
Parameter Type Maximum
size
Description
listID String 3 A foreign key in the TblCustomRefer-
enceLists table used to associated list options with a custom list.
RunSingleRecord String 80 Used to turn matching on and off against a
custom list for a single record matching transaction.
Null string:
Does not match against custom
list.
Name of list:
Matches against custom list.
RunEntireFile String 80 Used to turn matching on and off against a
custom list for a Run Entire File transaction.
Null string:
Does not match against custom
list.
Name of list:
Matches against custom list.
WireTransfer String 80 Used to turn matching on and off against a
custom list for a Wire Transfer transaction.
Null string:
list.
Name of list:
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteCustomSelectReferenceListOptions
None.
GetCustomSelectReferenceListOptions
UpdateCustomSelectReferenceListsOptions
Does not match against custom
Matches against custom list.
62
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 63

InsertProcessingHistory

Syntax
Description This method inserts a record into the processing history in table for a group of
int InsertProcessingHistory(string userID,
string workTypeName, int recordsProcessed, string dateOfEntry)
matches. The values are stored in the TblProcessingHistory table.
Parameters
Parameter Type Maximum
size
Description
userID String 50 The name of the user that ran the matching
process.
workTypeName String 50 The processing type used in the match pro-
cess.
TRANSACTION: FINCEN: BATCH:
FinCEN
Batch file
WIRE_TRANSFER:
Single record
Wire transfer
recordsProcessed Int 4 The number of records processed during the
matching process.
dateOfEntry String 8 The date that the processing history record
was entered in the format yyyymmdd.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also GetProcessingHistoryChartInfo
None.
UpdateProcessingHistory
Chapter 2: Integration SDK reference
63
Page 64

InsertRefDataRecords

Syntax
int InsertRefDataRecords(string dataSetStr)
Description This method updates the reference data using an XML string containing one or
more rows to be inserted into the reference data. The reference data are stored in the TblReferenceData table.
Parameters
Parameter Description
dataSetStr An XML document that contains one or more records that have the
following tags:
REFDATAVERSION
LISTSOURCEID
RECORDTYPE
LISTIDNUM
GIVENNAME
MTCGIVENNAME
MTCGIVENNAMEALT1
MTCGIVENNAMEALT2
MTCGIVENNAMEALT3
FAMILYNAME
MTCFAMILYNAME
POSTNAME
ORGANIZATION
MTCORGANIZATION
COUNTRY
DOB
NATIONALITY
PASSPORT
IDNUM
Returns
None.
Exceptions If unsuccessful, throws a SOAP exception.
64
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 65

InsertUser

Syntax
Description This method inserts a new user into the TblUserInfo table.
Parameters
Int InsertUser(string userName,
string userFullName, string userRoleID, string userEmail, byte[] password, string passwordHint, string reviewGroupName, string isActive)
Parameter Type Maximum
size
Description
username String 50 The name of the user.
userFullName String 50 The user’s full name, including first and last
names.
userRoleID String 10 Indicates the user’s role. The three roles are
admin, reviewer, and normal (or basic).
userEmail String 100 The user's e-mail address.
byte[ ] password String 50 An encrypted byte array. Use the public key
from the Watchlist Security Web Service by calling getPublicKey to encrypt the pass­word.
passwordHint String 50 A hint that can help users remember their
reviewGroupName String 50 The name of the review group that a user is
isActive String 1 Enables and disables a user account. Use
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteUser
None.
UpdateUser
password.
assigned to. A value must exist in the Tbl­ReviewGroups table.
this instead of deleting accounts to save the information.
1:
Account is enabled.
0:
Account is disabled.
Chapter 2: Integration SDK reference
65
Page 66

InsertUserReviewGroup

Syntax
Description This method adds a new review group that users can be added to. The information
int InsertUserReviewGroup(string reviewGroupName,
string reviewGroupDescription)
is stored in the TblReviewGroups table.
Parameters
Parameter Type Maximum
size
Description
reviewGroupName String 50 The name of the review group that a
user is assigned to. The reviewGroup­Name must be unique, so you can not insert a duplicate name.
reviewGroupDescription String 100 A description of the review group.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteUserReviewGroup
None.
GetReviewGroups
UpdateUserReviewGroup
66
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 67

InsertWireTransferUserData

Syntax
Description This method inserts the sender’s and beneficiary’s wire transaction information
int InsertWireTransferUserData(string DOE,
string UserID, string S_GivenName, string S_FamilyName, string S_PostName, string S_Organization, string S_Country, string S_RecordType, string S_IDNum, string B_GivenName, string B_FamilyName, string B_PostName, string B_Organization, string B_Country, string B_RecordType, string B_IDNum)
into the wire match history table to be used to match against the FinCEN list. Values are stored in the TblWireTransferUserData table.
Parameters
Parameter Type Maximum
size
Description
DOE String 11 The date of entry in the format yyyymmdd.
UserID String 50 The name of the user that ran the wire transfer
matching process.
S_GivenName String 60 The sender’s given name.
S_FamilyName String 60 The sender’s family name.
S_PostName String 20 The sender’s post name.
S_Organization String 100 The sender’s organization name.
S_Country String 30 The sender’s country.
S_RecordType String 1 The record type of the sender.
I:
Individual
O:
Organization
V:
Ve s se l
S_IDNum String 40 The sender’s passport, driver license, or other
associated identification number.
B_GivenName String 60 The beneficiary’s given name.
B_FamilyName String 60 The beneficiary’s family name.
B_PostName String 20 The beneficiary’s post name.
B_Organization String 100 The beneficiary’s organization name.
B_Country String 30 The beneficiary’s country.
Chapter 2: Integration SDK reference
67
Page 68
Parameter Type Maximum
size
Description
B_RecordType String 1 The record type of the beneficiary.
I:
Individual
O:
Organization
V:
Ves se l
B_IDNum String 40 The beneficiary’s passport, driver license, or
other associated identification number.
Returns None.
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteWireTransferUserData
68
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 69

IsMatchGroupDirty

Syntax
Description This method checks whether a match group has been updated and needs to be
string IsMatchGroupDirty(string matchID,
string isBatch)
updated in the database.
Parameters
Parameter Type Maximum
size
Description
matchID String 36 A generated match ID that associates an input
record with the reference data that it matched.
isBatch String 1 Indicates whether the setting is a batch process
1:
Batch
0:
All other processing types
Returns
Returns an XML document with the values for a given matchID or DataFlowID in the TblMatchHistory table.
NumDirty DoesGroupExist
If isBatch is set to 0, the method returns the number of records that have same matchID, and either isReviewed or isAccepted is set to 1.
If isBatch is set to 1, the method returns the number of records that have same DataFlowID, and either isReviewed or isAccepted is set to 1.
Exceptions If unsuccessful, throws a SOAP exception.
Chapter 2: Integration SDK reference
69
Page 70

UpdateAutoUpdateInfo

Syntax
Description This method updates the reference file updating process and how to connect to
int UpdateAutoUpdateInfo(int itemID,
int initialDelaySeconds, int ongoingCheckInterval, string isManualCheckOnly, string custCareUserName, string custCarePassword, string useProxy, string proxyAddress, int proxyPort, string proxyUserName, string proxyPassword, int defaultCheckDelaySeconds, int defaultOngoingCheckInterval, string defaultIsManualCheckOnly, string defaultDataURL)
the download site. These settings are stored in the TblAutoUpdateInfo table.
Parameters
Parameter Type Maximum
size
Description
initialDelaySeconds Int 4 The time in seconds before Watchlist
Security contacts the Data Quality Server for updates after the application is first launched.
ongoingCheckInterval Int 4 The time interval between checks after
the initial check for updates.
isManualCheckOnly Int 4 Indicates whether Watchlist Security
checks for updates automatically.
1:
Manual.
0:
Automatic checks for updates using
specified time intervals.
custCareUserName String 50 The user name for download reference
data. The default is blank.
custCarePassword String 50 The password for downloading refer-
ence data. The default is blank.
useProxy String 1 Indicates whether you use a proxy to
connect to the Internet.
1:
Use a proxy.
0:
Use a direct connection.
proxyAddress String 100 The address of the proxy.
proxyPort Int 4 The port that the proxy host listens to.
proxyUserName String 50 The user name used to connect to the
proxy.
proxyPassword String 50 The password used to connect to the
proxy.
70
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 71
Parameter Type Maximum
size
Description
defaultCheckDelaySec-
Int 4 The default time in seconds before
onds
defaultOngoingCheck-
Int 4 The default time interval between
Interval
defaultIsManualCheck-
Int 1 The default indicator for whether
Only
defaultDataURL String 100 The URL used to download the new
Returns None.
Exceptions If unsuccessful, throws a SOAP exception.
See also GetAutoUpdateInfo
Watchlist Security contacts the Data Quality Server for updates after the application is first launched.
checks after the initial check for updates.
Watchlist Security checks for updates automatically.
1:
Manual.
0:
Automatic checks for updates using
specified time intervals.
updated reference data.
Chapter 2: Integration SDK reference
71
Page 72

UpdateCustomSelectReferenceListsOptions

Syntax
Description This method updates your custom list options for matching against the three types
int UpdateCustomSelectReferenceListsOptions(string listID,
string RunSingleRecord, string RunEntireFile, string WireTransfer)
of matching: Run Single Record, Run Entire File, and Wire Transfer. These settings are stored in the TblCustomSelRefListsOptions table.
Parameters
Parameter Type Maximum
size
Description
listID String 3 A foreign key to the TblCustomRefer-
enceLists table used to associate list options with the custom list.
RunSingleRecord String 80 Used to turn matching on and off against a
custom list for a single record matching transaction.
Null string:
Does not match against custom
list.
Name of list:
Matches against custom list.
RunEntireFile String 80 Used to turn matching on and off against a
custom list for a Run Entire File transaction.
Null string:
Does not match against custom
list.
Name of list:
Matches against custom list.
WireTransfer String 80 Used to turn matching on and off against a
custom list for a Wire Transfer transaction.
Null string:
list.
Name of list:
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteCustomSelectReferenceListOptions
None.
GetCustomSelectReferenceListOptions
InsertCustomSelReferListOptions
Does not match against custom
Matches against custom list.
72
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 73

UpdateIq8ServerSettings

Syntax
Description This method updates the settings for the Data Quality Server and the Watchlist
int UpdateIq8ServerSettings(int itemID,
string iq8HostName, int iq8PortNumber, string iq8ReposPath, string iq8DataSourceName, string iq8DriverName, string iq8FirstlogicIQServiceURL)
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
Parameter Type Maximum
size
Description
itemID Int 4 A generated ID used as a primary key.
iq8HostName String 100 The name of the machine where the
Data Quality Server that Watchlist Security uses is installed.
iq8PortNumber Int 4 The Data Quality Server port number.
iq8ReposPath String 1024 The Data Quality Server repository
iq8DataSourceName String 512 Stores the connection settings for the
iq8DriverName String 50 The Data Quality-supplied driver that
iq8FirstlogicIQService
String 1024 The Data Quality Web Service URL
URL
Returns
Exceptions If 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
Description This 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
Parameter Type Maximum
size
Description
matchScenarioName String 30 Indicates the type of matching sce-
nario.
NameAndDOB
NameANDIdNum
NameAndPassport
NameOnly
OrganizationAndIdNum
OrganizationOnly
74
isHighConfidence String 1 Indicates whether a match result can
isMediumConfidence String 1 Indicates whether a match result can
isLowConfidence String 1 Indicates whether a match result can
highConfidenceLower-
Int 4 The lower bound for the high confi-
Bound
highConfidenceUpper-
Int 4 The 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
Parameter Type Maximum
size
Description
mediumConfidence­LowerBound
mediumConfidenceUp­perBound
lowConfidenceLower­Bound
lowConfidenceUpper­Bound
Returns None.
Exceptions If unsuccessful, throws a SOAP exception.
See also GetMatchConfidenceThresholdsOptionsInfo
Int 4 The lower bound for the medium con-
fidence.
Int 4 The upper bound for the medium con-
fidence
Int 4 The lower bound for the low confi-
dence.
Int 4 The upper bound for the low confi-
dence.
Chapter 2: Integration SDK reference
75
Page 76

UpdateMatchHistoryAfterReview

Syntax
int UpdateMatchHistoryAfterReview(int ID,
string IDNum, string isReviewed, string isAccepted, string Comment, string LastModifiedDate)
Description This 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
Parameter Type Maximum
size
Description
ID Int 4 A generated primary key.
IDNum String 40 Set the IDNUM if you are going to attach an
internal ID to the entity.
isReviewed String 1 Indicates whether the record has been
reviewed
1:
True (reviewed)
0:
False (not reviewed)
isAccepted String 1 Indicates whether the record has been
accepted.
1: 0:
Comment String 150 Indicates the reason that the reviewer
accepted or denied the record and who reviewed it.
LastModifiedDate String 8 The date of review in format yyyymmdd.
Returns
None.
Exceptions If 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
Description This method updates the match options for three fields that you can match on:
int UpdateMatchOptionsInfo(int itemID,
string matchFieldName, int similarityThreshold, string initialsMatch, string substringMatch, string abbreviationMatch, string comment)
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
Parameter Type Maximum
size
Description
itemID Int 4 A generated ID used as a primary key.
matchFieldName String 30 A 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.
similarityThresh­old
Int 4 A 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.
initialsMatch Int 1 Indicates whether initials match spelled out
words (for example, William G. Barney and W. G. Barney).
1:
True
0:
False
substringMatch Int 1 Indicates whether substrings of words are
considered a match (for example, Ibrahim Salih Mohammad Al Yacoub and Ibrah Moham Al Yacoub).
1:
True
0:
False
abbreviationMatch Int 1 Indicates whether abbreviations are consid-
ered a match (for example, International Health Providers and Intl Health Prov.).
1:
True
0:
False
comment String 100 Stores 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
Exceptions If unsuccessful, throws a SOAP exception.
See also GetMatchOptionsInfo
Chapter 2: Integration SDK reference
79
Page 80

UpdateProcessingHistory

Syntax
Description This 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
Parameter Type Maximum
size
Description
ID Int 4 A generated primary key.
userID String 50 The name of the user that ran the matching
process for the record.
workTypeName String 50 The processing type used in the match pro-
cess.
TRANSACTION: FINCEN: BATCH:
FinCEN
Batch file
WIRE_TRANSFER:
Single record
Wire transfer
recordsProcessed Int 4 The number of records that were run
through the matching process for the speci­fied processing history record.
dateOfEntry String 8 The date that a record was entered using the
format yyyymmdd.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also GetProcessingHistoryChartInfo
None.
InsertProcessingHistory
80
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 81

UpdateRefDataVersion

Syntax
Description This 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
Parameter Type Maximum
size
Description
oldRefDataVersion String 6 Stores the backup version of the reference
data.
newRefDataVersion String 6 Stores the newest version of the reference
data.
selectedVersion String 7 Indicates which version of reference data
to match
Current: Backup:
Current version.
Previous version.
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteReferenceDataVersion
None.
GetRefDataVersion
Chapter 2: Integration SDK reference
81
Page 82

UpdateSelectReferenceListsOptionsInfo

Syntax
int UpdateSelectReferenceListsOptionsInfo(int itemID,
string matchTaskTypeName, string comment, string useNoMatchList, string refListName1, string refListName2, string refListName3, string refListName4, string refListName5, string refListName6, string refListName7, string refListName8, string refListName9, string refListName10, string refListName11, string refListName12, string refListName13, string refListName14, string refListName15, string refListName16, string refListName17, string refListName18, string refListName19, string refListName20, string refListName21, string refListName22, string refListName23, string refListName24, string refListName25, string refListName26, string refListName27, string refListName28, string refListName29, string refListName30, string refListName31, string refListName32, string refListName33, string refListName34, string refListName35, string refListName36, string refListName37, string refListName38, string refListName39, string refListName40)
Description This method updates a row in the Select Reference Lists Options for one of three
types of matching: RunSingleRecord, RunEntireFile, and WireTransfer. Each of
refListName
the
entries correspond to the same numbered reference list in the
Tblreferencelists table.
82
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 83
Parameters
Parameter Type Maximum
size
Description
itemID Int 4 Watchlist Security has three different match-
ing processes. The item ID is used to associ­ate the settings with matching type.
1:
Single record.
2:
Batch.
3:
Wire transfer.
matchTaskType String 30 A description associated with the itemID.
The default values are RunSingleRecord, RunEntireFile, and WireTransfer.
comment String 100 Stores comments about why options are set
to the values specified.
useNoMatchList String 1 Indicates whether there are lists turned on to
match against.
0:
Matching is turned on.
1:
Matching is turned off.
refListName1... reflistName40
String 80 Used to turn matching on and off against an
interdiction list for a single record matching transaction. refListName 1 through 40 match up with TblReferenceLists ListSour­ceID values 1 through 40
Null string:
Does not match against inter-
diction list.
Name of list:
Matches against interdiction
list.
Returns
Updates the TblSelectReferenceListsOptions table on MatchTaskTypeName.
MatchTaskTypeName can equal RunSingleRecord, RunEntireFile, and WireTransfer.
Exceptions If unsuccessful, throws a SOAP exception.
See also GetReferenceLists
GetSelectReferenceListsOptionsInfo
Chapter 2: Integration SDK reference
83
Page 84

UpdateUser

Syntax
Description This method updates all user information for user with the given ID number in the
int UpdateUser(int ID,
string userName, string userFullName, string roleID, string userEmail, byte[] password, string passwordHint, string reviewGroupName, string isActive)
TblUserInfo table.
Parameters
Parameter Type Maximum
size
Description
ID Int 4 A generated primary key.
username String 50 The name of the user. This is a unique
name that should not be changed.
userFullName String 50 The user’s full name, including first and
last names.
userRoleID String 10 Indicates the user’s role. The three roles are
admin, reviewer, and normal (or basic).
userEmail String 100 The user's e-mail address.
byte[ ] password String 50 An encrypted byte array. Use the public
passwordHint String 50 A hint that can help users remember their
reviewGroupName String 50 The name of the review group that a user is
isActive String 1 Enables and disables a user account. Use
Returns
Exceptions If unsuccessful, throws a SOAP exception.
None.
key from the Watchlist Security Web Ser­vice by calling getPublicKey to encrypt the password.
password.
assigned to. A value must exist in the Tbl­ReviewGroups table.
this instead of deleting accounts to save the information.
1:
Account is enabled.
0:
Account is disabled.
See also DeleteUser
InsertUser
84
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 85

UpdateUserReviewGroup

Syntax
Description This method updates an existing review group with new values for the group
int UpdateUserReviewGroup(string reviewGroupName,
string reviewGroupDescription)
name and group description in the TblReviewGroups table.
Parameters
Parameter Type Maximum
size
Description
reviewGroupName String 50 The name of the review group that a
user is assigned to. A value must exist in the TblReviewGroups table.
reviewGroupDescrip-
String 100 A description of the review group.
tion
Returns
Exceptions If unsuccessful, throws a SOAP exception.
See also DeleteUserReviewGroup
None.
GetReviewGroups
InsertUserReviewGroup
Chapter 2: Integration SDK reference
85
Page 86
86
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Page 87

Index

Symbols
.NET
samples, 8
A
AddMatchHistory, 17
C
ChangePassword, 21
D
DeleteComplianceForms, 22 DeleteCustomListData, 23 DeleteCustomListName, 24 DeleteCustomSelectReferenceListOptions, 25 DeleteMatchHistoryByDataflowID, 26 DeleteMatchHistoryByMatchID, 27 DeleteMatchHistoryRecord, 28 DeleteReferenceDataVersion, 29 DeleteUser, 30 DeleteUserReviewGroup, 31 DeleteWireTransferUserData, 32
G
GetAuditDetailReportData, 33 GetAuditSummaryReportData, 34 GetAutoUpdateInfo, 35 GetComplianceForms, 36 GetCustomDataRecordCount, 37 GetCustomReferenceLists, 38 GetCustomSelectReferenceListOptions, 39 GetDistinctUnReviewedMatchIDs, 40 GetIQ8ServerSettings, 41 GetMatchConfidenceThresholdsOptionsInfo, 42 GetMatchHistoryByDataflowID, 43 GetMatchHistoryByMatchID, 45 GetMatchHistoryFilteredData, 47 GetMatchOptionsInfo, 50 GetProcessingHistoryChartInfo, 51 getPublicKey, 52 GetRefDataVersion, 53 GetReferenceLists, 54
GetReviewGroups, 55 GetUnreviewedMatchesChartInfo, 59 GetUserInfo, 57 GetUserList, 58 graphical samples
installation location
, 8
I
InsertComplianceForm, 60 InsertCustomListName, 61 InsertCustomSelReferListOptions, 62 InsertProcessingHistory, 63 InsertRefDataRecords, 64 InsertUser, 65 InsertWireTransferUserData, 67 IsMatchGroupDirty, 69
N
nsertUserReviewGroup, 66
S
samples
graphical, 8
U
UpdateAutoUpdateInfo, 70 UpdateCustomSelectReferenceListsOptions, 72 UpdateIq8ServerSettings, 73 UpdateMatchConfidenceThresholdsOptionsInfo, 74 UpdateMatchHistoryAfterReview, 76 UpdateMatchOptionsInfo, 78 UpdateProcessingHistory, 80 UpdateRefDataVersion, 81 UpdateSelectReferenceListsOptionsInfo, 82 UpdateUser, 84 UpdateUserReviewGroup, 85
W
Watchlist Security
, 5
about
web sample
using
, 9
Index
87
Page 88
88
BusinessObjects Watchlist Security XI Release 2 Integrator’s Guide
Loading...