Cisco BBSM 5.1 SDK Developer Guide.
9 - AtDial Database Schema Reference

Table Of Contents

AtDial Database Schema Reference


AtDial Database Schema Reference


BBSM uses a database to store information such as user sessions and transaction information. Tables 9-1 through 9-29 show the database schemas for each table in the AtDial database.

Table 9-1 Access_Codes Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

AccessCode

varchar (50)

Access code used by end-user

No

BandwidthKbps

int

Bandwidth available to access code

Yes

Customer

varchar (50)

Customer name (end user)

Yes

Description

varchar (100)

Description of code usage

Yes

EndValid

datetime

Ending date/time code is valid

Yes

InstID

int

Unique identifier for a set of access codes created in a single instance

Yes

Price

money

Payment amount for access code

Yes

SiteNumber

int

Site number code is valid for

No

StartValid

datetime

Starting date/time code is valid

Yes


Table 9-2 AccessCodesHistory Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

AccessCode

varchar (50)

Actual access code used

Yes

ActiveSeconds

int

Active seconds for access code

Yes

DateTime

datetime

Access code date/time

Yes

IPAddress

varchar (25)

IP address of client system

Yes

MACAddress

varchar (50)

MAC address of client system

Yes

Room

varchar (20)

Room number of client system

Yes

Username

char (25)

User name for access code

Yes


Table 9-3 CallTypeLookup Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

CallType

char (1)

Call type

No

Description

varchar (255)

Description of call type lookup

No

SiteNumber

int

Site number

No


Table 9-4 CruiseLineTransactionHistory Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

CardType

varchar (25)

Card type used by user

Yes

ClientIPAddress

varchar (25)

Client IP address

Yes

ClientMACAddress

varchar (50)

Client MAC address

Yes

ClientPortID

varchar (50)

Client Port ID number

Yes

CreditCardNumber

varchar (20)

Users credit card number

Yes

FolioNumber

varchar (10)

Users folio number

Yes

RequestDateTime

datetime

Request date/time

No

Response

varchar (25)

Actual response

Yes

ResponseDateTime

datetime

Response date/time

Yes

TransactionAmount

money

Actual transaction amount

Yes

TransactionType

varchar (25)

Transaction type

No


Table 9-5 DailyWelcomeBackMAC Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

EndWelcomeBack

datetime

Expiration date and time

No

MACAddress

varchar (50)

MAC address

No

Site

int

Site number

No

TotalSpent

float

Total amount spent by user

No


Table 9-6 DailyWelcomeBackPort Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

EndWelcomeBack

datetime

Expiration date/time

No

PortID

varchar (50)

Port ID number

No

Site

int

Site number

No

TotalSpent

float

Total amount spent by user

No


Table 9-7 Debugging Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

Data

varchar (255)

Data represented

Yes

DateTime

datetime

Date/time of action

Yes

File

varchar (50)

File that debugging trace refers to

Yes

Line

int

Line of debugging code

Yes


Table 9-8 PatchDependency Table

Attribute
DataType
(size)
Description
Allow Nulls?

DependsOn

int

Depends on the patch required to be installed before installing "Patch Number"

No

PatchNumber

int

Patch number

No


Table 9-9 PatchDescription Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

AtupgradeArgs

varchar (250)

Arguments for upgrade patch

Yes

Build

real

Product build installed by the patch

Yes

Description

varchar (150)

Description of patch applied

Yes

Hotfixes

varchar (250)

Hot fixes executed by the patch

Yes

InstallDate

datetime

Patch install date/time

No

IsPatch

bit

Patch or not patch

No

PatchNumber

int

Actual patch number

No

ProductName

varchar (50)

Product name patch applies to

Yes

Version

real

Product version installed by the patch

Yes


Table 9-10 PatchLog Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

Data

varchar (512)

Data for patch

Yes

DateTime

datetime

Patch date/time

No

LogType

int

Log type for patch

No

PatchNumber

int

Patch number

Yes

TraceLevel

int

Trace level of patch

No


Table 9-11 PendingHotelSale Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

Action

varchar (15)

Action of hotel sale

Yes

Amount

money

Total amount of sale

Yes

Description

varchar (255)

Description of sale

Yes

EndDateTime

datetime

End date/time

Yes

PortID

varchar (50)

Port ID of hotel sale

Yes

Room

varchar (50)

Room number

Yes

SiteNumber

int

Site number

Yes

StartDateTime

datetime

Start date/time

Yes


Table 9-12 Port_Map Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

BandwidthKbps

int

Applied bandwidth for port

Yes

Comment

