- About This Guide
- Welcome to Cisco NAC Guest Server
- Installing Cisco NAC Guest Server
- System Setup
- Configuring Sponsor Authentication
- Configuring User Group Permissions
- Configuring Guest Login Policies
- Integrating with Cisco NAC Appliance
- Configuring RADIUS Clients
- Guest Account Notification
- Customizing the Application
- Logging and Troubleshooting
- Sponsor Documentation
- Open Source License Acknowledgements
Cisco NAC Guest Server Installation and Configuration Guide, Release 1.0.0
Chapter: Customizing the Application
Customizing the Application
This chapter describes the following
•
Adding a User Interface Template
•Editing a User Interface Template
•Setting the Interface Mapping
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, or 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.
Once your user interface template is configured, you will need to set the template mapping so that the Guest Server starts using the correct template.
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 the template is modified, map this template under User Interface > Mapping and the Cisco NAC Guest Server will present the translated interface to sponsors and guests.
Note With release 1.0.0, the user interface template for the sponsor/guest interface is set for the entire Guest Server.
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 Use 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.
Note 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>.
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 Interface > Templates from the left hand menu.
Figure 10-1 User Interface Templates
Step 2 On the User Interface Templates page (Figure 10-1), click the Add Template button
Figure 10-2 Add Template Page
Step 3 In the Add New Template page (Figure 10-2), type a Template Name. This can be any descriptive text to identify the template later from the Current Templates list (Figure 10-1).
Step 4 Click the Add Template button.
The Edit User Interface Template page for the new template displays, 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 next.
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>.
Step 1 From the administration interface select User Interface > Templates from the left hand menu.
Figure 10-3 User Interface Templates
Step 2 From the Current Templates list (Figure 10-3), select the template that you want to edit.
Step 3 Click the Edit Template button. The Edit User Interface page for the template displays (Figure 10-4).
Figure 10-4 Edit Template
Step 4 Click the tabs at the top of the page to select any of the sponsor pages 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:
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 Reporting > Active 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 Interface > Templates and click the Edit Template button for the template you want to edit in the Current Templates list.
Step 2 In the Edit User Interface page, click the Print Template tab at the top of the page to bring up the Print Template configuration page (Figure 10-5).
Figure 10-5 Print Template Page
Step 3 Change the Page Title as desired (default is "Guest User Details").
Step 4 In the Page Body text field, edit the default HTML code for the web page. The Page Body contains all the HTML that sits between the BODY tags on a HTML page. All HTML 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 the guest account will expire
•%FIRSTNAME% = The first name of the guest
•%LASTNAME% = The last name of the guest
Step 6 Click the Save Template 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. The page is configured in HTML and can be fully customized.
Tip Navigating to Reporting > Active 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 Interface > Templates and click the Edit Template button for the template you want to edit in the Current Templates list.
Step 2 In the Edit User Interface page, click the Email Template tab at the top of the page to bring up the Email Template configuration page (Figure 10-6).
Figure 10-6 Email Template Page
Step 3 Change the Page Title as desired (default is "Guest User Account Details").
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 the guest account will expire
•%FIRSTNAME% = The first name of the guest
•%LASTNAME% = The last name of the guest
Step 7 Click the Save Template 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 Reporting > Active 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 Interface > Templates and click the Edit Template button for the template you want to edit in the Current Templates list.
Step 2 In the Edit User Interface page, click the SMS Template tab at the top of the page to bring up the SMS Template configuration page (Figure 10-7).
Figure 10-7 SMS Template Page
Step 3 Change the SMS Subject as desired.
Step 4 Change the SMS Destination to be the email address of the SMS gateway that you use.
To send the text message to 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 5 The SMS Body contains be 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 the guest account will expire
•%FIRSTNAME% = The first name of the guest
•%LASTNAME% = The last name of the guest
•%MOBILENUMBER% = The mobile number of the guest
Step 6 Click the Save Template button to save your changes.
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 Current Templates list and click the Delete Template button.
Step 3 Confirm deletion of the template.
Setting the 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 Interface > Mapping from the left hand menu.
Figure 10-8 User Interface Mapping
Step 2 Select the Template from the dropdown list. This will become the template used for the sponsor and guest user interface.
Step 3 Click the Set Template button.
Feedback