Table Of Contents
Creating Custom Page Sets
Page Set Overview
Using the Page Set Wizard
Creating Custom Page Sets Manually
Before You Start
Page Set Creation Procedure
Adding Custom Page Sets to BBSM
Creating Custom Page Sets
This chapter provides an overview of BBSM page sets and the procedures to create custom page sets using either the Page Set Wizard to create a custom DailyHotel page set or the page set files to create a page set manually. The chapter also describes how to add these page sets to the list of available page sets in WEBconfig:
•
Page Set Overview
•Using the Page Set Wizard—Use the wizard to create and name a custom page set based on the DailyHotel page set template. Refer to the section for the features that can be changed with the wizard.
•Creating Custom Page Sets Manually—If you are making more extensive changes to the GUI, are using a page set other than DailyHotel, or are changing the way your page set interacts with BBSM, use the procedure in this section to change the code. You do not need to install the SDK to make these changes. In addition to the changes you can make using the Page Set Wizard, you can make these changes by manually changing the code:
–Use page set templates other than DailyHotel to create your custom page set
–Replace the graphical presentation of the page set with more flexibility than with the wizard
–Remove extraneous bandwidth options
•Adding Custom Page Sets to BBSM
Refer to this documentation for additional information about page sets:
•For an introduction to page sets and a description of the default BBSM page sets, refer to the "Page Set Overview" section. Cisco recommends that you read this section before creating your page set.
•If you are creating custom access, accounting, or PMS policy methods, you must install and use the SDK. Refer to the Cisco BBSM 5.3 SDK Developer Guide.
Page Set Overview
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. By choosing specific page sets, you are choosing ASP files that associate an access policy and, if applicable, an accounting policy with a specific port. (In general, page sets are named by combining the access and accounting policy names, such as DailyHotel and BlockICS.) These policies define the access and accounting methods for the end user's session. They are described briefly below:
•Access policies—The access policy defines the end user's process when connecting to the Internet. The default page sets enable you to choose these access policies: Access Code, Block, Daily, Minute, RADIUS, or Subscription.
•Accounting policies—The accounting policy determines how end users are billed for BBSM Internet services. BBSM provides these default accounting policies: ICS Credit Card, Cruise Line, Hotel, and RADIUS. If you do not want to bill the end user, you can use the Null accounting policy.
If the end user will be entering sensitive information, such as credit card information, then you should use page sets that provide the SSL encryption protocol. For these SSL page sets, you must buy and install an SSL certificate. For complete details on installing the certificate, refer to the "Installing an SSL Certificate" section. The other default BBSM page sets transmit data in clear text.
BBSM ships with default page sets. They are used in the following ways:
•The default page sets 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:
–You can use the page set template to create custom DailyHotel page sets using the Page Set Wizard if you are making simple changes such as adding a graphic and logo. For a description of the wizard and the step-by-step procedure for using it, refer to the "Using the Page Set Wizard" section.
–You can create custom page sets manually by modifying the ASP files without using the SDK. Refer to the "Creating Custom Page Sets Manually" section.
–Your developer can use the BBSM SDK to create new page sets if you are creating custom access, accounting, or PMS policies. Refer to the Cisco BBSM 5.3 SDK Developer Guide and the following software download URL:
http://www.cisco.com/pcgi-bin/tablebuild.pl/bbsm52
Table 18-1 describes these page sets and the access policy and accounting policy that page sets may use.
Caution Because page sets whose names end in
Clear do not use SSL security, Cisco does not recommend using them in production to transmit data to the BBSM server. (See
Table 18-1.) The end user's browser transmits RADIUS and credit card information to BBSM in clear text. BBSM provides them for demonstration and testing situations in which installing a server certificate is not feasible.
If you are using 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. Table 18-1 shows which page sets the end user can provision.
Table 18-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
|
No
|
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
|
CruiseLine
|
No
|
End user
|
Prompts the end user to enter credit card information or access card information (access card information is not the same as an access code) to access the Internet per minute or for a block of minutes.
This page set uses the following default policies:
•Access policy—Block or Minute (as chosen by the end user)
•Accounting policy—CruiseLine
|
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 no accounting policy.
|
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.
|
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
|
Using the Page Set Wizard
The Page Set Wizard option, located under Administration on the Dashboard, enables you to create a basic DailyHotel page set with a property photo and hotel logo. You can also modify or delete an existing DailyHotel page set that was created with the wizard.
These are the features that can be changed with the wizard:
•The template graphic and logo, which you can replace with a graphic that represents your organization. The image area for the graphic and the logo cannot be changed.
•The bandwidth options and prices.
•These defaults:
–To post charges at the beginning of the session.
–To deactivate the end user at the end of the session boundary, which means that the user would have to reauthenticate at the beginning of the next session.
–To charge the end user by MAC address rather than by port. The feature enables the end user to reconnect anywhere on the property rather than being restricted to reconnecting in the room.
•The end time for the billing cycle.
•The portal URL.
Descriptive text can also be added to the Connect page.
The wizard automatically adds the new page set to the drop-down list of page sets in the WEBconfig Network Element Port Settings window.
For additional information about page sets, refer to the "Page Set Overview" section.
Follow this procedure to create a new DailyHotel page set using the wizard.
Step 1 From the Dashboard, click Page Set Wizard. The Step 1 - Page Set Name web page appears. (See Figure 18-1.)
Figure 18-1 Step 1 - Page Set Name
Step 2 Choose a name for your new page set, and enter it in the Enter Name for New Page Set field.
Note To modify an existing page set that was created earlier, click the drop-down arrow in the Select Existing Page Set field and choose the page set that you want to edit.
Step 3 Click Next. The Step 2 - Select a Layout web page appears. (See Figure 18-2.)
Figure 18-2 Step 2 - Select a Layout
Step 4 Click the page set layout and then Next. The Step 3 - Import a Picture web page appears. (See Figure 18-3.)
Figure 18-3 Step 3 - Import a Picture
Step 5 Click Browse to navigate to the file of the graphic that you want to appear on the Start page and click Next. (The graphic must be 175 by 225 pixels or smaller.) The Step 4 - Import a Logo web page appears. (See Figure 18-4.)
Note To view the graphic that you chose to appear on the Start page, click Back.
Figure 18-4 Step 4 - Import a Logo
Step 6 Click Browse to navigate to the file of the logo that you want to appear on the Start page and click Next. (The logo must be 175 by 70 pixels or smaller.) The Step 5 - Page Set Options web page appears. (See Figure 18-5.)
Note To view the logo that you chose to display on the Start page, click Back.
Figure 18-5 Step 5 - Page Set Options
Step 7 Check the Bandwidth Option check boxes for the rates you want to offer end users and enter a price for that rate. For example, if you want to offer a 512-kbps speed for $5.00 per day and a 256-kbps speed for $3.00 per day, just check the boxes next to 512 kbps and 256 kbps and enter the price for each.
Note If you checked the Bandwidth Throttle check box on the BBSM Server Settings web page, all bandwidth options are available. Otherwise, only the Full-Speed bandwidth option is available.
Step 8 Choose the other page set options. (If you choose Specific Time, you can choose a specific time for the user session to end from the User Session Ends drop-down menu. (See Figure 18-6.) Remember that page sets created with the Page Set Wizard assume that Internet users are charged by the day (24-hour period) and that billing will be posted to a PMS or printer.
Figure 18-6 Step 5 - Page Set Options with "Specific Time" Selected
Step 9 Click Next. The Step 6 - Preview web page appears with the name of your new page set. In this example, the page set is named Delta. (See Figure 18-7.)
Figure 18-7 Step 6 - Preview
Step 10 To view your new page set, click Preview Page Set. (See Figure 18-8.), and then close the page set preview.
Figure 18-8 Preview of Custom Page Set
Step 11 To save your new page set, click Finish. The Step 7 - Finish web page appears. (See Figure 18-9.)
Note If you want to edit your page set, click the appropriate link in the NavBar on the left, make your changes, and click Finish.
Figure 18-9 Step 7 - Finish
After you create the new page set, you must use the Port Control feature to designate that the new page set will be used for the port. For these procedures, refer to the section on using port control in the Cisco BBSM 5.3 Operations Guide.
Creating Custom Page Sets Manually
This section describes how to create custom page sets manually without using the Page Set Wizard. To make the basic changes in this section, you do not need to use the SDK. However, if you decide to change the access, accounting, or PMS policies that BBSM uses, you must use the SDK.
If you create your page set manually, you must also add it to the list of available BBSM page sets. For this procedure, refer to the "Adding Custom Page Sets to BBSM" section. If the page set is created using the Page Set Wizard, you do not need to add the page set to the list because the wizard automatically adds the new page set to the drop-down list of page sets in the WEBconfig Network Element Port Settings window.
(You must have administrator privileges to use WEBconfig to add your page set to the registry.)
Before You Start
Please read the following information before beginning to create your page set:
•You must have a BBSM server to perform this procedure.
•Use Windows Notepad or another text editor to edit the ASP files that control the page set parameters.
•Give your customized page set a new name. The BBSM default page sets are provided only as templates. If you do not rename your customized page sets, they can be removed or replaced when a BBSM patch or service pack is installed.
•Page sets include the following ASP files (pages):
–Start pages—Defines the first page that the end user sees
–Post pages—Displays the Connecting... message. It calls the functions needed to connect the end user.
–Package pages—Stores the settings for the page set.
–GIF files—Define the graphical representation of the page set.
•If you want to debug ActiveX server components in page sets, you can develop your page set on a server that has the development environment installed and use Microsoft Visual Studio as an editor.
Page Set Creation Procedure
Follow this procedure to create your custom page set. In the procedure, we create a custom page set using the DailyHotel page set template for an example. You can create custom page sets from other page set templates similarly, although page set parameters differ with each page set.
In the example, we are changing the following DailyHotel page set parameters:
•The page set name so end user can view only the pages he or she is supposed to view.
•The end time for the billing cycle from 12:00 to 4:30 p.m.
•The default to begin posting charges at the beginning of the session.
•The default to deactivate the end user at the end of the session boundary.
•The default to not charge a MAC address for re-use within the 24-hour period, regardless of which port is used.
•The pricing for package 1 from 9.95 to 10.95.
We are also removing several bandwidth options.
Step 1 Determine the page set that meets your needs by reviewing the "Page Set Overview" section.
Step 2 Within the c:\atcom\ekgnkm folder (where the BBSM page set files are located), create a subdirectory, such as c:\atcom\ekgnkm\YourNewDirectory, for your new page set files. (Although new files can be created in c:\atcom\ekgnkm, Cisco recommends saving them in a separate folder.)
Note If you have installed a BBSM service pack and inadvertently overwritten a custom page set, the previous page set can be retrieved. A backup of all previous page sets is located in the c:\atcom\patch directory. Look for the folder named Backup####, where #### is the patch number that corresponds to your patch or service pack (found on WEBpatch).
When you find your original page set, do not copy it directly back to the ekgnkm directory. Instead, you must integrate your custom page set with the new page set that was installed with the service pack. Cisco recommends that you cut and paste changes that you made to the custom page set into the new page set so you are using the most up-to-date page set with your new service pack.
Step 3 Change the write permissions of the ASP files that can be edited, the NewNamePackage.asp and NewNamePost.asp files, as shown below:
Step 4 Copy all of the page set template's ASP and GIF files into the new subdirectory. Rename the ASP files with the name of your new page set, such as NewNameStart.asp.
a. Right-click the NewNamePackage.asp file and select Properties.
b. Uncheck the Read-only check box and click OK.
Step 5 If you want to change the default portal (the end user is directed to this home page when he or she gains Internet access) in the NewNamePost ASP file, follow these steps:
a. Using Microsoft Notepad, open the NewNamePost.asp file.
b. Change the default home page, www.cisco.com, to a new default URL.
c. Save the file and close Notepad.
Step 6 If you want to change the page set parameters in the NewNamePackage ASP file, follow these steps:
a. Using Microsoft Notepad, open the NewNamePackage.asp file.
b. Note the following default code that will be changed in this example:
<%
var strPageToCheck = "DailyHotel";
(
strSessionBoundary = "12:00";
bPostAtStart = false;
bRenewSession = true;
bWelcomeBackMAC = false;
var PackagePriceArray = new Array
(
9.95, //package 1, $9.95
7.95, //package 2, $7.95
5.95, //package 3, $5.95
3.95, //package 4, $3.95
1.95 //package 5, $1.95
);
var PackageKbpsArray = new Array
(
0, //package 1, full speed
512, //package 2, 512 Kbits/sec
256, //package 3, 256 Kbits/sec
128, //package 4, 128 Kbits/sec
64 //package 5, 64 Kbits/sec
var PackagePublicPrivateIPArray = new Array
(
1, //package 1, multinet 1
1, //package 2, multinet 1
1, //package 3, multinet 1
2, //package 4, multinet 2
2, //package 5, multinet 2
2, //package 6, multinet 2
);
%>
|
c. Use the following guidelines to change the code:
To change the strPageToCheck parameter to ensure that the end user can view only the pages he or she is supposed to view, replace the default page set name of DailyHotel with the name of your new page set.
Note Later in the procedure you will also change the name of the page set in the Windows registry. The strPageToCheck name in the package file and the name in the registry must be the same. The name is not case sensitive, so DailyHotel is the same as dailyhotel.
To change strSesssionBoundary parameter so that the end time for your billing cycle changes from 12:00 to 4:30 p.m., enter 16:30 between the quotes. Cisco recommends that you read the following specifications for this parameter:
–Use a string of the form HH:MM, where HH = the hours in the range 0 through 23 (0 means midnight, 12 means noon, and 23 means 11 p.m.) and MM = the minute in the range 00 through 59.
–The following example shows the system default session boundary of noon. As shown, placing a space between the quotation marks also sets the system default to noon:
var strSessionBoundary = "12:00"
var strSessionBoundary = " "
|
–This example shows an example session boundary of 2:30 p.m.:
var strSesssionBoundary = "14:30"
|
Note If a customer activates shortly before the time set for the session boundary, the session could end very soon after it starts. For example, if the session boundary is set for 12 a.m. (midnight) and a customer activates a session at 11:30 p.m., the session terminates at 12 a.m. (1/2 hour later). However, if another customer activates a session at 12:30 a.m., the session terminates at 12 a.m. the next day.
To set the time so that the session ends 24 hours after activation, modify the line to specify an empty string for the session boundary (with no space between the quotation marks); for example, as follows:
var strSessionBoundary = ""
|
To change the bPostAtStart parameter to begin posting charges at the beginning of the session, change it to true.
To change the bRenewSession parameter to deactivate an end user at the end of a session so that he or she must reauthenticate at the beginning of the next session, change it to false.
To change the bWelcomeBackMAC parameter, refer to the following information about how the parameter works:
–Setting the parameter to true—After the end user authenticates, he or she can reconnect until the session boundary without being charged. The user can log in from anywhere on the property (any port).
–Setting the parameter to false—After the end user authenticates, that room (port) will now allow anyone to reconnect until the session boundary. This includes the original user that authenticated as well as anyone else that enters the room. No other ports on the property will allow the original user to reconnect, only that one port.
To change the PackagePriceArray pricing of package 1 from 9.95 to 10.95, change 9.95 to 10.95 at the beginning of the line. Cisco recommends that you change the corresponding dollar amount following the // comment mark to the same figure. You can add or remove pricing packages as you want. You must also remove the corresponding PackageKbpsArray lines.
To remove 64 kbps and 128 kbps PackageKbpsArray pricing packages, remove the appropriate lines in the code. Then you need to remove the corresponding PackagePriceArray lines. Be sure to remove the trailing comma from the last entry in each array.
Note If items are removed from the price and kbps arrays, you also need to change the PackagePublicPrivateIPArray (multinet) array. All arrays should have the same number of elements.
Step 7 Note that your parameters have changed to the following:
<%
var strPageToCheck = "NewName";
(
strSessionBoundary = "16:30";
bPostAtStart = true;
bRenewSession = false;
bWelcomeBackMAC = true;
var PackagePriceArray = new Array
(
10.95, //package 1, $10.95
7.95, //package 2, $7.95
5.95 //package 3, $5.95
);
var PackageKbpsArray = new Array
(
0, //package 1, full speed
512, //package 2, 512 Kbits/sec
256 //package 3, 256 Kbits/sec
);
var PackagePublicPrivateIPArray = new Array
(
1, //package 1, multinet 1
1, //package 2, multinet 1
2, //package 3, multinet 2
);
%>
|
Step 8 Save your changes and exit Notepad.
Step 9 Change all references to the name of your new page set in all ASP files, such as NewNamePost.asp.
Step 10 In your new subdirectory, replace the default GIF files with any new graphics:
a. Replace background colors with your customized colors.
b. Replace the text and font displayed to the end user with your customized text.
a. Replace graphical references in the ASP files to the names of you new GIF files.
Step 11 Register your page set and add it to the list of BBSM available page sets. For instructions, refer to the "Adding Custom Page Sets to BBSM" section for instructions.
Step 12 Test your new page set:
a. Physically connect a client to a port.
b. From the BBSM Dashboard, click Port Control. The Port List web page appears.
c. In the left-hand column, check the port that the client is connected to and then click Port Settings. The Port Settings window pops up.
d. From the Page Set drop-down menu, choose your page set. The Start Page text box automatically populates with the URL of your Start page. Click Save.
e. Open the browser on the client. Your Start page should be displayed.
Note If your page set uses SSL, you must have a valid certificate installed on your server to test your pages. If you do not have a certificate installed, you will be unable to view the secure pages when you connect a client. For testing purposes, you can make your BBSM a certificate authority and then sign your own certificate. This procedure should only be used on a development server and never on a release server. This method is only used for testing secure page sets and is not an acceptable solution for installing a valid certificate on your server. For detailed instructions, refer to the "Installing an SSL Certificate" section
f. Verify that your changes were made.
Adding Custom Page Sets to BBSM
If you created a custom page set manually without using the Page Set Wizard, follow this procedure to add the new page set to the list of available BBSM page sets. You do not need to perform this procedure if you used the Page Set Wizard because the DailyHotel page sets created using the Page Set Wizard are added to the BBSM page sets automatically.
If needed, contact the Cisco TAC to be sure that your web page can be supported. Refer to the "Obtaining Technical Assistance" section in the preface to this user guide.
For additional information about page sets, refer to the following:
•Page Set Overview
•Using the Page Set Wizard
•Creating Custom Page Sets Manually
Step 1 From the Dashboard, click WEBconfig. The BBSM Server Settings web page appears.
Step 2 In the NavBar, select the Custom Page Sets web page. The Custom Page Sets web page appears. (See Figure 18-10.)
Figure 18-10 Custom Page Set Web Page
Step 3 Add the custom page set to BBSM based on the information shown in Table 18-2 and click Save.
Table 18-2 Custom Page Sets Options
Field
|
Description
|
Page Set
|
Enter the name of the page set.
|
Start Page
|
Enter the complete URL of the Start page for your page set. The URL must be in the form http://%iport%... because BBSM translates %iport% to be either the BBSM internal IP address or the BBSM domain name, if applicable. For example, if you saved your page set in a new directory within the c:\atcom\ekgnkm directory, type the following: http://%iport%/ekgnkm/YourNewDirectory/NewNameStart.asp3
The %iport% is automatically expanded to the IP address or domain name of the BBSM server.
Caution If your Start page requests sensitive information from the end user, you should use SSL, and the protocol part of the URL will be https, instead of http.
|
Buttons
|
New
|
Adds a new page set. A new blank web page appears so the page set and Start page can be added.
|
Requery
|
Refreshes the web page (before saving the changes).
|
Save
|
Saves the changes made to the web page.
|
Delete
|
Deletes this page set.
|