varchar (100)

Comment

Yes

EchoDataSize

int

Echo data size

Yes

EnablePortHop

bit

Enable/disable port hop

Yes

End_authorized_period

datetime

End of authorized period

Yes

InterPacketDelay

int

Interpacket delay

Yes

Modem_MAC_addr

varchar (20)

MAC address on port

Yes

PageSet

varchar (50)

PageSet used on port

Yes

PingsToSend

int

Number of pings to send

Yes

Port_ID

varchar (50)

Port ID number

No

PortTestPacketsReceived

int

Port received packets

Yes

PortTestPacketsTransmitted

int

Port transmitted packets

Yes

PortTestTime

datetime

Port test time

Yes

Site_number

int

Site ID number

No

Room_number

varchar (50)

Room number of port

Yes

Start_authorized_period

datetime

Start of authorized period

Yes

StartPage

varchar (100)

Start page to direct user to

Yes

SwitchMode

varchar (10)

Switch mode

Yes

Time_of_last_configure

datetime

Time of last port configuration

Yes

Time_of_last_sale

datetime

Time of last sale to port

Yes

ToolbarFrequency

int

Toolbar frequency

Yes

ToolbarMode

int

Toolbar mode

Yes

ToolbarNumber

int

Toolbar number

Yes

ToolbarTime

int

Toolbar time

Yes

UplinkPort

bit

Uplink port (Yes/No)

Yes


Table 9-13 Port_State Table

Attribute
Data Type
(size)
Description
Allow Nulls?

AccessPolicy

varchar (50)

Access policy for port

Yes

AccountingInfo

varchar (255)

Accounting information

Yes

AccountingPolicy

varchar (50)

Accounting policy for port

Yes

BandwidthKbps

int

Applied bandwidth to port

Yes

Client_IP_Address

varchar (25)

Client IP Address

No

Client_MAC_address

varchar (50)

Client MAC address

Yes

Client_port_ID

varchar (50)

Client port ID number

Yes

Client_room_number

varchar (50)

Client room number

Yes

Client_site_number

int

Client site number

Yes

DeniedURL

varchar (100)

Denied URL to direct user to

Yes

FreeBrowse_Subnet

varchar (25)

Free browse subnet IP

Yes

FreeBrowse_Subnet_Mask

varchar (25)

Free browse subnet mask IP

Yes

OriginalPortID

varchar (50)

Original port ID

Yes

OriginalRoom

varchar (50)

Original room

Yes

PortHopInProgress

datetime

Time port hop in progress

Yes

Port_state

varchar (20)

Port state

Yes

Port_type

int

Port type

Yes

Rate

money

Rate/transaction amount

Yes

Router_number

int

Router number

Yes

SearchInProgress

bit

When using the port hopping feature, search in progress for the client

Yes

SessionID

int

Session ID

Yes

Time_of_last_state_change

datetime

Time of last state change

Yes


Table 9-14 Port_State_Access_Code Table

Attribute
DataType
(size)
Description
Allow Nulls?

AccessCode

varchar (50)

Actual access code

Yes

ClientIP

varchar (16)

Client IP address

No

Exclusive

bit

Exclusive (Yes/No)

Yes

Name

varchar (50)

Access code name

Yes

Site

int

Site number

No


Table 9-15 Port_State_Block Table

Attribute
DataType
(size)
Description
Allow Nulls?

BlockDurationMinutes

int

Duration of blocked minutes

No

ClientIP

varchar (16)

Client IP address

No


Table 9-16 Port_State_Daily Table

Attribute
DataType
(size)
Description
Allow Nulls?

ClientIP

varchar (16)

Client IP address

No

PostAtStart

bit

Post at start

No

RenewSession

bit

Renew session

No

SessionBoundary

datetime

Session boundary

No

WelcomeBack MAC

bit

Welcome back MAC address

No


Table 9-17 Port_State_Minute Table

Attribute
DataType
(size)
Description
Allow Nulls?

ApprovalAmount

float

Approval amount

No

ClientIP

varchar (16)

Client IP address

No


Table 9-18 Port_State_RADIUS Table

Attribute
DataType
(size)
Description
Allow Nulls?

BandwidthKbps

int

Bandwidth in Kbps

Yes

ClientIP

varchar (16)

Client IP address

No

ClientMACAddress

varchar (50)

Client MAC address

Yes

ClientRoomNumber

varchar (50)

Client room number

Yes

LastInterimSuccessful

bit

Last interim successful (Yes/No)

Yes

LastInterimTime

datetime

Last interim time

Yes

