Table Of Contents
Introduction
Introduction
The Cisco BBSM 5.3 Web Page SDK Developer Guide describes how to create custom BBSM page sets by customizing the page set templates that ship with BBSM. Although the SDK software can be installed on any version of BBSM 5.3, the guide's content applies only to BBSM 5.3 SP1 and is written for web developers.
Although you may be able to create page sets yourself, we recommend that you hire web developers if you are making significant changes. The extent of the changes that you are making determines how much experience you need to have with ASP, JavaScript, Jscript, and HTML. If you are hiring a web developer to customize your page set, send him or her a copy of the page set templates that are located in c:\atcom\ekgnkm on the BBSM server.
BBSM uses page sets made up of active server page (ASP) files, commonly called pages. When the end user starts a session, the page set ASP files execute on the BBSM server and on the end user's browser.
Different page sets contain different types of ASP files. (See Table 1-1.) By choosing specific page sets, you are choosing ASP files that associate an access policy and, if applicable, an accounting policy:
•
Access policies—Define the end user's process when connecting to the Internet
•Accounting policies—Determine how end users are billed for BBSM Internet services
(In general, page sets are named by combining the access and accounting policy names, such as DailyHotel and BlockICS.)
If the end user will be entering sensitive information, such as credit card information, your page set should use the secure sockets layer (SSL) encryption protocol. The page sets whose names end in Clear do not use SSL security.) For SSL page sets, you must buy and install an SSL certificate. (For complete details on installing the certificate, refer to the Cisco BBSM 5.3 Configuration Guide.) The other default BBSM page sets transmit data in clear text. Table 1-1 lists the page sets that provide SSL protection.
Note If you need a test certificate for development only, refer to the Cisco BBSM 5.3 Interface SDK Guide for information on requesting and installing a test SSL certificate on a BBSM server.
The BBSM page set templates can be used in two different ways:
•They can be used without modification for demonstrations. They also enable you to configure a server and begin using it quickly for testing in the lab environment.
•They are used as templates from which you create custom page sets that are used in production.
Create your templates based on the kinds of changes that you need to make to the page set templates:
1. If you need to make minor modifications to the DailyHotel page set, such as adding a graphic and logo, you can probably use the Page Set Wizard. For instructions, refer to the section on using the wizard in the Cisco BBSM 5.3 SP1 Configuration Guide.
2. If you need to make additional minor modifications, you can probably make these changes by following the procedure in the section on creating custom page sets in the Cisco BBSM 5.3 SP1 Configuration Guide. This procedure gives basic instructions for modifying a page set. These instructions are also provided in this guide in "Creating Custom PDA Page Sets." This chapter also provides instructions for more complex changes.
3. If you need to make more extensive changes, you need to use the instructions provided in "Creating Custom PDA Page Sets."
If you do not want to give your web developer access to your BBSM server, send him or her a copy of the BBSM templates, which are located in the c:\atcom\ekgnkm directory on the BBSM server.
Note Although you can make these changes yourself, Cisco recommends that you hire a web developer.
The sections that follow mention several methods that are used to control the end user's experience. They are described in detail in "ActiveX Server Component API Reference."
Table 1-1 describes the default page sets that ship with BBSM. If you are using public-private IP addresses (multinets), note that the page set assigned to the end user's port determines whether an administrator or operator provisions the multinet or the end user provisions the multinet.
Refer to "Creating Custom Page Sets," for detailed information about each page set.
Table 1-1 BBSM Default Page Set Descriptions
Page Set
|
Uses SSL?
|
Who Selects
Public/Private
Multinet?
|
Description
|
AccessCode
|
No
|
Administrator
or operator
|
Prompts the end user to enter an access code to access the Internet for an authorized period that the BBSM operator configures. Use this page set if you want multiple users to be able to access the Internet at the same time with one access code. (Refer also to the MeetingRoom page set.)
By default, this page set uses the AccessCode access policy and no accounting policy.
|
BiDirectional_
DailyHotel
|
No
|
End user
|
Demonstrates how to use the guest data that BBSM pulls from the PMS. Meant to be an example of how to take advantage of the bidirectional PMS interface, the page set provides the default DailyHotel page set functionality, plus functionality such as viewing guest folio and guest checkout. You must customize the BiDirectional ASP files to achieve the appropriate functionality.
This page set uses the following default policies:
•Access policy—Daily
•Accounting policy—Hotel
|
BlockICS
|
Yes
|
End user
|
Prompts the end user to enter credit card information to access the Internet for a block of minutes.
This page set uses the following default policies:
•Access policy—Block
•Accounting policy—ICSCreditCard
|
DailyHotel
|
No
|
End user
|
Provides the end user access for a 24-hour period and sends charges to the hotel's PMS or local printer.
This page set uses the following default policies:
•Access policy—Daily
•Accounting policy—Hotel
|
DailyICS
DailyICSClear
|
Yes
No
|
End user
|
Prompts the end user to enter credit card information to access the Internet for a 24-hour period.
These page sets use the following default policies:
•Access policy—Daily
•Accounting policy—ICSCreditCard
|
MeetingRoom
|
No
|
Administrator or operator
|
Prompts the end user to enter an access code to access the Internet for an authorized period that the BBSM administrator or operator configures. Use this page if you want only one user to access the Internet at a time through the access code.
By default, this page set uses the AccessCode access policy and no accounting policy.
|
Mega
MegaClear
|
Yes
No
|
Administrator
or operator
|
Provides access flexibility to the end user and still controls access. Modify the page set to fit your needs.
These page sets use the following default policies:
•Access policy—AccessCode, Block, Daily, Minute, or RADIUS (as chosen by the end user)
•Accounting policy—
–The AccessCode access policy uses no accounting policy. The RADIUS access policy uses RADIUS accounting if a RADIUS accounting server is configured.
–For the Block, Daily, or Minute access policies, the end user chooses the ICSCreditCard or Hotel accounting policy.
|
MinuteICS
MinuteICSClear
|
Yes
No
|
End user
|
Prompts the end user to enter credit card information to access the Internet per minute.
These page sets use the following default policies:
•Access policy—Minute
•Accounting policy—ICSCreditCard
|
RADIUS
RADIUSClear
|
Yes
No
|
Administrator
or operator
|
Prompts the end user to enter a RADIUS username and password to access the Internet.
By default, these page sets use the RADIUS access policy and RADIUS accounting if a RADIUS accounting server is configured.
|
RADIUSUBand
RADIUSUBand
Clear
|
Yes
No
|
End user
|
Prompts the end user to enter a RADIUS username and password to access the Internet. It also permits the end user to choose a bandwidth at a specified price. For this page set, the disconnect web page presents the end user with an estimated summary for the time of the active session and the charges accrued at the chosen bandwidth.
By default, these page sets use the RADIUS access policy and RADIUS accounting if a RADIUS accounting server is configured.
|
RADIUSBlock
|
Yes
|
End user
|
Prompts the end user to enter a RADIUS username and password to access the Internet.
By default, these page sets use the RADIUS access policy and RADIUS accounting if a RADIUS accounting server is configured.
|
Subscription
|
No
|
End user
|
Enables the end user to access the Internet for a specified date range. Use this page set to offer free Internet access on a port by specifying the date range in Port Control.
By default, the page set uses the Subscription access policy and does not do billing (no accounting policy).
|
SubscriptionHome
|
No
|
Administrator
or operator
|
Enables the end user to access the Internet for a per-port specified date range. When the user activates a session, BBSM redirects the user to the originally requested URL, which is usually the home page set in the browser.
By default, the page set uses the Subscription access policy and does not do billing (no accounting policy).
|
SubscriptionHotel
SubscriptionHotel
MultipleDay
|
No
No
|
End user
|
Enables the end user to access the Internet for a specified (SubscriptionHotel) or varied (SubscriptionHotelMultipleDay) date range. If the user attempts Internet access outside the date range, these page sets enable the user to self-provision the subscription by billing it to the hotel's PMS.
These page sets use the following default policies:
•Access policy—Subscription
•Accounting policy—Hotel
|
SubscriptionICS
|
No
|
End user
|
Enables the end user to access the Internet for a per-port specified date range. If the end user attempts to access the Internet outside the date range, the page set enables the user to bill the subscription to a credit card.
These page sets use the following default policies:
•Access policy—Subscription
•Accounting policy—ICSCreditCard
|
Feedback
