- About This Guide
- Welcome to Cisco NAC Guest Server
- Installing Cisco NAC Guest Server
- System Setup
- Configuring Sponsor Authentication
- Configuring Guest Policies
- Configuring Sponsor User Groups
- Integrating with Cisco NAC Appliance
- Configuring RADIUS Clients
- Guest Activity Logging
- Guest Account Notification
- Customizing the Application
- Configuring Hotspots
- Backup and Restore
- Replication and High Availability
- Management, Logging and Troubleshooting
- Licensing
- Sponsor Documentation
- API Support
- Open Source License Acknowledgements
Cisco NAC Guest Server Installation and Configuration Guide, Release 2.1
Chapter: Customizing the Application
Customizing the Application
This chapter describes the following
•
Adding a User Interface Template
•Editing a User Interface Template
•Setting the Default Interface Mapping
•Setting User Default Redirection
User Interface Templates
Cisco NAC Guest Server allows you to customize the sponsor user interface text and guest notification text using User Interface Templates. You can:
•Change the labels for the sponsor interface.
•Provide different instructions for guest users.
•Change the default Acceptable Use Policy.
•Create a translated template to provide the sponsor interface and guest instructions in another language altogether.
Cisco NAC Guest Server provides a default template (in English) that can be used as is without any further modification. If you want to change the default presentation for sponsors and guests, you can add one or multiple templates that you can store separately on the Guest Server and modify as desired.
Typically, you create a customized template when you need to modify the account details and instructions that are provided to the guest, such as the Acceptable Usage Policy. Cisco NAC Guest Server provides Print, Email, and SMS templates that allow you to customize the information that is printed, emailed, or text messaged to guests.
If you are customizing the interface for another language, create a new template for the language and edit all pages with the translated text.
Once your user interface template is configured, you need to set the default template mapping so that the Guest Server starts using the correct template. Once a sponsor has authenticated, the sponsor can choose a different template to use and save it under My Settings > Preferences > Language Template in the sponsor interface. This enables each sponsor to have the application displayed in a different template or language.
Note You can set the default user interface template globally for the Cisco NAC Guest Server sponsor and guest interfaces under User Interfaces > User Defaults.
Tip When customizing, it is a good idea to open the sponsor interface in a second browser for reference. This allows you to view how the configuration tabs map to the actual sponsor interface pages. You can bring up the sponsor interface by entering the Guest Server IP address without the "/admin" as the URL, for example, http://<guest_server_ip_address> or https://<guest_server_ip_address>. The sponsor must logout and login again to view the changes.
Adding a User Interface Template
When you add a new template, it is automatically based on the default template to facilitate editing.
Step 1 From the administration interface, select User Interfaces > Templates from the left hand menu.
Step 2 On the User Interface Templates page as shown in Figure 11-1, click the Add Template button
Figure 11-1 User Interface Templates
Step 3 In the Add New Template page as shown in Figure 11-2, type a Template Name. This can be any descriptive text to identify the template later from the User Interface Templates list as shown in Figure 11-1.
Figure 11-2 Add Template Page
Step 4 Click the Add Template button.
The Edit User Interface Template page for the new template is displayed, initially, with all details copied from the default template. If you only need to make small changes, this allows you not to have to retype all the entries.
Step 5 Modify these settings as desired, as described in Editing a User Interface Template.
Editing a User Interface Template
Tip When customizing, it is a good idea to open the sponsor interface in a second browser for reference. This allows you to view how the configuration tabs map to the actual sponsor interface pages. You can bring up the sponsor interface by entering the Guest Server IP address without the "/admin" as the URL, for example, http://<guest_server_ip_address> or https://<guest_server_ip_address>. The sponsor must logout and login again to view the changes.
Step 1 From the administration interface, select User Interfaces > Templates from the left hand menu.
Figure 11-3 User Interface Templates
Step 2 From the User Interface Templates list as shown in Figure 11-3, click the underlined name of the template you wish to edit.
Step 3 The Edit Home Page for the template is displayed as shown in Figure 11-4.
Figure 11-4 Edit Template
Step 4 Click the menu tabs at the top of the page to select any of the sponsor page settings that you want to edit.
Step 5 Make any changes to the fields and click the Save Template button. Some example edits are described in the following sections:
Note The Upload Logo feature allows upload an image with maximum height of 75 pixels and maximum width of 150 pixels. The image can be in .png, .jpg, or .gif format.
Editing the Print Template
The Print Template page contains the guest account details that the sponsor can bring up in a browser to print out for handing to the guest after the account is created. The page is configured in HTML and can be fully customized.
Tip Navigating to Account Management > Manage Accounts on the sponsor interface and clicking the Print button next to the guest account entry brings up the output of the Print Template for printing.
Step 1 Go to User Interfaces > Templates and click the underlined name of the template you wish to edit in the Templates list.
Step 2 Under Edit Home Page, click the Notification tab to bring up the Edit Notification Page as shown in Figure 11-5.
Step 3 From the Select Template for dropdown menu, choose Print Template and click the Show button.
Figure 11-5 Edit Notification Page—Print Template
Step 4 In the Page Body text field, edit the default HTML code for the web page. The Page Body contains all the HTML code that appears between the BODY tags on a HTML page. All HTML code outside these tags is used by the application.
Step 5 In the HTML code you can use the following special variables to replace them with the details from the created guest account.
•%USERNAME% = The Username created for the guest.
•%PASSWORD% = The Password created for the guest.
•%STARTTIME% = The time from which the guest account will be valid.
•%ENDTIME% = The time at which the guest account will expire.
•%FIRSTNAME% = The first name of the guest.
•%LASTNAME% = The last name of the guest.
•%TIMEZONE% = The timezone of the user.
•%MOBILENUMBER% = The mobile number of the guest.
•%OPTION1% = Optional field for editing.
•%OPTION2% = Optional field for editing.
•%OPTION3% = Optional field for editing.
•%OPTION4% = Optional field for editing.
•%OPTION5% = Optional field for editing.
• %MOBILENUMBER_ONLY% = Mobile phone number of guest without country code pre-pended.
• %COUNTRYCODE% = Country code of the mobile phone number.
• %DURATION% = Duration of time for which the account will be valid.
• %ALLOWEDWINDOW% = The time window during which the account can be used after first login.
• %TIMEPROFILE% = The name of the time profile assigned.
Step 6 Click the Save button to save your changes.
Editing the Email Template
The Email Template page contains the guest account details that the sponsor can email to the guest after creating the account.
Tip Navigating to Account Management > Manage Accounts on the sponsor interface and clicking the Email button next to the guest account entry brings up the output of the Email Template and also emails the guest.
Step 1 Go to User Interfaces > Templates and click the underlined name of the template you wish to edit in the Templates list.
Step 2 Under Edit Home Page, click the Notification tab to bring up the Edit Notification Page as shown in Figure 11-6.
Step 3 From the Select Template for dropdown menu, choose Email Template and click the Show button.
Figure 11-6 Edit Notification Page—Email Template
Step 4 Change the Email Subject as desired.
Step 5 In the Email Body text field, edit the default email text to be sent to the guest page.
Step 6 In the Email Body you can use the following special variables to replace them with the details from the created guest account.
•%USERNAME% = The Username created for the guest.
•%PASSWORD% = The Password created for the guest.
•%STARTTIME% = The time from which the guest account will be valid.
•%ENDTIME% = The time at which the guest account will expire.
•%FIRSTNAME% = The first name of the guest.
•%LASTNAME% = The last name of the guest.
•%TIMEZONE% = The timezone of the user.
•%MOBILENUMBER% = The mobile number of the guest.
•%OPTION1% = Optional field for editing.
•%OPTION2% = Optional field for editing.
•%OPTION3% = Optional field for editing.
•%OPTION4% = Optional field for editing.
•%OPTION5% = Optional field for editing.
•%MOBILENUMBER_ONLY% = Mobile phone number of guest without country code pre-pended.
• %COUNTRYCODE% = Country code of the mobile phone number.
• %DURATION% = Duration of time for which the account will be valid.
• %ALLOWEDWINDOW% = The time window during which the account can be used after first login.
• %TIMEPROFILE% = The name of the time profile assigned.
Step 7 Click the Save button to save your changes.
Editing the SMS Template
The SMS Template page contains the guest account details that the sponsor can text message to the guest after creating the account. The contents of the text message can be fully customized.
Tip Navigating to Account Management > Manage Accounts on the sponsor interface and clicking the SMS button next to the guest account entry brings up the output of the SMS Template and also text messages the guest.
Step 1 Go to User Interfaces > Templates and click the underlined name of the template you wish to edit in the Templates list.
Step 2 Under Edit Home Page, click the Notification tab to bring up the Edit Notification Page as shown in Figure 11-7.
Step 3 From the Select Template for dropdown menu, choose SMS Template and click the Show button.
Figure 11-7 Edit Notification Page—SMS Template
Step 4 Change the SMS Subject as desired.
Step 5 Change the SMS Destination to be the email address of the SMS gateway that you use.
To send the text message to the mobile phone number of the guest, use the variable %MOBILENUMBER%. The %MOBILENUMBER% variable is replaced by the mobile phone number, including country code of the guest as entered by the sponsor. For example, if the country code selected is the UK (+44) and the guest's phone number is 055 555-5555, then %MOBILENUMBER% will contain 44555555555.
Note The initial plus symbol (+) is not inserted and the initial 0, any spaces, or hyphens (-) are removed from the phone number. If you need (+) to be inserted, then enter +%MOBILENUMBER%.
Step 6 The SMS Body contains the SMS text to be sent to the guest. In the SMS Body you can use the following special variables to replace them with the details from the created guest account.
•%USERNAME% = The Username created for the guest.
•%PASSWORD% = The Password created for the guest.
•%STARTTIME% = The time from which the guest account will be valid.
•%ENDTIME% = The time at which the guest account will expire.
•%FIRSTNAME% = The first name of the guest.
•%LASTNAME% = The last name of the guest.
•%TIMEZONE% = The timezone of the user.
•%MOBILENUMBER% = The mobile number of the guest.
•%OPTION1% = Optional field for editing.
•%OPTION2% = Optional field for editing.
•%OPTION3% = Optional field for editing.
•%OPTION4% = Optional field for editing.
•%OPTION5% = Optional field for editing.
•%MOBILENUMBER_ONLY% = Mobile phone number of guest without country code pre-pended.
• %COUNTRYCODE% = Country code of the mobile phone number.
• %DURATION% = Duration of time for which the account will be valid.
• %ALLOWEDWINDOW% = The time window during which the account can be used after first login.
• %TIMEPROFILE% = The name of the time profile assigned.
Step 7 Click the Save Template button to save your changes.
Using Time Profiles
Account durations are another way the sponsor can specify how long they want the guest account to remain valid. By default, the sponsor must specify start dates, end dates and time from a dropdown menu and popup calendar. By defining preset account durations, you provide the sponsor with the ability to select the duration of time starting from when they click the button to create the account.
Step 1 Go to User Interfaces > Templates and click the underlined name of the template you wish to edit in the Templates list.
Step 2 Under Edit Home Page, click the Accounts tab to bring up the Edit Accounts Page as shown in Figure 11-7.
Step 3 From the Select Template for dropdown menu, choose Time Profiles and click the Show button as shown in Figure 11-8.
Figure 11-8 Edit Accounts Page—Time Profiles
Step 4 The Time Profiles you previously created are displayed. Enter the text for each template that you wish the sponsor to use.
Deleting a Template
Step 1 From the administration interface, select User Interface > Templates from the left hand menu.
Step 2 Select the template you want to delete from the User Interface Templates list and click the bin icon to the right of the template name field.
Step 3 Confirm deletion of the template.
Setting the Default Interface Mapping
Once you have created your template you need to make the template active. This is a global operation for the Cisco NAC Guest Server.
Step 1 From the administration interface, select User Interfaces > User Defaults to bring up the User Defaults page as shown in Figure 11-9.
Figure 11-9 Default User Interface Mapping
Step 2 Select the template from the Template dropdown menu under Default Interface Mapping. This becomes the template used for the sponsor and guest user interface.
Step 3 Click the Save Settings button.
Setting User Default Redirection
There are a number of options that each sponsor may want to customize for their environment to avoid making changes every time they log in to the sponsor interface. The items sponsors can change are the template (for another language), the time zone, and the telephone country code.
Sponsors can change these settings from their User Settings page once they are logged in. However, to make it easy for first time users of the application, you can choose to direct sponsors to their preference page on their first login to the system.
Step 1 From the administration interface, select User Interfaces > User Defaults from the left hand menu to bring up the User Defaults page as shown in Figure 11-10.
Figure 11-10 User Settings Page Redirection
Step 2 Check the Go to User Settings Page on first login checkbox under Settings, if you want the sponsors to be redirected to the User Settings pages upon their first login to the system. If not, then make sure to leave this option unchecked.
Step 3 Click the Save Settings button.
Feedback