NASIdentifier

varchar (50)

NAS identifier

Yes

NASIPAddress

varchar (16)

NAS IP address

Yes

NASPort

varchar (50)

NAS port

Yes

SessionID

int

Session ID

Yes

Site

int

Site number

No

Username

varchar (128)

RADIUS user name

No

UserSelectBandwidth

bit

User select bandwidth (Yes/No)

Yes


Table 9-19 RADIUS_SessionHistory Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID

int

Identify

No

BandwidthKbps

int

Bandwidth in Kbps

Yes

ClientMACAddress

varchar (50)

MAC address of client

Yes

ClientRoomNumber

varchar (50)

Room number of client

Yes

EffectiveTime

datetime

Effective time

Yes

FramedIPAddress

varchar (16)

Framed IP address

Yes

InputPackets

int

Number of packets received (future use)

Yes

LogStatus

smallint

Log status

No

LogTime

datetime

Log time

No

LogType

smallint

Log type

No

NASIdentifier

varchar (50)

NAS identifier

Yes

NASIPAddress

varchar (16)

NAS IP address

Yes

NASPort

varchar (50)

NAS port

Yes

OutputPackets

int

Number of packets transmitted (future use)

Yes

RADIUSServer

varchar (50)

RADIUS server

Yes

Rate

money

Rate

Yes

SessionID

int

Session ID

No

SessionTime

int

Duration of session in seconds

Yes

TerminateCause

int

Terminate cause

Yes

Username

varchar (128)

User name

No


Table 9-20 RADIUSServers Table

Attribute
DataType
(size)
Description
Allow Nulls?

AccountingPort

int

Accounting port

Yes

EnableAccounting

bit

Enable accounting (Yes/No)

Yes

EnableAuthentication

bit

Enable authentication (Yes/No)

Yes

Port

int

Authentication port

Yes

Rank

int

Rank

Yes

Server

varchar (50)

RADIUS server name

No

TimeoutSeconds

int

Timeout seconds

Yes


Table 9-21 ReleaseDependency Table

Attribute
DataType
(size)
Description
Allow Nulls?

Build

real

Build of patch

No

EndBuild

real

End Build of patch

Yes

EndVersion

real

End Version of patch

Yes

PatchNumber

int

Patch number

No

ProductName

varchar (50)

Product patch Applies To

No

Version

real

Version of patch

No


Table 9-22 Router Table

Attribute
DataType
(size)
Description
Allow Nulls?

Bandwidth ManagerClass

int

Bandwidth manager Class

Yes

Bandwidth ManagerCommunity

varchar (20)

Bandwidth manager community

Yes

Bandwidth ManagerIPAddress

varchar (15)

Bandwidth manager IP address

Yes

ClientIPEnd

varchar (15)

Client IP address End

Yes

ClientIPStart

varchar (15)

Client IP address start

Yes

ClientSubnetMask

varchar (15)

Client IP subnet mask

Yes

Community

varchar (20)

Router community

No

DHCPScope

int

DHCP scope

Yes

GatewayIP

varchar (15)

Gateway IP address

Yes

IP

varchar (15)

Router IP address

No

Number

int

Router number

No

RouterSupportsSNMP

bit

Router supports SNMP

Yes

Type

int

Router type

No


Table 9-23 Server_Configuration Table

Attribute
DataType
(size)
Description
Allow Nulls?

AccountingInterimInterval

int

Accounting interim interval

Yes

ActiveSessionCount

int

Current active session count

Yes

BackupBillingIPaddress

varchar (50)

Backup billing IP address

Yes

BillingConnectTimeout

datetime

Connect timeout date/time

Yes

BillingIPaddress

varchar (50)

Billing IP address

Yes

CMICName

varchar (32)

CMIC name

Yes

CurrencyType

charchar (50)

Currency type

Yes

DNSName

varchar (100)

DNS name

Yes

EnableAdaptiveNAT

bit

Enable static client connections (Yes/No)

Yes

EnableDNSPageSetURLs

bit

Enable DNS page set URLs

Yes

EnableMaxSession

bit

Enable maximum session limit (Yes/No)

Yes

MaxActiveSession

int

Maximum active sessions allowed

Yes

NASIdentifier

varchar (50)

NAT identifier

Yes

NATIPAddress

varchar (16)

NAT IP address

Yes

NetworkCardID

varchar (50)

Network card ID number

No

ServerState

varchar (20)

Server state

Yes

SessionID

int

Session ID

Yes

SMTPServer

varchar (100)

SMTP server

Yes

StationID

varchar (50)

