Search documentation:
	Help  Advanced
Published 08/06/2002

Appendix B

Hotlist File Format

This appendix describes the format of a Risk Manager hotlist file. Hotlist files are Extended Markup Language (XML) documents. You can export files from a Decision Server or import files into a Decision Server.

XML Conventions

This chapter uses the following conventions to describe the syntax of each XML element:

<Sample Attribute=CDATA> 
  (Element) 
  (ComplexElement) 
  (OptionalElement)? 
  (RequiredRecurringElement)+ 
</Sample> 

Table 12 Conventions for XML Syntax 

Convention	Description
<Sample>	Parent of the following elements.
Attribute=CDATA	Name of the attribute, followed by the XML data format for the attribute.
(Element)	Required element. Must appear only once.
(ComplexElement)	Element with one or more children.
(OptionalElement)?	Optional element. Can appear once or be omitted.
(RequiredRecurringElement)+	Required element. Can appear one or more times.

Data Types and Lengths

Each field in a hotlist file is an alphanumeric string containing letters, numbers, and special characters (for example, @, #, and %). Each field uses the same character set as your Decision Server database.

The data lengths indicate the maximum length of each field.

Hotlist Files

A hotlist file contains entries from a Decision Server's positive and negative hotlists. Each entry indicates which business it is associated with.

<hotlist>

The <hotlist> element is the root element of the hotlist file. It contains the hotlist entries.

Syntax

<hotlist> 
  (entry)+ 
</hotlist> 

Table 13 Child Elements of <hotlist> 

Element Name	Description
<entry>	Information about a hotlist entry. See <entry> for a list of child elements and attributes.

Example  <hotlist> Element

<hotlist>

  <entry business="MyBusiness" list_name="Address">

    ...

  </entry>

</hotlist>

<entry>

The <entry> element contains information about a hotlist entry. The list_name attribute indicates which hotlist the entry is associated with. The child element or elements of the <entry> element include the data that is on the hotlist.

Each business on the Decision Server uses its own hotlist. The business attribute indicates which business each hotlist entry is associated with.

Syntax

<entry business=CDATA list_name=CDATA> 
  (email)? 
  (phone_number)? 
  (account_number)? 
  (address1)? 
  (zip)? 
</entry> 

Table 14 Attributes of <entry> 

Attribute Name	Description	Data Type and Length
business	Name of the business with which this entry is associated.	Alphanumeric (25)
list_name	Name of the hotlist with which this entry is associated. This attribute can contain one of the following values: Address: Negative hotlist of street addresses CCList: Negative hotlist of credit card numbers Email: Negative hotlist of email addresses Phone: Negative hotlist of phone numbers pos_Address: Positive hotlist of street addresses pos_CCList: Positive hotlist of credit card numbers pos_Email: Positive hotlist of email addresses pos_Phone: Positive hotlist of phone numbers	Alphanumeric (25)

Table 15 Child Elements of <entry> 

Element Name	Description	Data Type and Length
<email>	Email address.	Alphanumeric (100)
<phone_number>	Phone number.	Alphanumeric (15)
<account_number>	Credit card number.	Alphanumeric (50)
<address1>	First line of the billing or shipping address. If the hotlist entry includes the <address1> element, it must also include the <zip> element.	Alphanumeric (60)
<zip>	Postal code of the billing or shipping address. If the hotlist entry includes the <zip> element, it must also include the <address1> element.	Alphanumeric (10)

Example  Email Address on the Negative Hotlist

The following example shows a hotlist entry for an email address on the negative hotlist. This entry is for the business MyBusiness.

<entry business="MyBusiness" list_name="Email"> 
  <email>jdoe@example.com</email> 
</entry> 

Example  Credit Card Number on the Positive Hotlist

The following example shows a hotlist entry for a credit card number on the positive hotlist. This entry is for the business TestStore.

<entry business="TestStore" list_name="pos_CCList"> 
  <account_number>4111111111111111</account_number> 
</entry> 

Example  Street Address on the Negative Hotlist

The following example shows a hotlist entry for a street address on the negative hotlist. This entry is for the business MyBusiness.

<entry business="MyBusiness" list_name="Address"> 
  <address1>123 Fake St.</address1> 
  <zip>00000</zip> 
</entry> 

Sample Hotlist File

The following example shows a Risk Manager hotlist file that includes one entry for each positive and negative hotlist. All of the entries in this hotlist file are for the business MyBusiness.

<?xml version="1.0" encoding="UTF-8" ?> 
<hotlist> 
  <entry business="MyBusiness" list_name="Address"> 
    <address1>123 Fake St.</address1> 
    <zip>00000</zip> 
  </entry> 
  <entry business="MyBusiness" list_name="CCList"> 
    <account_number>1234123412341234</account_number> 
  </entry> 
  <entry business="MyBusiness" list_name="Email"> 
    <email>jdoe@example.com</email> 
  </entry> 
  <entry business="MyBusiness" list_name="Phone"> 
    <phone_number>000-555-1212</phone_number> 
  </entry> 
  <entry business="MyBusiness" list_name="pos_Address"> 
    <address1>123 Real Ln.</address1> 
    <zip>00000</zip> 
  </entry> 
  <entry business="MyBusiness" list_name="pos_CCList"> 
    <account_number>4111111111111111</account_number> 
  </entry> 
  <entry business="MyBusiness" list_name="pos_Email"> 
    <email>jlincoln@example.com</email> 
  </entry> 
  <entry business="MyBusiness" list_name="pos_Phone"> 
    <phone_number>000-555-1234</phone_number> 
  </entry> 
</hotlist> 

Hotlist File DTD

The following document type definition (DTD) describes a Risk Manager hotlist file.

<!ELEMENT hotlist (entry+)> 
<!ELEMENT entry (email?, phone_number?, account_number?, address1?, 
                 zip?)> 
<!ATTLIST entry business CDATA #REQUIRED 
          list_name (Address | CCList | Email | Phone | pos_Address |  
                     pos_CCList | pos_Email | pos_Phone) #REQUIRED 
> 
<!ELEMENT account_number (#PCDATA)> 
<!ELEMENT address1 (#PCDATA)> 
<!ELEMENT email (#PCDATA)> 
<!ELEMENT phone_number (#PCDATA)> 
<!ELEMENT zip (#PCDATA)>