Station ID number

Yes


Table 9-24 Sites Table

Attribute
DataType
(size)
Description
Allow Nulls?

AllowMultipleSessions

int

Allow multiple sessions?

Yes

AthdmnIPAddress

varchar (50)

AtDemon IP address

Yes

BillingMerchantID

varchar (50)

Merchant billing ID

Yes

DoHotelPMSBilling

int

Do hotel billing?

Yes

DoHotelPrintBills

int

Print hotel bills?

Yes

HotelBillingPrinterNetworkAddr

varchar (100)

Hotel billing printer IP

Yes

IsNetworkPrinter

bit

Network printer (Yes/No)

Yes

PMSBillingUp

bit

Is PMS billing up?

No

PMSProtocol

varchar (32)

PMS protocol

Yes

PortHopDelay

int

Port hop delay

No

PrinterAcctPasswd

varchar (50)

Printer account password

Yes

PrinterAcctUserID

varchar (50)

Printer account user ID

Yes

PrintBillingUp

bit

Is print billing up?

No

PrinterMaxPricePerJob

varchar (50)

Max price per printing job

Yes

PrinterNetworkAddress

varchar (100)

Printer network address

Yes

PrinterPricePerPage

varchar (50)

Printing price per Page

Yes

SiteNumber

int

Site number

No

SiteDescription

varchar (100)

Site description

Yes

SiteLocation

varchar (50)

Site location

Yes


Table 9-25 Switches Table

Attribute
DataType
(size)
Description
Allow Nulls?

SiteNumber

int

Site number

No

StackIPaddress

varchar (50)

Stack IP address

No

StackNumber

int

Stack number

No

SwitchPassword

varchar (50)

Switch password

Yes

SwitchType

int

Switch type

Yes

SwitchDisabled

int

Is switch disabled?

Yes

AgingPeriod

int

Switch aging period

Yes

PacketInactivityPeriod

int

Packet inactivity period

Null

PortsPerSwitch1

int

Ports per switch

Yes

PortsPerSwitch2n

int

Ports per switch

Yes

RouterNumber

int

Router number

Yes

ModemMAC Address

varchar (20)

Modem MAC address

Yes

ConnectedToPort ID

varchar (20)

Connect to port ID

Yes


Table 9-26 Toolbar Table

Attribute
DataType
(size)
Description
Allow Nulls?

Height

varchar (20)

Toolbar height

No

Name

varchar (50)

Toolbar name

No

Number

int

Toolbar number

No

Title

varchar (80)

Toolbar title

No

URL

varchar (255)

Toolbar URL

No


Table 9-27 Transaction_History Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

AccessPolicy

varchar (50)

Access policy used

Yes

AccountingPolicy

varchar (50)

Accounting policy used

Yes

BandwidthKbps

int

Bandwidth used on port

Yes

Client_IP_address

varchar (25)

Client IP address of transaction

Yes

Client_MAC_address

varchar (50)

Client MAC address

Yes

Client_port_ID

varchar (50)

Client port ID number

Yes

Client_room_number

varchar (20)

Client room number

Yes

Client_site_number

int

Client site number

Yes

Date_Time

datetime

Transaction date/time

Yes

Error_flag

bit

Error flag

No

New_state

varchar (50)

New state

Yes

Previous_state

varchar (50)

Previous state

Yes

Prev_state_duration

int

Previous state duration

Yes

Transaction_amount

money

Amount of transaction

Yes

Transaction_type

varchar (100)

Type of transaction (sale, etc.)

Yes


Table 9-28 WalledGarden Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

Hostname

varchar (255)

Hostname or URL

No

Subnet

varchar (15)

Subnet IP address

No

SubnetMask

varchar (15)

Subnet mask IP address

No


Table 9-29 WebPrintingLog Table

Attribute
DataType
(size)
Description
Allow Nulls?

ID (key)

int

Unique identifier

No

ClientFilePath

varchar (255)

File path on client computer

Yes

DateTime

datetime

Date/time the entry is logged

Yes

Description

varchar (255)

Description of the log

Yes

ErrorFlag

bit

Error or non-error flag

Yes

IPAddress

varchar (50)

Client IP address

Yes

PrinterAcctPasswd

varchar (50)

Printer account password

Yes

PrinterAcctUserID

varchar (50)

Printer account user ID

Yes

PrinterName

varchar (50)

Printer name

Yes

RoomNumber

varchar (50)

Client room number

Yes

SiteNumber

numeric

Client site number

Yes

TempFilePath

varchar (50)

Temp file path on the server

Yes