 | Access Code | {$u.username|htmlspecialchars} |
{if $u.Figure 188 Example Template Customize the Guest Accounts Form Next, modify the Guest Accounts form to add a flag that to allows access-code based authentication. 1. Go to Configuration > Pages > Forms & Views. 2. In the Customize Forms & Views list, select create_multi and then click Edit Fields. 3. In the Edit Fields list, look for a field named username_auth. If the field exists but is not bolded and enabled, select it and click Enable Field.
Figure 190 The Create Multiple Guest Accounts Form, Showing the Username Authentication Field 3. Click Create Accounts to display the Finished Creating Guest Accounts page. If you create a large number of accounts, they are created at one time but might not all be displayed at the same time. (This will not affect the printing action in the following step.) 290 | Configuration Dell Networking W-ClearPass Guest 6.
Figure 191 The Account Details Displayed for Multiple Accounts 4. Confirm that the accounts settings are as you expected with respect to letters and digits in the username and password, expiration, and role. 5. Click the Open print window using template drop-down list and select the new print template you created using this procedure See "Create the Print Template" on page 287 for a description of this procedure. A new window or tab will open with the cards. Dell Networking W-ClearPass Guest 6.
Pages The Pages area of the user interface lets you customize the pages that are available to guests and sponsors. To work with pages configuration, go to Configuration > Pages > Start Here. This section includes: l "Customizing Fields" on page 292 l "Customizing Forms and Views" on page 303 l "Customizing Guest Self-Registration" on page 339 l "Managing Web Logins" on page 394 Customizing Fields Custom fields are fields that you define yourself to cater for areas of interest to your organization.
All fields that have been defined are included in the list. To display only the fields that have been created, click the Custom Fields Only link in the bottom row of the list view. To return to displaying all fields, click the All Fields link. You can click a field's row in the list or use the links provided on the page for additional options: Table 125: The Customize Fields List Field Description Edit Edit a field's basic properties. The Edit Field form opens.
Figure 193 The Create Field Form, Basic Information Area Table 126: Create Field Form, Basic Information Area Field Description Field Name (Required) Unique name for this field. The field name cannot include spaces, but can include underscores. Field Type (Required) Type of data to store in this field. Options include: String l Integer l Boolean l Scalar l No data type — Used for a label or a submit button l Description 294 | Configuration Brief description of the field.
Figure 194 The Create Field Form, Default View Display Properties Area The Default View Display Properties area lets you specify the default properties to use when adding this field to a view. For a list of the view display fields, including the Column Type and Column Format fields, see "View Field Editor" on page 337. Table 127: Create Field Form, Default View Display Properties Area Field Description Column Type l Specifies the default column type properties to use when adding this field to a view.
Table 127: Create Field Form, Default View Display Properties Area(Continued) Field Description l l l l l l l Boolean - Enabled/Disabled Boolean - On/Off Date Duration (from seconds) Duration (from minutes) Use form options Custom expression Display Expression If Custom Expression was selected as the Column Format, you can enter the Javascript display expression for the field. The expression “data.f” returns the value of field “f”.
Table 128: Create Field Form, Default Form Display Properties Area(Continued) Field Description Generator group of check boxes or radio buttons. Options List of available options. Enter each “key | value” pair on a separate line, where the key and value are separated by a pipe character ( | ). Options Generator Param Specifies the name of the field whose value will be supplied as the argument to the options. Generator Argument s Value to supply as the argument to the options generator.
Table 128: Create Field Form, Default Form Display Properties Area(Continued) Field Description Icon Image Image to display with the user interface element. Columns Number of columns to display in the user interface element. Rows Number of rows to display in the user interface element. Use -1 to automatically resize the height to fit the contents. Max Length Maximum number of characters that can be entered in the field.
Table 129: Create Field Form, Form Validation Properties Area Field Description Field Required If selected, the field cannot be omitted or left blank. Initial Value Value to initialize this field with when the form is first displayed. Validator Specifies the function used to validate the contents of a field. Validator Param Specifies the name of a field whose value will be supplied as the argument to the validator. Validator Argument Value to supply as the argument to a validator.
Table 130: Create Field Form, Advanced Properties Area(Continued) Field Description Display Function Static Display Param Name of the field whose value will be supplied as the argument to a display function. Static Display Arguments Value to display as the argument to a display function. Force Value If selected, sets the field’s value to the initial value specified above when the form is submitted. PreRegistration Specifies the pre-registration type.
Figure 198 The Define Custom Field Form, Default Form Display Properties Area 3. In the User Interface drop-down list, select Checklist. 4. In the Description text box, delete the existing text, then enter Select the location IDs where this device will be shared. Leave blank to share with all locations. 5. Delete any text from the CSS Class and the CSS Style fields. 6. In the Options Generator drop-down list, select (Use options). 7.
9. (Optional) To control the layout of the checklist on the form, first use the Layout drop-down list to select either Vertical or Horizontal. The name of the next field changes to correspond to your choice in this field. Enter the appropriate number in the Vertical Rows or Horizontal Rows field. If the Layout field is left blank, the default layout of a single list of checklist options is displayed. To ensure the values are stored correctly as a comma-separated list: 1.
3. In the Display Function drop-down list, select NwaExplodeComma. The form expands to include the Display Param and Display Arguments rows. 4. In the Display Param text field, enter the value _self. Be sure to include the leading underscore character. 5. Click Save Changes.
Figure 201 The Customize Forms and Views List View All forms and views in the application are included in the list. You can click a field's row in the list or use the links provided on the page for additional options: Table 131: The Customize Forms & Views List Field Description Edit Edit a form or view's basic properties. The row expands to include the Edit Properties form. See "Editing Forms and Views " on page 304. Edit Fields Edit the form’s or view’s fields.
its Edit link. The row expands to include the Edit Properties form. Figure 202 The Edit Properties Form Table 132: The Edit Properties Form Field Description Name Filename of the application page. Type Page type, either form or view. Title Title of the form or view. Description Brief description of the form or view. Width Total width of the list view in pixels. If this field is left blank, a default value is used. The Width field is only displayed for views.
Table 132: The Edit Properties Form(Continued) Field Description Header HTML HTML template code displayed before the form or view. You can use the drop-down list to add images or links. Footer HTML HTML template code displayed after the form or view. You can use the drop-down list to add images or links. Save Changes Saves your changes to this form. On the Customize Forms & Views list, an asterisk (*) is shown next to the form or view to indicate that it has been modified.
To work with a form field, click its row in the list. The row expands to include configuration options: Table 134: Customize Form Fields, Options Field Description Edit Make changes to an existing field. The Form Field Editor opens. Any changes made to the field using this editor will apply only to this field on this form. See "Form Field Editor " on page 307. Edit Base Field Make changes to an existing field’s definition. The Edit Field form opens.
Form Display Properties Figure 205 The Form Field Editor Form, Form Display Properties Area On the Form Field Editor (see "Form Field Editor " on page 307), the form display properties control the user interface this field will have. Different options are available in this section, depending on the selection you make in the User Interface drop-down list. Fields with a green border use their base field's value.
CAPTCHA Security Code If the CAPTCHA user interface is selected, a distorted image of several characters will be displayed to the user, as shown below: Figure 206 A CAPTCHA Code Image in a Field A new image may be generated, or the image may be played as an audio sample for visually impaired users. When using the recommended validator for this field (NwaCaptchaIsValid), the security code must be matched or the form submit will fail with an error.
Figure 209 Form Display Properties Options for the Check Box User Interface Checklist If the Checklist user interface is selected, a list of check boxes is displayed, as shown below: Figure 210 A Checklist in a Field The text displayed for each check box is the value from the options list. Zero or more check boxes may be selected. This user interface type submits an array of values containing the option key values of each selected check box.
The “Vertical” and “Horizontal” layout styles control whether the check boxes are organized in top-to-bottom or left-to-right order. The default is “Vertical” if not specified. When using these options, you may also specify the desired number of columns or rows to adjust the layout appropriately. Figure 211 Form Display Properties Options for the Checklist User Interface Dell Networking W-ClearPass Guest 6.
Figure 212 Advanced Properties Options for the Checklist User Interface For example, suppose the first two check boxes are selected (in this example, with keys “one” and “two”). The incoming value for the field will be an array containing 2 elements, which can be written as array("one", "two"). The NwaImplodeComma conversion is applied, which converts the array value into the string value “one,two”, which is then used as the value for the field.
Figure 213 Advanced Properties for the Date/time picker User Interface Drop-Down List If the Drop-down list user interface is selected, the field is displayed allowing a single choice from a drop-down list. Figure 214 A Drop-Down List in a Field The text displayed for each option is the value from the options list. When the form is submitted, the key of the selected value becomes the value of the field.
Figure 215 Form Display Properties Options for the Drop-down list User Interface File Upload If the File upload user interface is selected, a file selection text field and dialog box are displayed (the exact appearance differs from browser to browser). File uploads cannot be stored in a custom field. This user interface type requires special form implementation support and is not recommended for use in custom fields.
Figure 216 Form Display Properties Options for the Hidden Field User Interface Figure 217 Initial Values for a Form Multiple Selection List If the Multiple selection list user interface is selected, a list of selectable options will be displayed. The text displayed for each check box or radio button is the value from the options list. Zero or more check boxes may be selected. This user interface type submits an array of values containing the option key values of each selected check box.
Figure 218 Form Display Properties Options for the Multiple selection list User Interface Password Text Field If the Password text field user interface is selected, the field is displayed as a text field, with input from the user obscured. The text typed in this field is submitted as the value for the field.
Radio Buttons If the Radio buttons user interface is selected, the field is displayed as a group of radio buttons, allowing one to be selected, as shown below: Figure 221 Radio Buttons in a Field The text displayed for each option is the value from the options list. When the form is submitted, the key of the selected value becomes the value of the field.
Static Text If the Static text user interface is selected, the field’s value is displayed as a non-editable text string. An icon image may optionally be displayed before the field’s value. A hidden element is also included for the field, thereby including the field’s value when the form is submitted. Figure 223 A Static Text Field in a Form If the Hide when no options are selectable check box is selected in the Collapse row, the field will be hidden if its value is blank.
Use caution when using this type of user interface element, particularly if the field’s value is collected from visitors. Allowing HTML from untrusted sources is a potential security risk. Figure 226 Form Display Properties Options for the Static text (Raw value) User Interface If the Hide when no options are selectable check box is selected in the Collapse row, the field will be hidden if its value is blank.
Figure 228 Form Display Properties Options for the Static text (Options lookup) User Interface If the Hide when no options are selectable check box is selected in the Collapse row, the field will be hidden if its value is blank. To set the value of this field, use the Initial Value option in the Form Validation Properties area of the form field editor.
Figure 230 Form Display Properties Options for the Static group heading User Interface Submit Button If the Submit button user interface is selected, the field is displayed as a clickable form submit button, with the label of the field as the label of the button. Figure 231 A Button on a Form Figure 232 Form Display Properties Options for the Submit button User Interface The description is not used. The field’s value is ignored, and will be set to NULL when the form is submitted.
Text Area If the Text area user interface is selected, the field is displayed as a multiple-line text box. The text typed in this box is submitted as the value for the field.
Figure 236 Form Display Properties Options for the Text field User Interface If you select Text or Password as the User Interface type, the Placeholder row is added to this form. You may use this field to enter a temporary value, such as a hint for how to complete the field, that can later be overridden by the user completing the form that uses this field.
Table 135: Form Field Editor, Form Validation Properties Area Field Description Field Required If selected, the field cannot be omitted or left empty. Required fields are marked with an asterisk, as shown below: All values supplied for a required field are always validated, including blank values. An optional field may be left blank. In this case, the field is not validated as there is no value for the field. However, any value that is supplied for an optional field is subject to validation checks.
Examples of Form field Validation Example 1 — Integer Value Between 1 and 100 (Inclusive) To create a form field that requires an integer value between 1 and 100 (inclusive) to be provided, use the following settings in the Form Field Editor (see "Form Field Editor " on page 307): Figure 238 Form Field Editor, Form Validation Properties Area, Example Range of Integer Values The form field will contain an integer value, so you should set the field's type to Integer when you create it.
The reason for this is that in this case, the validation has failed due to a type error — the field is specified to have an integer type, and a blank or non-numeric value cannot be converted to an integer. To set the error message to display in this case, use the Type Error option in the Advanced Properties area.
Example 3 — US Social Security Numbers To create a form field that validates US social security numbers using a regular expression, use the following settings in the form field editor: Figure 242 Form Field Editor, Form Validation Properties Area, Example Regular Expression Values Notice that the regular expression used here includes beginning and ending delimiters (in this case the / character), and ensures that the whole string matches by the start-of-string marker ^ and the end-of-string marker $.
Advanced Form Field Properties Figure 243 Form Field Editor, Advanced Properties Area On the Form Field Editor (see "Form Field Editor " on page 307), options in the Advanced Properties area control certain optional form processing behaviors. You can also specify JavaScript expressions to build dynamic forms similar to those found elsewhere in the application.
Table 136: Form Field Editor, Advanced Properties Area(Continued) Field Description Display Function Specifies the function used to convert a field to a displayable value on the form. This option can be used to enable certain form processing behavior. See "Form Field Conversion Functions" on page 744 and "Form Field Display Formatting Functions" on page 745. Display Param Name of the field whose value will be supplied as the argument to a display function.
At this point, the Password field is not listed because the Create Multiple Guest Accounts form (create_ multi) has not yet been customized to include it. You will create it for the form in the next step. 2. Click on any field in the list to expand a row, then click the Insert After link (you can modify this placement later). The Customize Form Field form opens. 3. In the Field Name row, choose password from the drop-down list. The form displays configuration options for this field.
Figure 245 Steps Involved in Form Field Processing Dell Networking W-ClearPass Guest 6.
| Configuration Dell Networking W-ClearPass Guest 6.
The Conversion step should be used when the type of data displayed in the user interface is different from the type required when storing the field. For example, consider a form field displayed as a date/time picker, such as the expire_time field used to specify an account expiration time on the create_user form. The user interface is displayed as a text field, but the value that is required for the form processing is a UNIX time (integer value).
A comparison of these two approaches is shown below to illustrate the difference: Figure 247 Comparison of Two Validation Approaches When using a Conversion or Value Format function, you will almost always have to set up a Display Function for the form field. This function is used to perform the conversion in the reverse direction – between the internal stored value and the value displayed in the form field.
The expression must be a Boolean expression in the JavaScript language; statements and other code should not be included as this will cause a syntax error when the form is displayed in a Web browser. Because of the scoping rules of JavaScript, all of the user interface elements that make up the form are available as variables in the local scope with the same name as the form field.
Figure 249 The Customize View Fields List View The Customize View Fields list view includes the following columns: l Rank — Specifies the relative ordering of the columns when displaying the view. The Customize View Fields editor always shows the columns in order by rank. l Field — The field name. l Type — The type of the field. This controls what kind of user interface element is used to display the column, and whether the column is to be sortable or not.
Table 137: Customize View Fields(Continued) Field Description Enable Field Immediately enables display of the column. A progress indicator is briefly displayed. Disable Field Immediately disables display of the column. A progress indicator is briefly displayed. Customize fields Lets you modify existing fields. The Customize Fields list view opens (Configuration > Pages > Fields). See "Customizing Fields" on page 292.
Table 138: View Field Editor Field Description Field Name (Required) Specifies the field definition to display in the view. Field If selected, enables the field. To use the default view display properties for a field, you only need to select this check box to enable the field to display in the column, and then click Save Changes. No further changes are needed on this form. Rank (Required) Indicates the field’s position in the relative ordering of the fields.
Table 138: View Field Editor(Continued) Field Description l l l l l l l l Boolean – Yes/No — The value of the field is converted to Boolean and displayed as “Yes” or “No”. Boolean – Enabled/Disabled — The value of the field is converted to Boolean and displayed as “Enabled” or “Disabled”. Boolean – On/Off — The value of the field is converted to Boolean and displayed as “On” or “Off”. Date — The value of the field is assumed to be a UNIX timestamp value and is displayed as a date and time.
This section includes: l "Accessing the Guest Self-Registration Customization Forms" on page 340 l "Self-Registration Sequence Diagram" on page 344 l "Editing Self-Registration Pages" on page 345 l "Creating a Self-Registration Page" on page 346 l "Configuring Basic Properties for Self-Registration" on page 348 l "Editing Registration Page Properties" on page 351 l "Editing the Default Self-Registration Form Settings" on page 353 l "Editing Guest Receipt Page Properties" on page 355 l "Edit
Table 139: Guest Self-Registrations Field Description Edit Edit any of the self-registration page's properties. The Customize Guest Registration workflow diagram opens. Links in the workflow diagram provide access to any section of the registration page's properties. For information on editing the different parts of the self-registration process, see "Editing Self-Registration Pages" on page 345. Delete Deletes the guest self-registration page. You will be asked to confirm the deletion.
Figure 252 The Duplicate Guest Registration Form Disabling a Self-Registration Page When you choose the Disable option for a self-registration page, the row expands to include the Disable Guest Registration form. In the Disabled Message text box, you may enter the HTML content to display on the page when guest registration is disabled. You can also use the drop-down list to add images or other content items.
Figure 254 The Visitor Registration Form The Receipt Page After the visitor successfully registers, the receipt page is their confirmation and provides their login and access information. Figure 255 The Visitor Registration Receipt The "Go to Portal" Option When you choose the Go To Portal option for a self-registration page, the row expands to show an active preview of the Self Service Login page and form as the visitor would see it. This form lets the visitor access their account information.
Figure 256 The Self-Service Login Form The "Go to Login" Option When you choose the Go To Login option for a self-registration page, the row expands to show an active preview of the Network Login page and form as the visitor would see it. This is the page the visitor sees when they log in to the network. You may test the behavior of the form.
Figure 258 Sequence Diagram for Guest Self-Registration In this diagram, the stages in the self-registration process are identified by the numbers in brackets, as follows: The captive portal redirects unauthorized users [1] to the registration page [2]. After submitting the registration form [3], the guest account is created and the receipt page is displayed [4] with the details of the guest account.
Figure 259 Guest Self-Registration Workflow Diagram . The diagram shows the guest self-registration process. The solid orange arrows show the workflow for the visitor. The dotted blue arrows show the workflow for the administrator. The blue headings in the diagram are links to the corresponding sections of the Customize Guest Registration form. Click an icon or label in the diagram to jump directly to the editor for that item.
Figure 260 The Customize Guest Registration Form Table 140: Customize Guest Registration Field Description Name (Required) The name of this self-registration page to identify it —for example, "Guest Self-Registration". This name can include spaces. This name is only displayed to administrators within W-ClearPass; it is not seen by the visitor. Description You may enter comments to further identify or describe this page. This description is only displayed within W-ClearPass.
Table 140: Customize Guest Registration(Continued) Field Description Hotspot Select this check box if the page will be used for Hotspot transactions. Requires the visitor to pay for access. Authentication Requires operator credentials to access the page. The sponsor's operator profile must include the Guest Manager > Create New Guest Account privilege. Save Changes Saves your changes and creates the self-registration page. This form closes and the self registration process diagram opens.
Table 141: Customize Guest Registration, Basic Properties(Continued) Field Description Parent To use the settings from a previously configured self-registration page, select an existing page name from the drop-down list. This is useful if you need to configure multiple registrations. You can override parent page values by editing field values yourself. To create a self-registration page with new values, select the Guest Self-Registration (guest_register) option from the Parent field dropdown menu.
When you complete the Basic Properties area and click Save and Continue, the form expands to include the Access Control area, where you can specify access restrictions for the self-registration page.
Table 142: Customize Guest Registration, Access Control(Continued) Field Description Deny Behavior (Required) The response shown to the user if their request is denied. Options in this drop-down list include: l Send HTTP 404 Not Found status l Show Access Denied page l Show a blank page Time Access The Time Access field allows you to specify the days and times that self-registration is enabled. Times must be entered in 24-hour clock format.
Figure 263 The Customize Guest Registration Form, Register Page UI Area Table 143: Customize Guest Registration Form, Register Page UI Area Field Description Title Title to display on the guest registration page. Template code may be specified. See "Smarty Template Syntax" on page 700 for details on the template code that may be inserted. Header HTML HTML for the message that is displayed above the guest registration form. Template code may be specified.
Table 143: Customize Guest Registration Form, Register Page UI Area(Continue) Field Description Save and Reload Saves your changes, updates the self-registration page, and launches or refreshes a second browser window to show the effects of the changes. Save Changes Saves your changes and returns to the process diagram for self-registration. Save and Continue Saves your changes, updates the self-registration page, and continues to the next editor.
l The visitor_name and email fields are enabled. The email address of the visitor will become their username for the network. l The expire_after field is set to a value of 24 by default; this sets the default expiration time for a selfregistered visitor account to be 1 day after it was created. This field is hidden by default on the register page. l The role_id field is set to a value of 2 by default; this sets the default role for a self-registered visitor account to the built-in Guest role.
Editing Guest Receipt Page Properties To edit the properties of the guest receipt page: 1. Go to Configuration > Pages > Guest Self-Registration 2. Select an entry in the Guest Self-Registration list and click its Edit link. The Customize Guest Registration workflow diagram opens. 3. Click the Receipt Page link or one of the Title, Header, or Footer fields for the Receipt Page to edit the properties of the receipt page. This page is shown to guests after their visitor account has been created.
Table 146: Customize Guest Registration Form, Receipt Page UI Area(Continue) Field Description Override Receipt If selected, lets you replace the HTML of the guest receipt. Save Changes Saves your changes and returns to the process diagram for self-registration. Save and Continue Saves your changes, updates the self-registration page, and continues to the next editor (Receipt Actions). Editing Receipt Actions To edit the actions that are available after a visitor account has been created: 1.
Figure 267 The Customize Guest Registration Form, Receipt Actions Page, Download Area Editing Download Actions for Guest Receipt Delivery The Download area on the Receipt Actions part of the Customize Guest Registration form lets you configure template and display options to deliver a receipt to the user as a downloadable file. Table 147: Customize Guest Registration Form, Receipt Actions Page, Download Area Field Description Enabled If selected, enables download of guest receipts.
Table 147: Customize Guest Registration Form, Receipt Actions Page, Download Area(Continued) Field Description Template l l l l l l l l l l l Account List Certificate Expiry Download Receipt Guest Account Expiry GuestManager Receipt One account per page SMS Receipt SMS Sponsor Confirmation Alert Sponsor Device Provisioning Sponsorship Confirmation Two-column scratch cards Filename The template code to evaluate to generate the filename for the receipt.
Table 148: Customize Guest Registration Form, Receipt Actions Page, Print Area(Continued) Field Description l l l l l l l l l l Certificate Expiry Download Receipt Guest Account Expiry GuestManager Receipt One account per page SMS Receipt SMS Sponsor Confirmation Alert Sponsor Device Provisioning Sponsorship Confirmation Two-column scratch cards Action Icon Specifies a custom icon to use for the printer receipt action.
Table 149: Customize Guest Registration Form, Receipt Actions Area, Email Delivery Options Field Enabled Description Specifies options for disabling or configuring the sending of guest receipts by email. Options include: Disable sending guest receipts by email — Email receipts are never sent for a guest registration. l Always auto-send guest receipts by email — An email receipt is always generated using the selected options, and will be sent to the visitor’s email address.
Table 149: Customize Guest Registration Form, Receipt Actions Area, Email Delivery Options(Continued) Field Description l l l Custom Skin 2 Galleria Skin 1 Galleria Skin 2 Send Copies (Required) Specifies when to send visitor account receipts to the recipients in the Copies To list.
Editing SMS Delivery of Guest Receipts The SMS Delivery options available for the receipt page actions allow you to specify the field containing the visitor’s phone number, the service provider, and the SMS receipt template. Figure 270 The Customize Guest Registration Form, Receipt Actions Area, SMS Delivery Options Table 150: Customize Guest Registration Form, Receipt Actions Area, SMS Delivery Options Field Description Enabled Specifies options for disabling or configuring SMS delivery.
Table 150: Customize Guest Registration Form, Receipt Actions Area, SMS Delivery Options(Continued) Field Description l l l Download Receipt SMS Receipt SMS Sponsor Confirmation Alert Rank Specifies the relative ordering number for this receipt action. Action Icon Specifies a custom icon to use for the SMS delivery receipt action. Image files that have been uploaded to Content Manager will be included in this drop-down list. Action Text Label to use for the SMS delivery receipt action.
Figure 271 The Sponsor Confirmation Link on the Workflow Diagram 364 | Configuration Dell Networking W-ClearPass Guest 6.
Figure 272 The Customize Guest Registration Form, Sponsorship Confirmation Page, Email Delivery Area Editing Email Delivery Options for Sponsorship Confirmation The Email Delivery area on the Sponsorship Confirmation part of the Customize Guest Registration form lets you configure options for the notification email that is sent to the sponsor, such as sponsor authentication and the print template and email format. Dell Networking W-ClearPass Guest 6.
Table 151: Customize Guest Registration Form, Sponsorship Confirmation Page, Email Delivery Area Field Description Enabled If selected, sponsorship confirmation is required before the guest account can be enabled. The form expands to include configuration options for sponsorship confirmation. Authentication if selected, sponsors must provide credentials and be successfully authenticated before they can approve the guest account request.
Editing SMS Delivery Options for Sponsorship Confirmation The SMS Delivery options available for sponsorship confirmation allow you to specify the field containing the visitor’s phone number, the service provider, and the SMS receipt template.
Editing UI Override Options for Sponsorship Confirmation The UI Overrides area on the Sponsorship Confirmation part of the Customize Guest Registration form lets you customize the user interface text and labels, overriding the default values.
Table 153: Customize Guest Registration Form, Sponsorship Confirmation Page, UI Overrides Area(Continued) Field Description Header HTML HTML for the message that is displayed before the login form. Template code may be specified. See "Smarty Template Syntax" on page 700 for details on the template code that may be inserted. You can use the drop-down list to add images or links. Form Override If selected, lets you override the form.
Table 154: Customize Guest Registration Form, Sponsorship Confirmation Page, Account Overrides Area Field Description Role Override Specifies the role assigned to the guest when the sponsor’s confirmation is successful, or lets the sponsor assign the role during confirmation. Options include: l (No override) l (Prompt) l [Contractor] l [Employee] l [Guest] If “Prompt” is selected, the sponsor chooses the role for the guest from the Account Role drop-down list of the guest registration receipt.
3. In the Name field, the name you enter for the profile must include the exact role name in square brackets. For example, for the role “[Guest]”, the profile name might be “My Company [Guest] CoA”. 4. On the Attributes tab, open the Select RADIUS CoA Template drop-down list and select Aruba Change-User-Role. 5. Click a row and add an attribute with the Type as Radius:IETF. For the Value enter the role name, but without the square brackets this time.
Table 155: Customize Guest Registration Form, Login Form Page, Enabled/Disabled Area Field Enabled Description Specifies the login or device enrollment method. Options include: Disabled l Enable guest login to a Network Access Server — Allows NAS login. The form expands to include configuration options. See "Configuring the Login Form Part of the Page" on page 372 and "Configuring the Login Message Part of the Page" on page 375.
Login Form and Post-Authentication Areas Figure 278 The Customize Guest Registration Form, Login Form and Post-Authentication Areas Table 156: The Customize Guest Self-Registration Form, Login Form and Post-Authentication Field Description Custom Form Indicates you will provide a custom login form. If selected, you must supply your own HTML login form for the header or footer HTML areas. Custom Labels Enables altering the default labels and error messages.
Field Description Terms Label Label that appears on the form for the terms check box. Leave blank to use the default (Terms:). Terms Text Enter the HTML code containing your terms and conditions. Leave blank to use the default, (I accept the terms of use) Terms Layout Layout for the terms and conditions text—either above or below the Terms check box. Terms Error Text to display if the terms are not accepted.
Figure 279 The Customize Guest Registration Form, Login UI Area Table 157: The Customize Guest Self-Registration Form, Login UI Section Field Description Login Page Title The title that will be displayed on the NAS login page. Header HTML The HTML content to display above the NAS login form. You can use the drop-down lists to add images or other content items. Footer HTML The HTML content to display below the NAS login form. You can use the drop-down lists to add images or other content items.
Figure 281 The Customize Guest Registration Form, Automatic Login Area, Login Delay Option Click the Save Changes button to return to the process diagram for self-registration. Configuring Self-Registration with Onboard Device Enrollment To allow Onboard enrollment with self-registrations: 1. Go to Configuration > Pages > Guest Self-Registrations. Click to expand the registration page's row in the form, and then click its Edit link. The Customize Guest Self-Registration diagram opens. 2.
Figure 283 The Customize Guest Self-Registration Page, Onboard Enrollment Options Table 158: Customize Guest Registration, Onboard Enrollment Field Description Enabled To allow simultaneous self-registration and Onboard device enrollment, select Enable Onboard device enrollment. Provisioning Settings Local Device Provisioning is the only option available in this field when Onboard device enrollment is selected.
Editing Social Logins Properties Options in the Social Logins area let you present guests with a variety of social login options. To edit the social logins properties of the login page: 1. Go to Configuration > Pages > Guest Self-Registrations. Click to expand the registration page's row in the form, and then click its Edit link. The Customize Guest Self-Registration diagram opens. 2.
Figure 285 The Customize Guest Registration Form, Login Form Page, Social Logins Area (Facebook WiFi selected as the provider) Table 159: Customize Guest Registration, Social Logins Properties Field Description Social Login If selected, enables the use of social network credentials to log in. The form expands to include Authentication Providers social login configuration options. Provider (Required) Specifies the social network provider to use.
Field Description Add new authentication provider Opens the properties form for adding and configuring a social network provider. Admin SDK Refresh Token (Required) Valid Google API admin refresh token. To generate a new refresh token, clear this value. You will need to generate a new authorization code. Advanced If selected, displays additional options on this form. Allow Guests If selected, allows Google accounts that are not part of your domain to log in as guests.
Field Description returned by the user. This is only needed if you are creating specialized enforcement policies on them. Friends If selected, allows a list of the guest’s friends to be retrieved, if permission is granted by the guest. The list is limited to only those friends who also use your application ID. Generate Code To generate a new authorization code, click the link in this field. You will be redirected to a new window to generate an authorization code.
Enabling and Editing NAS Login Properties If automatic guest login is not enabled, the submit button on the receipt page will not be displayed, and automatic Network Access Server (NAS) login will not be performed. To enable and edit the properties for automatic NAS login: 1. Go to Configuration > Pages > Guest Self-Registrations. Click to expand the Guest Self-Registration row in the form, and then click its Edit link. The Customize Guest Self-Registration diagram opens. 2.
Table 160: Customize Guest Registration Form, NAS Login Area Field Enabled Description Specifies the NAS login method. Options include: Disabled l Enable guest login to a Network Access Server l Enable Onboard device enrollment l Provisioning Settings (Required) For Onboard device enrollment, specifies the provisioning settings to use when enrolling self-registered devices. Vendor Settings (Required) Specifies the vendor or other settings to use for standard network configurations.
Table 160: Customize Guest Registration Form, NAS Login Area(Continued) Field Description Submit URL (Required) URL of the NAS device’s login form. Submit Method (Required) Method to use when logging in to the NAS. Options include: l POST l GET Username Field (Required) Name of the username field for the NAS device’s login form. Password Field (Required) Name of the password field for the NAS device’s login form.
2. In the Self-Service Portal area, click either the Self-Service Portal link or click one of the links below it: Login Page, Summary Page, Change Password, or Reset Password . The Self-Service Portal area of the Customize Guest Registration form opens. Figure 288 The Self-Service Portal Page Links on the Workflow Diagram Dell Networking W-ClearPass Guest 6.
Figure 289 The Customize Guest Registration Form, Self-Service Portal The fields at the top of the form let you configure basic properties for the self-service portal. Table 161: The Customize Guest Registration Form, Self-Service Portal Area, Basic Properties Field Description Enabled If selected, enables the self-service portal for guest access. If this check box is not selected, access to the portal is disabled and a “disabled” message is displayed to the user.
Figure 290 The Customize Guest Registration Form, Self-Service Portal Page, Login Page Area The Login Page area of the form lets you configure the self-service portal’s login page. Table 162: Customize Guest Registration Form, Self-Service Portal Page, Login Page Area Field Description UI Overrides If selected, lets you customize the self-service portal’s login form’s text and HTML. The form expands to include configuration options.
Table 162: Customize Guest Registration Form, Self-Service Portal Page, Login Page Area(Continued) Field Description Header HTML The HTML content to display before the login form. You can use the drop-down list to add images or other content items. Login Form Override If selected, overrides the login form. Form Title Title to display on the login form. To use the default value, leave this field empty. Username Label Label to display on the username field.
The Summary Page area of the form lets you configure the self-service portal’s summary page. Table 163: Customize Guest Registration Form, Self-Service Portal Page, Summary Page Area Field Description UI Overrides If selected, lets you customize the self-service portal’s summary page’s text and HTML. The form expands to include configuration options. Page Title Title to display on the self-service portal’s summary page. To use the default value, leave this field empty.
The Change Password area of the form lets you configure the self-service portal’s password fields. Table 164: Customize Guest Registration Form, Self-Service Portal Page, Change Password Area Field Description Change Password If selected, guests cannot use the self-service portal to change their passwords. Extend Expiration Amount of time to extend an account’s expiration window whenever the password is changed.
Figure 293 The Customize Guest Registration Form, Self-Service Portal Page, Reset Password Area The Reset Password area of the form lets you configure the self-service portal’s password reset fields. For more information, see "Resetting Passwords with the Self-Service Portal" on page 392. Table 165: Customize Guest Registration Form, Self-Service Portal Page, Reset Password Area Field Description Reset Password If selected, guests cannot use the self-service portal to reset a forgotten password.
Table 165: Customize Guest Registration Form, Self-Service Portal Page, Reset Password Area(Continued) Field Description Reset Form Override If selected, overrides the reset password form. Form Title Title to display on the reset password form. To use the default value, leave this field empty. Footer HTML The HTML content to display after the reset password form. You can use the drop-down list to add images or other content items.
This feature allows the password to be reset for any guest account on the system, which might pose a security risk. It is strongly recommended that when this feature of the self-service portal is enabled, guest registrations should also store a secret question/secret answer field. To enable a more secure password reset operation, use the Reset Password fields described in "Self-Service Portal Properties" on page 384 to perform the following steps.
Selecting a different value for the Required Field allows other fields of the visitor account to be checked. These fields should be part of the registration form. For example, selecting the visitor_name field as the required field results in a Reset Password form like this: Figure 298 The Reset Password Form with Visitor Name as the Required Field Managing Web Logins The Web Logins page lists all the Web login pages you have created, and lets you edit and test them and create new Web login pages.
Field Description Create new Web login page Create a new Web login page. For more information, see "Creating and Editing Web Login Pages" on page 395. Creating and Editing Web Login Pages Onboard device provisioning pages are now managed from the Web Login tab in Onboard > Provisioning Settings. Dell Networking W-ClearPass Guest 6.
Onboard creates a default Web login page that is used to start the device provisioning process. To create a new Web login page, go to Configuration > Pages > Web Logins and click the Create new Web login page link in the upper-right corner. The Web Login Editor form opens. General Properties Area Figure 300 The Web Login Editor Form, General Properties Area Table 167: Web Login Editor, General Properties Field Description Name (Required) Name for the page.
Field Description l l Login Method Specifies how the user's network login should be handled. Options include: l Controller-initiated—Guest browser performs HTTP form submit l Server-initiated—Change of authorization (RFC 3576) sent to controller—Serverinitiated logins require the user's MAC address to be available. This is usually acquired through the captive portal redirect. If you are setting up Multi-Factor Authentication (MFA) with username-only authentication, choose this option.
Login Form Area Options in the Login Form area specify the behavior and content of the login form. The options available in this area depend on the selection you made in the Vendor Settings field. Figure 301 The Web Login Editor Form, Login Form Area Table 168: Web Login Editor, Login Form Properties Field Description Submit URL URL of the NAS device's login form. Submit Method Method to use when submitting the login form to the NAS.
Field Description Anonymous User (Required) Account to use for anonymous authentication. The password will be visible in the HTML. The account Session Limit should be increased to the number of guests to be supported. To use a specific username, enter it in this field. To randomly generate a user name, leave this field blank.
Field Description l l l l App Authorization – check using Aruba Application Authorization Local – match a local account RADIUS – check using a RADIUS request Single Sign-On – enable SSO for this Web login — When this option is selected, guests are redirected to the Identity Provider (IdP) configured in W-ClearPass, where they authenticate themselves. They are redirected back to W-ClearPass, which verifies the login was successful and uses the same credentials to redirect to the actual Web login flow.
Table 169: Web Login Editor, Default Destination Properties Field Description Default URL (Required) Default URL for the redirect page. For external domains, this must include the http:// prefix. Override Destination If selected, forces the default destination for all clients, overriding any default value already set on the client. Login Page Area Options in the Login Page area control the look and feel of the login page.
Table 170: Web Login Editor, Login Page Properties Field Skin Description (Required) Specifies the skin to use for the login page. Options include: (Default) l Aruba ClearPass Skin l Blank Skin l Custom Skin 1 l Custom Skin 2 l Dell ClearPass Skin l Galleria Skin l Galleria Skin 2 l Title Title that will be displayed on the page. Header HTML HTML content to display above the login form. The default content is shown, and can be modified.
Social Logins Area Options in the Social Logins area let you present guests with various social login options. Figure 305 The Web Login Editor Form, Social Logins Area, Authentication Providers List Dell Networking W-ClearPass Guest 6.
Figure 306 The Web Login Editor Form, Social Logins Area, Add New Authentication Provider Form (Facebook WiFi selected as the provider) Table 171: Web Logins Editor, Social Logins Properties Field Description Social Login If selected, enables the use of social network credentials to log in. The form expands to include social login configuration options. Provider (Required) Specifies the social network provider to use. All social network providers that have been configured are included in this list.
Field Description Add new authentication provider Opens the properties form for adding and configuring a social network provider. Admin SDK Refresh Token (Required) Valid Google API admin refresh token. To generate a new refresh token, clear this value. You will need to generate a new authorization code. Advanced If selected, displays additional options on this form. Allow Guests If selected, allows Google accounts that are not part of your domain to log in as guests.
Field Description returned by the user. This is only needed if you are creating specialized enforcement policies on them. Friends If selected, allows a list of the guest’s friends to be retrieved, if permission is granted by the guest. The list is limited to only those friends who also use your application ID. Generate Code To generate a new authorization code, click the link in this field. You will be redirected to a new window to generate an authorization code.
Multi-Factor Authentication Area Options in the Multi-Factor Authentication area let you require a secondary factor when authenticating. When the guest enters their username to log in, they are sent a code which they must successfully retrieve and enter to complete the login. For more information, see "About Multi-Factor Authentication" on page 410.
Table 172: Web Logins Editor, Multi-Factor Authentication(Continued) Field Description Duo Secret Key (Required) The Duo skey. Email If selected, emails will be sent during application enrollment. If deselected, the user must scan the QR code. Factors The number of factors to require. Header HTML HTML template code to display before the provider’s vendor-specific authentication area. This is the login “wait” page displayed to the user while the authentication code is sent to and submitted by them.
Table 173: Web Login Editor, Network Login Access Properties Field Description Allowed Access IP addresses and networks from which logins will be allowed. (IPv4 and IPv6 are both supported) Denied Access IP addresses and networks from which logins will be denied. (IPv4 and IPv6 are both supported) Deny Behavior (Required) Response shown to the user if their login request is denied.
Table 174: Web Login Editor, Post-Authentication Properties Field Description Health Check If selected, requires the visitor to pass a health check before they can access the network. The health check is done automatically through the OnGuard Dissolvable Agent. Client Agents Specifies the agent option OnGuard should use for client scanning.
To set up the MFA provider and the users: 1. Collect any required elements from the selected MFA provider’s account. These might include such things as a secret key, integration key, hostname, tenant name, app name, client ID, or special username and password. 2. Create a user account in W-ClearPass Guest with the same name that is configured in the MFA provider. To set up a captive portal login: 1. Configure W-ClearPass for regular guest services. 2.
Managing Web Pages Simple Web pages provide additional information to guests -- for example, advising them that the device does not meet security requirements, service is unavailable, their browser is unsupported, the device is jailbroken, or to provide “terms and conditions” information. The Web Pages view lists all the Web pages you have created, and lets you edit and preview them and create new Web pages. It also includes templates for new Web pages.
The Web Page Templates W-ClearPass Guest provides the following templates for simple Web pages. You can use these templates as they are, or edit any of their properties to suit your needs, or copy them to use as a basis for new Web pages. These templates are available at Configuration > Pages > Web Pages. Browser Unsupported Page Template The Browser Unsupported template can be used to show a message advising the guest that their browser is not supported.
Jailbroken Device Page Template The Jailbroken Device template can be used to show a message advising the guest that the iOS device has been modified, or jailbroken. Figure 312 The Page Displayed by the Jailbroken Device Template Posture Check Page Template The Posture Check template can be used to show a message advising the guest that the device does not meet the organization’s minimum security requirements (detected by OnGuard).
Service Unavailable Page Template The Service Unavailable template can be used to show a message advising the guest that service is temporarily unavailable. Figure 314 The Page Displayed by the Service Unavailable Template Terms and Conditions Template The Terms and Conditions template can be used to provide information to the user about the terms and conditions of use.
l To edit an existing simple Web page, click the Edit link for a page in the list. l To make a copy of a template or existing page to use as a basis for a new page, click the Copy link for a template or page in the list. The Web Page Settings form opens. Figure 316 The Web Page Settings Editor, General Settings Figure 317 The Web Page Settings Editor, Advanced Settings 416 | Configuration Dell Networking W-ClearPass Guest 6.
Table 176: Web Page Editor, General Properties Field Description Name (Required) Name for the page. This name is seen only by administrators in W-ClearPass Guest. Page Name Page name (filename) that will appear in the URL-- for example, "page_name". Enabled If selected, enables the page for use. Description Optional comments or notes about the page. Skin Specifies the skin to use for the Web page.
l "Email Receipts and SMTP Services" on page 433 l "Customizing SMS Receipt" on page 440 l "Customizing Print Templates " on page 442 Digital Passes Digital passes are cryptographically signed files containing fields and images that are used as boarding passes, event tickets, coupons, store passes, or other scannable items. In Dell Networking W-ClearPass Guest, you can upload and install digital pass certificates, create new templates for digital passes, and use the passes for guest receipts.
Figure 318 Example Digital Pass: A Boarding Pass Passes can be organized in Apple Passbook on the user's device. Good visual design practices ensure that each pass can be quickly recognized when displayed amongst other passes. (Apple Passbook is available on Apple iOS 6+ devices.) Dell Networking W-ClearPass Guest 6.
Figure 319 Example Apple Passbook To use a pass such as a membership card or store card, the user selects it from the passbook and displays it so the barcode can be scanned. To use a pass such as a boarding pass or event ticket where date relevance or location relevance was configured, it can be accessed when it becomes active on the lock screen at the relevant time or place.
Pass Templates The pass template defines what is written into the pass. You can create, edit, copy, and delete pass templates. For more information, see "Managing Digital Passes" on page 424 and "Creating and Editing a Digital Pass Template" on page 425. Pass templates define: l Name and a description: Used to identify the template in W-ClearPass administrative forms and views. l Style: Boarding Pass, Event ticket, Coupon, Store Pass, or Generic. l Colors: Foreground, background, and label.
Digital Passes Process Overview To obtain and install an Apple Passbook certificate: 1. Log in to the Apple Developer portal at developer.apple.com. 2. Register a Pass Type ID for your pass. 3. Create a certificate for your Pass Type ID. 4. Follow the portal’s instructions to create a certificate signing request using Keychain Access (a standard Mac OS X application) and submit it to the portal. 5. Download the Pass Type ID certificate. You also need to provide the private key for the pass certificate.
Figure 320 The Pass Certificate View If no pass certificate is installed yet, no details are displayed. Click the Upload pass certificate link to obtain and install a certificate. See "Installing Digital Pass Certificates" on page 423. Installing Digital Pass Certificates You must have a valid Pass Certificate issued by Apple in order to generate and download passes. To obtain a pass certificate, you first need an Apple developer account.
To install the certificate, go to Configuration > Receipts > Digital Pass Templates and click the Install Pass Certificate link. Step 1 of the Install Pass Certificate form opens. Figure 321 The Install Pass Certificate Form Table 177: Install Pass Certificate Field Description Format Specifies whether you will upload the certificate as a file or paste in the certificate text. The form expands to include the Step 2 options.
To view or work with your list of digital pass templates, go to Configuration > Receipts > Digital Pass Templates. The Pass Templates list view opens. Figure 322 The Digital Pass Templates List View Table 178: Pass Templates Field Description Edit Edit any of the template's properties. Copy Make a copy of the template to use as a basis for a new template. Reset to Defaults Resets the default template to its original settings if changes were made.
Defining Pass Properties Figure 324 The Pass Template Settings Form, Pass Properties Area For examples of variables that can be used in the Summary and Logo Text fields described in the following table, click the Example 'template code' replacements link above the form, or see "Example Template Code Variables" on page 431. For a list of image fields supported by each of the different pass styles, click the A note regarding images and icons link above the form, or see "Images in Digital Passes" on page 432.
Table 180: Pass Properties, Pass Template Settings Field Description Background Color Color used for the background of both the front and back of the pass. To use the default color, leave this field blank. Foreground Color Color used for the "values" field on the front of the pass. To use the default foreground color, leave this field blank. Label Color Color used for the labels of fields shown on the front of the pass. To use the default label color, leave this field blank.
Field Description Footer Image Image shown below all of the fields on the front of a Boarding Pass style of pass. To have no footer image, leave this field blank. If an "@2x" high-resolution version is available, it will also be added to the pass. Strip Image Image shown behind the primary field on the front of the pass. To have no strip image, leave this field blank. The strip image is only used on the Coupon, Event Ticket, or Store Card pass styles.
Field Description Move Up Fields are shown in this list in their rank order. You can use the Move Up and Move Down links to modify the order. Move Down Delete Deletes a field from this pass template. You will be asked to confirm the deletion. Add new field Lets you add and configure a new field. The row expands to include the Field Properties form.
If you set a relevant date for a Generic pass template, it must also include a relevant location. For examples of variables that can be used in the Date field described in the following table, click the Example 'template code' replacements link above the form, or see "Example Template Code Variables" on page 431.
that is compatible with the device. If the app is installed on the device, the link displayed on the pass opens the app. If the app is not installed on the device, the link opens the App Store at that app. Figure 328 The Pass Template Settings Form, Associated Apps Area Table 184: Associated Apps, Pass Template Settings Field Description Associated Apps If selected, shows an associated application on the back of the pass.
Figure 329 Template Code Variables Available for Digital Passes Images in Digital Passes To make images available for selection, they must first be uploaded to the Public Files area in Content Manager. The images supported by each style of pass are shown below. This images list is also available when you go to Configuration > Receipts > Digital Pass Templates, click the Edit or Create link, and then click the A note regarding images and icons link. 432 | Configuration Dell Networking W-ClearPass Guest 6.
Figure 330 Images Supported by Each Style of Pass Only PNG image files (*.png) are supported by passes. A pass can contain both a low-resolution version (i.e. for non-Retina displays) and a high-resolution version (i.e. for Retina displays) of each image. If it has been uploaded to the content manager, the high-resolution version of an image is also automatically included in the pass.
W-ClearPass Guest may be configured to automatically send email receipts to visitors, or to send receipts only on demand. Email receipts may be sent manually from the guest account receipt page by clicking the Send email receipt link displayed there. When using guest self-registration, the email delivery options available for the receipt page actions allow you to specify the email subject line, the print template and email format, and other fields relevant to email delivery.
Figure 332 The Customize Guest Registration Form, Email Delivery Area The options shown in Table 185 are available in the Enabled drop-down list to control email delivery. For more information on configuring these options, see "Editing Receipt Actions" on page 356. Table 185: Email Delivery Options, Customize Guest Self-Registration Field Description Disable sending guest receipts by email Email receipts are never sent for a guest registration.
Configuring Email Receipts You can configure the default settings used when generating an email receipt by going to Configuration > Receipts > Email Receipt. See "Email Receipt Options" on page 436 for details about the email receipt options. Email Receipt Options The Customize Email Receipt form may be used to set default options for visitor account email receipts. To configure email receipt options, go to Configuration > Receipts > Email Receipt. The Customize Email Receipt form opens.
Table 186: The Customize Email Receipt Form Field Description Subject Line May contain template code, including references to guest account fields. The default value, Visitor account receipt for {$email}, uses the value of the email field. See "Smarty Template Syntax" on page 700 for more information on template syntax. Email Receipt (Required) Specifies the plain text or HTML template to use for the email receipt.
Field Description Override From field is added to the form. To use the global From Address, do not select the check box in this field. Override From If selected, overrides the From Address instead of using the Reply-To value. Email Field (Required) Specifies the field that will contain the visitor's email address. Auto-Send Field (Required) Specifies the field that will cause an account receipt email to be automatically sent when a visitor account is created.
About Customizing SMTP Email Receipt Fields The behavior of email receipt operations can be customized with certain guest account fields. You do this on a per-user basis. Table 187: SMTP Email Receipt Fields Field Description smtp_enabled May be set to a non-zero value to enable sending an email receipt. If unset, the default value from the email receipt configuration is used.
n Depending on the value of the Send Copies setting, add the email addresses from the Copies To: list to the email’s “Cc:” or “Bcc:” list. l If there are any “To:”, “Cc:” or “Bcc:” recipients, generate an email message using the specified print template and send it to the specified recipient list.
Figure 335 The Customize SMS Receipt Form Table 189: Customize SMS Receipt Form Field Description SMS Receipt Specifies the plain text format print template to use when generating an SMS receipt. Options include: l l l Download Receipt SMS Receipt SMS Sponsor Confirmation Alert Phone Number Field Specifies the field that contains the guest’s phone number.
l sms_phone_field – This field specifies the name of the field that contains the visitor’s phone number. If blank or unset, the default value from the SMS plugin configuration is used. l sms_auto_send_field – This field specifies the name of the field that contains the auto-send flag. If blank or unset, the default value from the SMS plugin configuration is used. Additionally, the special values “_ Disabled” and “_Enabled” may be used to never send an SMS or always send an SMS, respectively.
Table 190: Guest Manager Print Templates List View Field Description Edit Edit the print template. The Edit Print Template page opens. See "Creating New Print Templates" on page 443. Duplicate Creates a copy of the print template that you can use as the basis of a new template. Delete Deletes the print template. You will be asked to confirm the deletion. Preview The template’s row expands to display a preview of the print template as the user would see it.
Figure 337 Template Code Variables Available for Print Templates This section is followed by the Create Print Template form used to configure the sections of the template: the body, the header and the footer. Each section must be written in HTML. You can use the drop-down list in each section to add images or other content items. 444 | Configuration Dell Networking W-ClearPass Guest 6.
Figure 338 The Create Print Template Form Table 191: Create Print Template Form Field Description Name (Required) Name for the print template. The name is used to select which template to use when printing a list of accounts. Enabled If selected, enables this print template for use. Layout (Required) Specifies how the guest account list will be printed when this template is used.
You can add Smarty template functions and blocks to your code. These act as placeholders to be substituted when the template is actually used. See "Smarty Template Syntax" on page 700 for further information on Smarty template syntax. You can use an {if} statement to define a single print template that caters to multiple situations.
Figure 339 The Print Template Wizard Dell Networking W-ClearPass Guest 6.
Table 192: Print Template Wizard Field Description Style (Required) Specifies the style of print template to use. Small thumbnail images are shown to indicate the basic layout of each style. Options include: l Table – Best for square or nearly square logo images, and well suited for use with “scratch card” guest accounts. l Simple – Best for wide or tall logo images and for situations where an operator will print a page with guest account details.
Table 192: Print Template Wizard(Continued) Field Description Notes Notes to display in the print template — for example, a welcome message or usage instructions. Footer Footer text to display on the print template. Print Template Preview Real-time preview of the print template as a guest would see it. Shows the changes you make in the wizard. Use the links above the wizard to change the position of the preview.
Table 193: Edit Print Template Permissions Form Field Description Object Name of the selected print template. The name cannot be edited. Owner Profile Name of the operator profile that will always have full access to the print template. Access Specifies who has access to this print template, and the level of permissions they have for it. Use the Entity and Permissions drop-down lists in this row to set permissions.
Table 193: Edit Print Template Permissions Form(Continued) Field Description l Full access (ownership) — The print template is visible in the list, and may be edited or deleted. The permissions for the print template can be modified, if the operator has the Object Permissions privilege. Delete To remove an entity from the list in the Access field, click anywhere in the entity’s row. A Delete link is displayed for that row. Click the Delete link to remove the entity’s row from the list.
updates. The address used now is clearpass.dell-pcw.com. If you have host-specific openings in your firewall for the W-ClearPass appliance, please update them to the new address. Viewing SMS Gateways A W-ClearPass Guest SMS service is automatically added when a subscription ID is configured in W-ClearPass. You can also add one, and work with existing gateways. To view and work with the list of SMS gateways, go to Configuration > SMS Services > Gateways. The SMS Gateways list view opens.
2. Click the Create new SMS gateway link in the upper right corner. The SMS Gateway Configuration form opens. To edit an existing SMS gateway: 1. Go to Configuration > SMS Services > Gateways. The SMS Gateways list view opens. 2. Click the gateway’s row in the list, and then click its Edit link. The SMS Gateway Configuration form opens. Figure 342 The SMS Gateway Configuration Form, Service Settings Area (Custom HTTP Handler selected as the gateway) Dell Networking W-ClearPass Guest 6.
The first part of the SMS Gateway Configuration form includes the Service Settings options: Table 195: SMS Gateway Configuration Form, Gateway and Service Settings Areas Field Description SMS Gateway (Required) If you are creating a new gateway, specifies the SMS gateway service to use. If you are editing an existing gateway, this field cannot be edited. Options include: l ClearPass Guest SMS Service l Custom HTTP Handler l SMS over SMTP l SMPP v3.
Field Description Number Format Specifies the country code requirement of the carrier. Options include: l Use the visitor’s value l Always include the country code l Never include the country code Port Number The port number used to reach the server. To use the default, leave this field empty. Service Method (Required) If Custom HTTP Handler was selected in the SMS Gateway field, select the HTTP method to use.
Field Description l l l l l l SSL Certificate SSL Passphrase NPI_E212 NPI_NATIONAL NPI_PRIVATE NPI_ERMES NPI_INTERNET NPI_WAPCLIENT Path of the uploaded SSL certificate (public/cert.pem). This must be in .pem format. Passphrase for the certificate specified in the SSL Certificate field. If there is no passphrase, leave this field blank. Confirm Passphrase Subject Line Text for the message’s subject line. This field supports Smarty template syntax.
The lower part of the SMS Gateway Configuration form includes the Connection Settings, Debug, and Test SMS Settings areas: Figure 344 The SMS Gateway Configuration Form, Connection Settings, Debug, and Test SMS Settings Areas Table 197: SMS Gateway Configuration -- Connection Settings, Debug, and Test SMS Settings Options Field Description Connection Timeout (Required) The connection timeout for this SMS service, in seconds.
Sending an SMS You can send an SMS message if the system has been configured to allow this. To send an SMS message: 1. Go to Configuration > SMS Services > Send SMS. The New SMS Message form opens. Figure 345 The New SMS Message Form Table 198: New SMS Message Form Field Description Service Service that will be used to send the message. If multiple services are available, you may specify the service to use. Recipient (Required) Mobile number of the recipient, in international format.
When credits are running low, a warning message is emailed to the administrator group. The email address is determined by looking up all local operators with the special IT Administrators operator profile, and using any configured email address for those operators. Up to three messages will be sent: l A low-credit warning is sent when the “Credits Available” value reaches the warning threshold (the default value is 50).
Figure 346 The SMS Receipt Form When using guest self-registration, SMS Delivery options are available for the receipt page actions. See "Editing Receipt Actions" on page 356 for full details. For more information on SMS services, see "SMS Services" on page 451. About SMS Receipt Options SMS receipt configuration options are available in the Configuration module (see "Customizing SMS Receipt" on page 440).
To view or work with the mobile carriers list, go to Configuration > SMS Services > Mobile Carriers. The Mobile Carrier List view opens. The carriers in this list are the ones that are included in the Mobile Carrier drop-down list on the SMS Services > Gateways > Edit SMS Gateway form. Figure 347 The Mobile Carrier List View Table 199: Mobile Carrier List View Field Description Quick Help Displays some information about the SMS SMTP carrier list and about how to use the Mobile Carrier List view.
Table 199: Mobile Carrier List View(Continued) Field Description Edit Edit the carrier. The row expands to include the Mobile Carrier Editor form for that carrier. See "The Mobile Carrier Editor Form" on page 462, below. Enable To enable a carrier, click the Enable link in its row and then refresh the screen. The carrier will then be available to work with and will be included in the drop-down lists when you click the Display Lists link.
Table 200: Mobile Carrier Editor Form(Continued) Field Description SMS Template (Required) Example email address for SMS messages. This provides the pattern for the address format. The default is to substitute the number for all characters preceding the @ sign, producing the pattern number@address. Use the keyword “NUMBER” where appropriate, otherwise everything after the @ sign will be used. Some carriers require additional characters before or after the phone number.
l To set the default language, show IDs for labels and messages, and provide a language selector on each page of the user interface, see "Translation Assistant" on page 466. l To customize a translation pack's labels and messages, see "Customizing Translated User Interface Text" on page 467. l To view the Translation Plugin settings, see "Configuring the Translations Plugin" on page 659 in the Administration module.
Creating and Editing Translation Packs To create or edit a translation pack: Go to Configuration > Translations > Translation Packs, then click the Edit or Duplicate link for a translation pack in the list. The Translation Pack Configuration Form form opens. Figure 350 The Translation Pack Configuration Form Table 202: Translation Pack Configuration Field Description Parent Name of the translation pack you used as a basis.
Field Description Locales Comma-separated list of locale identifiers for this language pack. Locale identifiers let you customize translation packs for regional differences. RTL If selected, specifies that this language displays text right-to-left. Save Changes Saves your changes and returns to the Translation Packs list view. Translation Assistant To configure some basic user assistance features for the user interface's language settings, go to Configuration > Translations > Translation Assistant.
Figure 352 The Translation Assistant Form with Text IDs Showing Table 203: Translation Assistant Configuration Field Description Default Language Specifies the default language pack for the user's application. Auto-Detection If selected, disables automatic browser-based language detection and enforces the default translation pack instead. The default behavior is to use the language the user's browser has detected as preferred, instead of using the default translation pack.
Figure 353 The Translation Pack Configuration Form l Go to Configuration > Translations > Translation Assistant. Select the language, select the check box in the Text IDs field, and save your changes. Text IDs are shown with every label, and an Override all translations generated for this page link is now displayed at the bottom of every page in W-ClearPass Guest.
Figure 354 The Translation Pack Configuration Form with Text IDs Showing Table 204: The Translation Pack Configuration Form Field Description Name Display Name Language Code These fields show the information for this translation pack and cannot be edited on this form. Locales Enabled If selected, enables this translation pack. If this translation pack should not be enabled at this time, leave this check box unselected.
Field Description l If you accessed this form from the Override all translations generated for this page link at the bottom of any page in W-ClearPass Guest, this field contains a list of all the text IDs for that page and related pages and messages. Common IDs Each link in this field corresponds to a group of related pages and messages. Click a link to display the text IDs for all labels and messages in that group.
Chapter 6 Advertising Services Advertising Services lets you deliver marketing promotions and advertisements to your users on a variety of Guest Management registration, receipt, and login pages. To work with W-ClearPass Guest Advertising Services, go to Configuration > Advertising > Start Here.
Promotions can also be configured to use intelligent delivery, which uses labels to match relevant advertising to users. Materials and promotions are then organized into advertising campaigns that run over a specified date range and with a specified priority (rank and weight). Campaigns An advertising campaign is the strategy by which you organize the presentation of your ads. It defines which promotions and materials to deliver, and when they should be delivered.
Figure 355 The Advertising Services Getting Started Tutorial Topics in the tutorial cover how to create materials, promotions, and campaigns and configure spaces. You can view the finished product of the practice exercises. Tips are provided on how to troubleshoot the different stages of the process.
Advertising Pages The Advertising Pages form lists the Guest Manager areas whose pages can be used for advertising, and provides access to advertising configuration for them. In W-ClearPass Guest, these pages include login, registration, receipt and self-service pages, and email and SMS receipts. To work with the advertising settings for a Guest Manager page group or page, go to Configuration > Advertising > Pages. The Advertising Pages list view opens.
You can click a page group in the Advertising Pages list for additional options: Table 207: Advertising Pages List Field Description Edit Edit the advertising settings for any of the pages in the Guest Management or Self-Registration page groups. See "Editing Advertising Pages" on page 475. Go To Opens the corresponding area of the W-ClearPass Guest application: For Guest Management, opens the Start page of the Guest Manager module.
If you leave the Edit Page form set to the parent page, your edits will apply to the parent page of the group and to all the child pages in the group. To override these settings for a child page, you must click Show Children, and then click the Page advertising settings link for the child page. Table 208: General Properties, Edit Page Field Description Page The page group being edited.
In the Space Options area of the form, set the options that control which advertising spaces can be shown on this page. The final set of advertising spaces that is used is determined by first applying the Allowed Spaces policy, and then applying the Denied Spaces policy. Table 209: Space Options, Edit Page Field Allowed Spaces Policy Description Specifies which spaces to use.
Figure 359 The Edit Page Form, Campaign Options Area In the Campaign Options area of the form, set the options that control which campaigns can deliver advertising on this page. The final set of advertising campaigns that is used is determined by first applying the Allowed Campaigns Policy, and then applying the Denied Campaigns Policy. 478 | Advertising Services Dell Networking W-ClearPass Guest 6.
Table 210: Campaign Options, Edit Page Field Allowed Campaigns Policy Description Specifies which campaigns to use. Options include: Use default setting (Allow advertising from all campaigns) — Allows advertising from all enabled and applicable campaigns. Available for page group only. l Allow advertising from... — The form expands to include the Allowed Campaigns row. Available for page group only.
l Support Smarty Template evaluation l Belong to pages that support advertising The nwa_adspace tag supports the following parameters: l location l name l media l stage l container l style location The value of the Location field that must be set for an advertising space to be matched by location. The Location field and the Other Location field are configured on the Edit Space form (see "Creating and Editing Advertising Spaces" on page 484). You must specify either a location or a name.
Value Description sms_top SMS Top—above content sms_bottom SMS Bottom—below content Use Other Location Other—for user-defined locations name The value of the Name field that must be set for an advertising space to be matched by name. You must specify either a location or a name. The nwa_adspace tag will give an error if you do not specify at least one of these parameters.
Table 213: Values for the stage Parameter Value Description web_login Specify this value to deliver advertising on a login page (landing page). web_registration Specify this value to deliver advertising on a guest selfregistration page. web_receipt Specify this value to deliver advertising on a receipt page. web_self_service Specify this value to deliver advertising on a guest selfservice page. web_after_login Specify this value to deliver advertising on a login message page (post-login page).
include typical uses of the space. Several built-in spaces are available. You can also create new custom advertising spaces. To work with the settings for advertising spaces, go to Configuration > Advertising > Spaces. The Advertising Spaces list view opens. Figure 360 The Advertising Spaces List View All advertising spaces that have been created are included in this list. You can click a space's row in the list for additional options.
Field Description Disable To make advertising inactive again for an enabled space, click the Disable link. Copy Make a copy of the space configuration to use as a basis for a new configuration. Suggestion: If you want to have multiple advertising spaces in the same location—for example, one for images and one just for text—creating a copy of a space and making slight changes to it might be the simplest way. Create new advertising space Create a new custom advertising space.
Figure 361 The Edit Space Form, General Properties Area In the General Properties area of the form, set the basic properties for the space: Table 215: General Properties, Edit Space Field Description Name (Required) Name that clearly identifies this space. For a built-in space, this cannot be edited. Enabled If selected, allows advertising to be shown in this space. If this check box is not selected, the space will not show any advertisements.
Field Description Description Optional comments or notes about this advertising space. Location Describes position of the space on the page. For a built-in space, this cannot be edited. For custom spaces, options include: l l l l l l l l l Other Location None - for manually positioned spaces — Select this option if you will use the nwa_ adspace Smarty Template tag, and to only specify the name parameter, not the location parameter.
Figure 362 The Edit Space Form, Geometry Area In the Geometry area of the form, set the options that control the width and height of the space. Some devices, such as desktop computers and laptops, have a large screen. Other devices, such as smart phones, have a small screen. Although it is possible to deliver large advertisements to small screens, it does not provide the best user experience.
Table 216: Geometry Options, Edit Space Field Description Screen Types Limits the types of screen that will show this space. This setting only applies to Web advertising. Options include: l All Screens — show on both small and large screens — Ignores the detected screen type. l Small Screens — show on small screens only (phones; mobile devices) — This space will only be shown if the user's device is detected to be a small-screen device.
l Three rows with heights 30, 30, and 30 l Two rows with heights 60 and 40 l Two rows with heights 50 and 50 l One row of height 80 l One row of height 100 "Maximum Width" Example If a maximum width was specified, the system will only output as many columns as will fit within the maximum width constraint for the space.
When you have completed your entries on this form: l If you are creating a new space, click Create to create the new space and return to the Advertising Spaces list, or click Create and Reload to create the new space and reload the Edit Space form. l If you are editing an existing space, click Save to save your changes and return to the Advertising Spaces list, or click Save and Reload to save your changes and reload the Edit Space form.
Field Description Disable Disable the campaign. To make the campaign active again, click the Enable link. Copy Make a copy of the campaign's settings to use as a basis for a new campaign. Create new advertising campaign Create a new advertising campaign. Creating and Editing Advertising Campaigns An advertising campaign is the strategy by which you organize the presentation of your ads. It defines which promotions and materials to deliver, and at which stages they should be delivered.
The Edit Campaign and Create Campaign forms are identical, and are described below. Figure 365 The Edit Campaign Form, General Properties Area In the General Properties area of the form, set the basic properties for the campaign: Table 219: General Properties, Edit Campaign Field Description Name (Required) Name that clearly identifies this campaign. Enabled If selected, allows promotions from this campaign to be delivered. If this check box is not selected, no ads will be provided from this campaign.
At the time ads are delivered on your pages, the system processes the information in the General Properties area in the following order: 1. Verifies which campaigns are enabled and ignores ones that are not. 2. Checks for start dates that are less than or equal to "now" and ignores campaigns that are not scheduled to start yet. 3. Checks for end dates that are greater than "now" and ignores campaigns whose end date is past. 4. Checks the rank of each remaining campaign.
Field Description With SelfService Specifies the promotion to deliver on the self-service portal pages. To not display ads at this stage, select None. After Login Specifies the promotion to deliver when the user has logged in. To not display ads at this stage, select None. With Receipt Specifies the promotion to deliver on the SMS registration receipt. To not display ads at this stage, select None. Campaign Rank and Weight Each advertising campaign must be assigned a rank and weight.
Figure 367 The Advertising Promotions List View All advertising promotions that have been created are included in this list. You can click a promotion's row in the list for additional options. Table 221: Advertising Promotions List Field Description Edit Lets you edit any of the promotion's properties. See "Creating and Editing Advertising Promotions" on page 495. Delete Deletes the promotion from the system. You will be asked to confirm the deletion.
To edit an advertising promotion, go to Configuration > Advertising > Promotions, then click the Edit link for a promotion. The Edit Promotion form opens. Figure 368 The Edit Promotion Form, General Properties Area In the General Properties area of the form, set the basic properties for the promotion: Table 222: General Properties, Edit Promotion Field Description Name (Required) Name that clearly identifies this promotion. Enabled If selected, allows this promotional to deliver ads.
Field Description Description Optional comments or notes about this promotional material. Labels To apply labels to this promotion, enter the labels in this field. To create new labels, enter the new label names separated by commas or new lines. The system creates each new label as a "tag". If some labels were already created, clicking in this field displays a list of the existing label tags to choose from. If you include labels here, other promotions will detect this promotion as labeled content.
Table 223: Rotating, Fixed, Weighted, or Labeled Content, Edit Promotion Field Description Content For fixed content, select a single content item for the promotion. Content Items (Required) For rotating or weighted content, all items in this list are initially selected. Click an item's row to access controls for removing items or changing their order. Content Types (Labeled content) Types of content to include in this promotion.
Figure 370 The Edit Promotions Form, Intelligence Area In the Intelligence area of the form, set the options that control intelligent delivery of content for the promotion: Table 224: Intelligence Options, Edit Promotion Field Description Enabled If selected, allows a more selective delivery by matching user labels to material labels. (Material also inherits labels from the promotions that include it) Requirement Levels How often the specified labels should be matched.
2. In the Edit Promotion form, use the Labels field to apply or easily create labels that correspond to the information-gathering fields you added to your pages (see "Creating and Editing Advertising Promotions" on page 495). 3. Configure the promotion to use labeled content (promotions, materials, or both), and specify which labels to include or exclude. 4. Also on the Edit Promotion form, enable the promotion for intelligent delivery. Indicate the percentage of ads that should match the labels.
Figure 372 The Advertising Materials List View All advertising materials that have been created are included in this list. You can click a material's row in the list for additional options. Table 225: Advertising Materials List Field Description Edit Lets you edit any of the material's properties. See "Creating and Editing Advertising Materials" on page 501. Delete Deletes the material from the system. You will be asked to confirm the deletion. Disable Disables the material.
Figure 373 The Edit Promotional Material Form, General Properties Area In the General Properties area of the form, set the basic properties for the material: Table 226: General Properties, Edit Promotional Material Field Description Name (Required) Name for this material. Enabled If selected, allows this material to be delivered. Start Date Date and time on which this campaign will begin. To start delivering this material immediately, leave this field blank.
Figure 374 The Edit Promotional Materials Form, Web Content Area Depending on the selection in the Type field, the next area of the form will be either SMS Content or Web Content. In this area, set the options that control either the content of the SMS text messages promotion, or the content and formatting of the Web promotion. Table 227: SMS Content or Web Content, Edit Material Field Description Text (SMS content) Enter the message text. To keep messages short, use 80 characters or fewer.
Field Description Image (Image advertisement) The image file for the advertisement. Either select a file that is already uploaded to Content Manager, or upload a new file. Maximum file upload size is 15.0 MB. Title (Image advertisement; Text advertisement) Specify alternative text for the image. For a text advertisement, the title is shown as the first line of the ad; if a hyperlink is also specified, the title is clickable. Preview (Image advertisement) Preview of the selected advertisement.
Chapter 7 Hotspot Manager The Hotspot Manager controls self-provisioned guest or visitor accounts. This is where the customer is able to create his or her own guest account on your network for access to the Internet. This can save you time and resources when dealing with individual accounts. Accessing Hotspot Manager To access Dell Networking W-ClearPass Guest’s hotspot management features, go to Configuration > Hotspot Manager. Dell Networking W-ClearPass Guest 6.
About Hotspot Management The following diagram shows how the process of customer self provisioning works. Figure 375 Guest Self-Provisioning 1. Your customer associates to a local access point and is redirected by a captive portal to the login page. 2. Existing customers may log in with their Hotspot username and password to start browsing. New customers click the Hotspot Sign-up link. 3. On page 1, the customer selects one of the Hotspot plans you have created. 4.
The Hotspot Preferences form opens. This form allows you to change user interface options and set global preferences for the self-provisioning of visitor accounts. Figure 376 The Hotspot Preferences Form Dell Networking W-ClearPass Guest 6.
Table 228: Hotspot Preferences Field Description On/Off Switch If selected, enables self-provisioning for guest access. Require HTTPS If selected, requires an HTTPS connection for guests creating hotspot accounts, providing greater security. The guest is redirected to the HTTPS connection. User Database (Required) Service handler used to create self-provisioned guest accounts. Transaction Processing (Required) Service handler used to process hotspot transactions.
Captive Portal Integration To start the visitor self-provisioning process, new visitor registration is performed by redirecting the visitor to the URL specified on the Hotspot Preferences page; for example: https://guest.example.com/hotspot_ plan.php. The Hotspot Sign-Up page opens to the first page of the wizard, Choose Plan. The hotspot_plan.php page accepts two parameters: l The source parameter is the IP address of the customer.
The Manage Hotspot Plans list view opens, showing the list of default plans. Plans that are enabled have their name in bold and their icon in color: . Plans that are not enabled have their icon in gray: . Figure 377 The Manage Hotspot Plans List View Table 229: Manage Hotspot Plans List View Field Description Edit Let you edit an existing plan. See "Editing or Creating a Hotspot Plan" on page 510. Delete Lets you delete an existing plan. You are asked to confirm the deletion.
Figure 378 The Edit Hotspot Plan Form, Plan Details Area The Plan Details area of the form lets you configure items that are displayed to the user in the user interface and customer invoice. Table 230: Edit Hotspot Plan Form, Plan Details Area Field Description Plan Name Name for this plan. Users select a hotspot plan on the strength of the name, so choose a name that helps the user clearly identify your service. Avoid names that might be difficult for the user to identify and trust.
In the User Account Details area, you can specify the usage of numbers, letters, and symbols in the generated username and password, and specify a role for accounts. Table 231: Edit Hotspot Plan Form, User Account Details Area Field Description Generated Username (Required) Lets you format the combination of numbers, letters, and symbols in the generated username. To use the customer’s email address as the username, leave this field empty. To use only digits, leave the value set to ######.
Figure 380 The Edit Hotspot Plan Form, Time & Cost Details Area In the Time & Cost area, you can specify the time and cost of each unit. A unit is the amount of time purchased, as defined in the Time Tracking field. Table 232: Edit Hotspot Plan Form, Time & Cost Details Area Field Description Time Tracking l Unit Cost (Required) Cost for a single unit of this plan. To create a free access plan, enter 0. Minimum Units (Required) Minimum number of units that can be purchased.
Table 232: Edit Hotspot Plan Form, Time & Cost Details Area(Continued) Field Description Unit Time (Required) The length in time, in seconds, of a single unit of this plan. One hour = 3600 One day = 86400 ONe week = 604800 Unit Name The name used to describe one or more units of this plan. Update Plan Saves the plan and opens the Manage Hotspot Plans list with the new plan displayed.
Figure 381 The Hotspot Transaction Processors List View Table 233: Hotspot Transaction Processors List View Field Description Edit Lets you change the properties of the specified transaction processor. The Transaction Processor Configuration form opens. For more information, see "Creating a New Transaction Processor " on page 518. Delete Deletes the processor from the Hotspot Transaction Processors list. You will be asked to confirm the deletion.
Occupied Room List To view all current room reservation details, click the Rooms link for a transaction processor at Configuration > Hotspot Manager > Transaction Processors. The Occupied Room List page opens. This view-only page displays information about transaction events for the selected processor, and all rooms that are currently reserved or transactions that are in progress are included in the list. All data is shown in real time.
Table 234: Occupied Room List, Transaction Processors (Continued) Field Description First Name The guest’s first name. Last Name The guest’s last name. Reservation The reservation number. Purchase The purchase status. Date The date of the transaction. Arrive The date the guest will arrive. Depart The date the guest will leave.
Table 235: Hotspot Transaction Processors, Confirm Transaction Processor Sync Form (Continued) Field Description processor until the results of the previous request are received. If there are multiple transaction requests in the queue, each one must be processed in turn. Clear Clears the existing room data. Options include: Re-Synchronize all room details — Clears all current room data and any queued transactions. Clear the current pending command — Clears only the currently pending transaction.
Table 236: Transaction Processor Configuration(Continued) Field Description Confirm Password API Username (Required) The API username for this transaction processor. Auto Email If selected, passes along the flag to directly email the customer from Authorize.Net. Beagle AntiFraud if selected, enables Beagle GEO Anti-Fraud. Business Center Login URL for logging in to the business center. Character Set The character set this transaction processor’s server is using when sending text.
Table 236: Transaction Processor Configuration(Continued) Field Description Installation ID The installation ID to use when starting a transaction with this transaction processor. Item Code (Required) The item code for the Wi-Fi service. Keep Alive Specifies whether and how to send periodic keepalive commands to the FIAS server. May be needed in scenarios where room updates are infrequent, or other networking devices such as switches or firewalls might drop connections.
Table 236: Transaction Processor Configuration(Continued) Field Description Center ID Secret (Required) The Wirecard secret. Confirm Secret Service URL The URL for this transaction processor’s server. Shared Secret The MD5 shared secret to use for securing the transaction. Up to 16 characters are allowed. This must be the same as the “MD5 secret for transactions” that was configured in the transaction processor’s administration interface. Shop ID The Wirecard shp ID, if you have one configured.
Managing Customer Information You can customize the fields that the customer sees, the details of these fields, and the order in which they are presented. To customize the fields, go to Configuration > Hotspot Manager > Start Here and click the Manage Hotspot Customer Information link. The Customize Form Fields view opens for the customer information form. See "Customizing Forms and Views" on page 303 for instructions for completing the form field editor.
To customize the hotspot invoice, go to Configuration > Hotspot Manager > Start Here and then click the Manage Hotspot Invoice link. The Manage Invoice form opens. Figure 385 The Manage Invoice Form Dell Networking W-ClearPass Guest 6.
Table 237: Manage Invoice Form Field Description Invoice Title (Required) HTML template code used to display the title on the customer’s invoice. For more information, see "Basic HTML Syntax" on page 697 Invoice Numbering (Required) Specifies the method used to generate invoice numbers. Options include: Default numbered format l Sequential numbering from 1 l Specify format using template l Invoice Number Expression that describes the invoice number format.
Figure 386 Example Choose Plan Page To customize how this page is displayed to the guest, go to Configuration > Hotspot Manager > Start Here, click the Manage Hotspot Sign-Up link, and then click the Customize page 1 (Choose Plan) link in the upper-right corner. The Edit Hotspot Plan Selection Page form opens. You can use this form to edit the title, introductory text, and footer of the “Choose Plan” page. The introduction and the footer are HTML text that can use template syntax.
Figure 387 The Edit Page Form, Step 1: Choose Plan Table 238: Edit Page Form, Step One: Plan Selection Page Field Description Page Title (Required) Title for the page where the guest selects a plan. Introductory HTML HTML code for the text to display at the top of the page, above the list of hotspot plans. Footer HTML HTML code for the text to display at the bottom of the page, below the list of hotspot plans.
Customizing Visitor Sign-Up Page Two Page two of the guest self-provisioning process asks the guest to provide their personal details and payment method. The example below shows the default “Your Details” page if the customer chooses to pay for the Hourly Access plan.
The example below shows the default “Your Details” page for a customer who chooses the Free Access plan. Figure 389 Example “Your Details” Page Shown to Customer, Free Access Plan To customize how the “Your Details” page is displayed to the guest, go to Configuration > Hotspot Manager > Start Here, click the Manage Hotspot Sign-Up link, and then click the Customize page 2 (Customer Details) link in the upper-right corner. The Edit Hotspot User Details Page form opens.
Figure 390 The Edit Page Form, Step 2: Customer Details Dell Networking W-ClearPass Guest 6.
Table 239: Edit Page Form, Step Two: User Details and Payment Page Field Description Page Title (Required) Title for the page where the guest enters their personal information and payment method. Introductory HTML HTML code for the text to display at the top of the page, above the guest’s personal information. Footer HTML HTML code for the text to display at the bottom of the page, below the guest’s personal information.
Customizing Visitor Sign-Up Page Three Page three of the guest self-provisioning process provides the customer an invoice containing confirmation of their transaction and the details of their newly created wireless account. An example of the default receipt page is shown below.
Figure 392 The Edit Page Form, Step 3: Invoice or Receipt Table 240: Edit Page Form, Step Three: Receipt Page Field Description Page Title (Required) Title for the guest’s receipt page. Introductory Text HTML code for the text to display at the top of the page, above the guest’s invoice details. Footer Text HTML code for the text to display at the bottom of the page, below the guest’s invoice details.
2. Select the check box in the Hotspot row to enable hotspot registration for the self-registration page. 3. Complete the self-registration configuration. See "Creating a Self-Registration Page" on page 346. 4. Return to Configuration > Pages > Guest Self-Registrations and click the page’s row in the list. 5. Click one of the following links: l The Go to Portal link opens an active preview of the self-service login page and form as the guest would see it.
| Hotspot Manager Dell Networking W-ClearPass Guest 6.
Chapter 8 Administration The Administration module provides tools used by a network administrator to perform both the initial configuration and ongoing maintenance of Dell Networking W-ClearPass Guest. Accessing Administration To access Dell Networking W-ClearPass Guest’s administration features, click the Administration link in the left navigation. Dell Networking W-ClearPass Guest 6.
Figure 393 The Administration Module’s Left Navigation AirGroup Services This section describes creating and managing AirGroup controllers and configuring the AirGroup plugin, and provides links to other AirGroup steps performed in Dell Networking W-ClearPass Guest. For an overview of AirGroup functionality, see "AirGroup Deployment Process" on page 28.
l "AirGroup Time-Based Sharing Syntax Examples" on page 85 l "Creating AirGroup Administrators" on page 543 l "Creating AirGroup Operators" on page 544 l "Authenticating AirGroup Users via LDAP " on page 544 l "Configuring LDAP User Search for AirGroup" on page 544 AirGroup Controllers You can create and manage multiple AirGroup controllers. You may configure each controller's remote access and other information, poll the current configuration, and view configuration details.
Field Description Read Configuration Polls the AirGroup controller's current configuration. A progress bar is shown during the polling action. When the poll is complete, you can click Show Details to review the updated configuration details for the roles, AP groups, and AP database. For information on setting an automatic polling schedule, see "Configuring AirGroup Services" on page 638. Create Controller Lets you create a new AirGroup controller. The Create AirGroup Controller form opens.
Figure 396 The Create Controller Form Table 242: Create AirGroup Controller Field Description Name Short name that identifies the controller clearly. AirGroup controller names can include spaces. Description Additional useful information about the controller. Enabled Enables Policy Manager's AirGroup notification service for the controller.
Field Description SSH Username SSH username for accessing the controller. SSH Password SSH password for accessing the controller. The minimum password length is six characters. Enable Password The enable password for the controller. SSH Timeout Timeout limit in seconds for reading the configuration. The default is 15 seconds.
Table 243: Configure AirGroup Services Field Description Exclusions Role names, AP group names, or AP names that should not be displayed in the AirGroup user interface. Enter each item on a separate line. Entries are not case-sensitive. To add a comment, enter it on a separate line that begins with the "#" character. Polling If selected, schedules automatic polling of AirGroup controller configuration. The form expands to include scheduling options.
Field Description Timeout Number of seconds after which an attempt to send an AirGroup message will time out. Attempts Maximum number of times the system should attempt to send an AirGroup message. AirGroup Logging Specifies the logging level.
Table 244: AirGroup Diagnostics Field Show information about a device Description Enter the device's MAC address. Information shown includes: Device information (as entered on Guest > Create Device) l Controller IP address and AirGroup protocol version l Hostname of associated server, management IP address, and role l Times of AirGroup authorization requests along with controller IPs and enforcement profiles l Show information about a controller Enter the controller's IP address or hostname.
Creating AirGroup Operators AirGroup Operators are users of Dell Networking W-ClearPass Guest who can provision a limited number of their own personal devices. Each device provisioned by an operator is automatically shared with all of that operator’s provisioned devices. The operator can also define a group of other users who are allowed to share the operator’s devices. The AirGroup Operator profile is automatically created in W-ClearPass Guest when the AirGroup Services plugin is installed.
Figure 399 LDAP User Search Components User Search Workflow for AirGroup The workflow for a typical user search operation is: 1. The user of the AirGroup portal starts typing a username. This triggers a dynamic request to W-ClearPass Guest. 2. W-ClearPass Guest performs a search operation against the configured LDAP server. 3. Search results are returned to the portal user, who can then select from one of the matching item, or continue typing to further narrow the search.
Figure 400 The Server Configuration Form In the basic properties and Operator Logins areas of the Server Configuration form: Table 245: Edit Authentication Server, Basic Properties Field Description Name (Required) Name for the LDAP server. Priority (Required) Priority rank of the service handler for authentication of local operators. The lowest number has the highest priority. Server Type (Required) Specifies the type of server to connect to. Server URL (Required) The LDAP URL of the server.
User Search Settings for AirGroup Figure 401 The Server Configuration Form, User Search Area In the User Search area of the Edit Authentication Server form: Table 246: Edit Authentication Server, User Search Field Description Enabled If selected, the server will be used to search for matching users. The form expands to include additional options. Filter (Required) Filter methods. Options include: l Use the default LDAP filter—Uses an LDAP filter suitable for an Active Directory search operation.
Field Description text. Comments may be entered in this field by starting a line with the “#” character. Sort By Specify the name of an attribute on which to order the search results. Otherwise, the default value of displayName orders the results by the user's full name. Maximum Results (Required) Limits the total number of search results that can be displayed.
Figure 403 The Define Custom Field Form, Default Form Display Properties Area Use the Default Form Display Properties area of the form to set the field type and enable search: Table 247: Default Form Display Properties, Relevant Fields Field Description User Interface Type of user interface element to use for this field. Select Multiple selection list from this dropdown list. Searchable Select the Enable searching and advanced UI check box in this row.
Table 248: Advanced Properties, Relevant Fields Field Description Advanced Select the Show advanced properties check box. Additional configuration options are added to the form. Select2 Options Used to customize the user interface for the “select2” control, which provides both single and multiple-selection capabilities. Default values are preconfigured for these fields. These defaults are intended for use with user search. However, the ajax.args.
Option Description ajax.url = NwaAirGroupUserSearchAjax Specifies that the field should perform a user search. This parameter should not be changed. ajax.args.server = … Specifies the name of the LDAP server that should be searched. This parameter must match the name of the LDAP server that was created, or else the search operation will fail. ajax.quietMillis = 500 Specifies that the user search operation should be performed after half a second (500 ms).
A simple example is included as the default value with the airgroup_shared_user field: function (args) { args.formatInputTooShort = function (text) { return "Start typing a user name."; }; return args; } The functions that may be defined by the “Select2 Hook” function shown in the following table: Table 251: Select2 Hook Functions Function Description sortResults(results, container, query) Used to sort the results list for searching right before it is displayed.
l As with other W-ClearPass Guest forms and views, the MACTrac user interface can be customized by adding a custom skin or options such as an "Add Another Device" button.
Table 252: Add Local User Form in Policy Manager Field Description User ID The MACTrac operator's username. Name The MACTrac operator’s name. Password Password for the MACTrac user. The minimum password length is six characters. Verify Password Enable User If selected, enables this MACTrac operator. The new operator is enabled by default. If the operator is not to be activated until a later time, you may deselect this check box. Role Specifies the operator’s role.
Figure 406 The MACTrac Devices List View Dell Networking W-ClearPass Guest 6.
All MACTrac devices that have been registered are included in the list. You can click a device account's row in the list for additional options: Table 253: MACTrac Devices List View Field Description Edit Lets you edit any of a device account's attributes. The Edit MACTrac Device form opens. The process for editing a device account is the same as for creating the account. For more information, see "Registering MACTrac Devices " on page 557. Print Lets you print a copy of the device account's details.
Table 253: MACTrac Devices List View(Continued) Field Description Registering MACTrac Devices The Register Device form is used by MACTrac operators to create their device accounts on their local network. There is no limit to the number of accounts a MACTrac operator can create, and no expiration time is set on device accounts. To register a MACTrac device, log in to W-ClearPass Guest as a MACTrac operator and go to Guest > Create Device. The Register Device form opens.
Table 254: Register Device Form, MACTrac Devices Field Description MAC Address (Required) The MAC address of the MACTrac device is prepopulated for the user. This is enabled in the Mobility Controller. For more information, see "Automatically Supplying the MACTrac Device Address" on page 558. Device Name Name for the MACTrac device. Device Type The type of device (computer, printer, or other device type). This value is prepopulated if detected.
Figure 408 Setting MACTrac Prepopulation Options in the Mobility Controller API Services API Services includes all APIs and API-related privileges that are available for W-ClearPass Guest. To work with API services, go to Administration > API Services.
To work with API clients, go to Administration > API Services > API Clients. The API Clients list view opens. Figure 409 The API Clients List View All API clients that have been created are included in the list. You can click an API client's row in the list for additional options: Table 255: API Clients List Options Field Description Edit Lets you edit theAPI client's attributes. The Edit API Client form opens. For more information, see "Creating and Editing API Clients" on page 561.
Creating and Editing API Clients To create or edit an API client, go to Administration > API Services > API Clients and either click the Edit link for an API client in the list, or click the Create API client link in the upper-right corner. The Edit API Client or Create API Client form opens. The procedure is the same for both forms. Figure 411 The Create API Client Form Table 256: Create API Client Field Description Client ID (Required) Name for the API client. Enter a unique string.
Field Description l l l l l Null Profile Operations and Marketing Read-only Administrator Receptionist Super Administrator Grant Type (Required) Specifies the OAuth2 grant type authentication method to be used with this API client ID. Only the selected authentication method will be allowed.
API Explorer The API Explorer provides access to various APIs used for configurations in Guest and Onboard. To see the APIs, go to Administration > API Services > API Clients and click the API Explorer link. The API Explorer opens.
Setting API Privileges in Operator Profiles To use W-ClearPass Guest's API services, the API privileges must be set up in the user's operator profile. Existing operator profiles that have the Administrator privilege set to Full Access must be updated to specifically include the appropriate privilege in order for XML-RPC clients to work. To set up API privileges: 1.
l Full l Allow Access 5. If you want to allow the API operator profile to query for Guest Manager configuration settings, set the Manage Customization privilege to Read Only access. 6. Complete the rest of the settings appropriately for the operator profile and then click Save Changes. For more information, see "Creating an Operator Profile" on page 673. About OAuth The OAuth 2 RFC 6749 specification for accessing a new set of modern API’s is supported by W-ClearPass 6.4 and later.
Resource Server The resource server is the server hosting the resources. For example, either a platform such as Facebook or a W-ClearPass Server could be considered a resource server. It is essentially the server hosting the protected content that will be accessed via the APIs. Client Application The client application is the application requesting access to the protected resources stored on the resource server.
Authorization Grant Types for OAuth OAuth 2 provides several "grant types" for different use cases. W-ClearPass supports the following defined grant types: l Password— For logging in with a username and password l Client credentials— For application access Resource Owner Password Grant Type OAuth 2 also provides a password grant type, which can be used to exchange a username and password for an access token directly.
5. The resource server returns the authenticated API payload. Client Credentials Grant Type The simplest grant type offered by OAuth2 doesn’t include a 3rd party user at all and is essentially intended for server-to-server integrations for updating the application server configuration. In this case, applications need a way to get an access token for their own user and need to do this outside the context of any specific user. OAuth provides the client credentials grant type for this purpose.
account, and user consent is not required. (In non-service-account scenarios, your application calls Google APIs on behalf of end-users, and user consent is sometimes required.) SOAP Web Services and API SOAP Web Services provide a way of transferring data across the Internet to integrate Web-based applications. Web services let businesses share data and processes programmatically, and can be added to a user interface to provide functionality.
Figure 417 The SOAP Web Services List with a Service Selected 3. The Service Info field briefly describes the processes this Web service provides. In the Service URL field, you can click the link to view the Web Service Description Language (WSDL) that defines that service. The WSDL opens in a new tab. Figure 418 The Web Service Description Language (WSDL) for a Service 4. When you have finished reviewing the available Web services, click Done. 570 | Administration Dell Networking W-ClearPass Guest 6.
SOAP API Introduction The SOAP interface is available to third-party applications that will integrate with the W-ClearPass Guest Visitor Management Appliance. Audience This API is intended for developers of applications that must interoperate with a W-ClearPass Guest-based visitor management solution.
Figure 419 Layers of Software in W-ClearPass Guest l At the lowest level, the kernel provides basic functions common to the entire system. This includes the Web interface framework, appliance operating system, and runtime support services. l The network layer provides critical networking support, including the RADIUS server and the ability for network administrators to manage and control the networking aspects of the appliance.
HTTP headers When making a SOAP API request, the SOAPAction HTTP header is required. The value of this header indicates the type of request being made. The Content-Type header must be specified as either text/xml or the application/soap+xml MIME type. The Authorization header must contain a valid HTTP Basic authentication string, as specified in RFC 2617. Character Set Encoding W-ClearPass Guest supports the Unicode character set, using the UTF-8 encoding.
Using the SOAP API This section describes how to access, configure, and debug Web Services, create a SOAP API operator, and access the WSDL. Accessing and Configuring SOAP Web Services To access the SOAP Web Services user interface, go to Administration > API Services > SOAP Web Services. Click the Configure SOAP Web Services link to make changes to system settings affecting the SOAP API.
An example profile is shown below. Figure 421 Example Profile in the Operator Profile Editor After you have created a suitable operator profile, create the operator login. See "Local Operator Authentication" on page 680 and "External Operator Authentication" on page 681. Dell Networking W-ClearPass Guest 6.
Accessing the WSDL Use the List Web Services command link to browse the available Web services and obtain additional details about each one. Figure 422 The SOAP Web Services List In the Web Service field, click the icon for GuestManager Web Services to view the Service URL and additional information about the service.
Figure 423 The New Project Dialog Add Service Reference 1. In the Solution Explorer, right-click the References folder, and then click Add Service Reference. Figure 424 Solution Explorer, Add Service Reference 2. The Add Service Reference dialog box appears. Enter the Service URL for the GuestManager Web Services into the Address box, and click the Go button. The WSDL is downloaded, and a list of the Web services and operations found is displayed. Dell Networking W-ClearPass Guest 6.
Figure 425 The Add Service Reference Dialog 3. In the Namespace text field, type in a name. This name is used to organize the automatically generated code that interfaces with the Web service. 4. Click the OK button to create the Web service reference. 5. To browse the created classes, double-click the GuestManager service reference. The Object Browser is displayed with the selected namespace highlighted.
Configuring the Web service reference to use authentication requires editing the app.config file to make two changes: l The mode attribute of the tag must be changed to “TransportCredentialOnly”. l The clientCredentialType attribute of the tag must be changed to “Basic”. The updated app.config file is shown below, with the appropriate changes highlighted. Figure 427 The Updated app.
Figure 428 Code to Add for Invoking the Ping Operation When invoked, this performs the Ping operation and displays the following output: Figure 429 Output Displayed after the Ping Operation Securing Web Services Using HTTPS Because HTTP Basic authentication is insecure, it is strongly recommended that the HTTPS transport be used for all SOAP API calls.
Figure 430 The Updated app.config File Additionally, if a self-signed certificate is being used on the remote server, you will need to provide a suitable ServerCertificateValidationCallback implementation to validate the peer’s certificate. The following code is a minimal implementation that accepts all server certificates without verification: // Trust self-signed certificates System..Net.ServicePointManager.
Table 258: XML Namespaces Component XML Namespace SOAP Envelope http://schemas.xmlsoap.org/wsdl/soap/ SOAP Encoding http://schemas.xmlsoap.org/soap/encoding/ WSDL http://schemas.xmlsoap.org/wsdl/ XML Schema http://www.w3.org/2001/XMLSchema SOAP Addressing Web Service Endpoint The endpoint of the SOAP service is located at the relative URL: soap_guestmanager.php.
l Example: l Example: IdType Specifies a user ID. The user ID is a positive integer value, starting at 1. l Example: ResultType Operations return a standard result type. The flag indicates if the operation completed successfully. If the operation failed, the contains a description of the error.
l Example of an unsuccessful operation: UserType The User type defines a visitor account, which consists of a number of fields. The fields available may be customized in Guest Manager. Go to Guest Manager > Configuration > Fields to create new fields or modify existing fields. Adding or removing fields will update the UserType schema in the WSDL for GuestManager Web Services. Ensure that you update any clients using this WSDL if the fields are modified.
Operations CreateUser Creates a new user account. l The standard business logic for visitor account creation applies to visitor accounts created with the SOAP API. For details, refer to the section “Business logic for account creation” in the W-ClearPass Guest User Guide, or search for this term in the online help. l The creator_accept_terms field must be set to the Boolean value “true” in order to create an account. l A value for the role_id field must be specified to create a visitor account.
Example request for CreateUser: Successful response: Failure response: 586 | Administration Dell Networking W-ClearPass Guest 6.
DeleteUser Deletes a user account by ID or matching fields l This operation deletes a single visitor account that matches all of the field values specified in the user parameter. l Exactly one account must match; if more than one match is found, or if no match is found, an error will be returned and no visitor accounts will be deleted. Example code implementing visitor account deletion: Dell Networking W-ClearPass Guest 6.
Example request for DeleteUser: Successful response: Failure response: EditUser 588 | Administration Dell Networking W-ClearPass Guest 6.
Modifies properties of a user account by ID. l This operation modifies the properties of a visitor account to match the field values specified in the user parameter. l The id field must be specified to indicate the ID of the visitor account to modify. This field is assigned by the system when the visitor account is created and cannot be changed. Example code implementing visitor account modification: Example request for EditUser: Dell Networking W-ClearPass Guest 6.
Successful response: Failure response: FindUser Returns properties of a user account by matching fields. 590 | Administration Dell Networking W-ClearPass Guest 6.
l This operation locates a single visitor account that matches all of the field values specified in the user parameter. l Exactly one account must match; if more than one match is found, or if no match is found, an error will be returned. l If a visitor account was found, its properties will be returned in the element of the result. Example code implementing search for a visitor account based on a username. Example request for FindUser: Dell Networking W-ClearPass Guest 6.
Successful response: Failure response: GetUser Returns properties of a user account by ID. 592 | Administration Dell Networking W-ClearPass Guest 6.
l Returns a element corresponding to the visitor account with the specified ID. l If the specified ID is invalid, no element is returned and the flag is set to 1. Example code implementing a guest lookup operation: Example request for GetUser: Dell Networking W-ClearPass Guest 6.
Successful response: Failure response -- for example, user ID not found: Ping Checks that the SOAP server is alive. 594 | Administration Dell Networking W-ClearPass Guest 6.
l Returns a standard result type with the message set to "pong". Example code implementing a Ping test operation. Example request for Ping: Successful response: Dell Networking W-ClearPass Guest 6.
The XML-RPC Interface and API This section describes the XML-RPC interface available to third-party applications that will integrate with the Dell Networking W-ClearPass Guest Visitor Management Appliance. Audience: l Developers of integrated applications. Some familiarity with HTTP based web services and XMLRPC is assumed. l System administrators of the W-ClearPass Guest application. System Requirements: l W-ClearPass Guest 6.1.
Figure 431 Layers of VMA Software in W-ClearPass Guest At the lowest level, the kernel provides basic functions common to the entire system. This includes the Web interface framework, appliance operating system, and runtime support services. The network layer provides critical networking support, including the RADIUS server and the ability for network administrators to manage and control the networking aspects of the VMA.
l Customized fields and their rules Access Control Page privileges are applied to XML-RPC authenticated sessions in the same way as the HTML user interface. However, XML-RPC access also requires the XML-RPC API privilege to be granted. Parameter Names The parameter names passed to the XML-RPC interface are the same as the field names in the HTML user interface. Parameter Validation Each field of the forms in the HTML user interface is subject to validation according to the rules defined for that field.
Dates and times are represented in an ISO-8601 compatible format: YYYY-MM-DD hh:mm:ss XML-RPC Faults An XML-RPC Fault is a specific kind of return value indicating that an error has occurred in the presentation layer.
3. In the Access area, select the Allow operator logins check box. 4. In the Administrator drop-down list, select Custom. The row expands to include additional options. 5. For the XMLRPC API option, select the Allow Access radio button. 6. In the Guest Manager drop-down list, select Full Access. Figure 432 The Operator Profile Editor Form 7. Click Save Changes. The profile is added to the Operator Profiles list.
1. In W-ClearPass Policy Manager, go to Configuration > Identity > Roles and click the Add User link. The Add New Role form opens. 2. Enter a name and description that clearly identify the role. Figure 433 The Add New Role Form 3. Click Save. The role is added to the Roles list. Creating the Local User After you create the role, you create the local user: 1. In W-Clear Pass Policy Manager, go to Configuration > Identity > Local Users and click Add User. The Add Local User form opens. 2.
Figure 434 The Edit Translation Rule Form 2. In the Name field, enter a descriptive name for the translation rule. In the example shown above, the translation rule is to check that the operator is an XML-RPC user, hence the name MatchXML-RPC. 3. Select the Enabled check box to enable this rule after you create it. If you do not select this check box, the rule you create will appear in the rules list, but will not be active until you enable it. 4. In the Matching Rule drop-down list, select equals. 5.
SSL Security Different levels of certificate validation checks may be necessary, depending on the SSL certificate that has been installed. This corresponds to the user interface provided by Web browsers for certificate trust and verification. The examples presented in this document assume a self-signed certificate has been installed, and reduce the level of SSL verification accordingly.
l "Method amigopod.mac.create" on page 615 l "Method amigopod.mac.edit" on page 617 l "Method amigopod.mac.list" on page 620 Method amigopod.guest.change.expiration Change the expiration time of a guest account. Parameters Table 263: Parameters, amigopod.guest.change.expiration Name Type Description uid Scalar ID of the guest account to update guestaccountexpiry Scalar Amount of time in hours before the guest account will expire Return Values Table 264: Return Values, amigopod.guest.change.
'user_enabled' => '', 'guestaccountexpiry_error' => 'Please choose from one of these options.', 'guestaccountexpiry_error_flag' => 1, 'error' => 1, Method amigopod.guest.create Create a new guest account. Parameters Table 265: Parameters, amigopod.guest.create Name Type Description sponsor_name String Name of the person sponsoring the guest account. visitor_name String Name of the visitor. visitor_company String Company name of the visitor. email String The visitor's email address.
Access Control Requires the create_user privilege (Guest > Create Guest Account in the Operator Profile Editor). Example Usage Sample parameters for the call: 'sponsor_name' => 'Sponsor Name', 'visitor_name' => 'Visitor Name', 'visitor_company' => 'Visitor Company', 'email' => 'demo@example.com', 'expire_after' => 4, 'expire_time' => '', 'role_id' => 2, 'visitor_phone' => '0', 'creator_accept_terms' => 1, Result returned by a successful operation: 'username' => 'demo@example.
Table 267: Parameters, amigopod.guest.delete Name Type Description uid Integer ID of the guest account to delete delete_account Flag Set to 0 to disable the guest account, 1 to delete the guest account Return Values This function might return a Boolean false value if some input parameters are invalid. Table 268: Return Values, amigopod.guest.
'delete_account_error_flag' => 1, 'error' => 1, Method amigopod.guest.edit Change one of more properties of a guest account. Parameters Table 269: Parameters, amigopod.guest.
Return Values Table 270: Return Values, amigopod.guest.
Sample failed call: 'uid' => 162, 'random_password' => '59447116', 'password_value' => '', 'schedule_time' => '', 'expire_time' => '', 'user_enabled' => '', 'username_error' => 'You cannot leave this field blank.
Table 272: Return Values, amigopod.guest.enable(Continued) Name Type Description uid Integer ID of the guest account *_error String Field-specific error message *_error_flag Flag Field-specific error flag, set to 1 if present Access Control Requires the remove_account privilege (Guest Manager > Remove Accounts in the Operator Profile Editor).
Return Values Table 274: Return Values, amigopod.guest.get Name Type Description id Mixed ID or IDs of the guest accounts being returned users Array l l If a single ID was requested, users contains the guest account requested (or an error field if an error occurred) If multiple IDs were requested, users contains an array of results Access Control Requires the guest_users privilege (Guest Manager > List Guest Accounts in the Operator Profile Editor).
'do_schedule' => '0', 'schedule_time' => '', 'ip_address' => '', 'netmask' => '', 'auto_send_sms' => '', 'creator_accept_terms' => '1', 'role_name' => 'Guest', 'sponsor_name' => 'Sponsor Name', 'visitor_company' => 'Visitor Company', 'visitor_name' => 'Visitor Name', 'visitor_phone' => '0', ), ), Sample failed call: 'id' => 162, 'users' => array ( 'error' => 1, 'message' => 'Account not found: ID 162', ), Method amigopod.guest.list List guest accounts. (To retrieve devices, see "Method amigopod.mac.
Return Values Table 276: Return Values, amigopod.guest.list Name Type Description ids Array Array of guest account IDs (if details was 0) users Array Array of guest account structures (if details was 1) Access Control Requires the guest_users privilege (Guest Manager > List Guest Accounts in the Operator Profile Editor). Example Usage Sample parameters: 'details' => 0, Sample successful call: 'ids' => array ( 0 => '37', 1 => '141', 2 => '40', ... ), Method amigopod.guest.reset.
Access Control Requires the reset_password privilege (Guest Manager > Reset Password in the Operator Profile Editor). Example Usage Sample parameters for the call: 'uid' => 162, Sample successful call: 'error' => 0, 'message' => 'Guest account password reset for Password changed to 37172833', 'item' => array ( 'id' => 162, 'password' => '37172833', 'username' => '', ), Sample failed call: 'error' => 1, 'message' => 'Account not found: ID 162', Method amigopod.mac.create Create a new MAC device account.
Return Values Table 280: Return Values, amigopod.mac.
'visitor_name_error' => 'You cannot leave this field blank.', 'visitor_name_error_flag' => 1, 'visitor_company_error' => 'You cannot leave this field blank.', 'visitor_company_error_flag' => 1, 'email_error' => 'Please enter a valid email address.', 'email_error_flag' => 1, 'expire_after_error' => 'Please choose from one of the available options.', 'expire_after_error_flag' => 1, 'expire_time_error' => 'Please enter a valid date and time.
Table 281: Parameters, amigopod.mac.edit(Continued) Name Type Description is reached expire_time String Time at which the device account will expire expire_postlogin Integer Time period for which the device account will be valid after the first login, or 0 for indefinitely Return Values Table 282: Return Values, amigopod.mac.
'id' => 162, 'username' => 'demo@example.com', 'role_id' => 2, 'enabled' => true, 'simultaneous_use' => 1, 'do_schedule' => 0, 'do_expire' => 4, 'expire_postlogin' => 0, 'role_name' => 'Guest', 'expire_time' => 1196431200, ), Sample failed call: 'uid' => 162, 'random_password' => '59447116', 'password_value' => '', 'schedule_time' => '', 'expire_time' => '', 'user_enabled' => '', 'username_error' => 'You cannot leave this field blank.
Method amigopod.mac.list List MAC device accounts. (To retrieve guest accounts, see "Method amigopod.guest.list" on page 613) Parameters Table 283: Parameters, amigopod.mac.list Name Type Description details Flag Optional parameter; if set to 1 then full details of all device accounts are returned, otherwise only the IDs are returned. sort string Optional parameter. If set to 1, then sorts first by the specified column, and then by username.
Data Retention The Data Retention Policy form (Administration > Data Retention) lets you manage historical data by deleting it. Figure 435 The Manage Data Retention Form 1. To enable the data retention policy option, select the Enable check box, and then enter the time of day at which records will be deleted. 2. To configure Onboard certificate retention, click the link in the Certificate Retention row. The Certificate Authorities list in the Onboard module opens.
Creating a Customized Configuration Backup You can use the Configuration Backup form to create and export a full or customized configuration backup file. To create a configuration backup: 1. Go to Administration > Import Configuration > Import Configuration, and then click the Create a customized backup link in the upper-right corner. The Export Configuration form opens. 2. In the Backup Mode drop-down list, select either Complete backup or Custom backup, as appropriate. 3.
Figure 436 The Upload File Form If your file is larger than the maximum file upload size of 15.0 MB, you must specify a URL instead. Click the Restore a backup from a URL link above the Upload File form. The Specify Backup File form is displayed. Enter the URL for the backup file. Figure 437 The Specify Backup File Form 6. Click Continue. The backup file is uploaded to your 6.x system, making the items available for import, and the Import Configuration: Step 2 page opens.
Figure 438 The Configuration Backup List View This form shows every configuration item in your backup file, and provides options for restoring items or excluding them from the restoration. For more information, see the next section, "Restoring Configuration Items " on page 625. 624 | Administration Dell Networking W-ClearPass Guest 6.
Restoring Configuration Items This section describes how to use the Import Configuration: Step 2 form to import 3.9 configuration items to your 6.2 system after you upload them. To select and restore your configuration items: 1. Go to Administration > Import Configuration > Import Configuration and complete the steps described in "Uploading the 3.9 Backup File " on page 622. 2. When the Import Configuration: Step 2 form is displayed, review the list of items.
l To make it easier to select just a few items, you can scroll to the bottom of the list and click the Unselect All link. All items are then marked with a red X and will be excluded from the import. You can then select the l l green check marks for just the items you want. The blue arrow is a visual aid marking an item as a category that has subordinate items listed below it. To include an item in the import, click the check mark in the item's row.
Figure 440 The Import Notices List View The Import Notices list provides information about items that were handled during the last import. This list includes the following columns: l Status -- The import status of the item in the same row. Possible statuses include Imported, Migrated, Obsolete, Action Required, Error, Processed, Unsupported, and Warning. These statuses are described more fully in the table below. Dell Networking W-ClearPass Guest 6.
l Operation/Notice -- This column shows the operation performed on the item, and the name of the item. If the item was imported, the value in this column will be "Import - . If the item could not be imported, you can click the row to view the item details for more information. l Count -- The number of items imported for each configuration item. For example, the number shown in the Count column for Guest Manager Custom Fields indicates the number of customized fields that were imported. 2.
For import details specific to each import item, see "Import Information for Specific Import Items " on page 629. Import Information for Specific Import Items For each configuration category on the Import Notices list, this section describes items that might be changed, unsupported, or obsolete, and any actions you might need to take.
l Any Account Retention setting is removed. l Any non-default Session Warning setting is updated to the new default. Custom Fields: The following 3.9 custom fields are obsolete and are not imported: l do_schedule delete_time l The following 3.9 custom fields are renamed: Table 287: Renamed Guest Manager Fields 3.9 Name 6.
n Configure Publisher Redundancy in ClearPass. Import Information: Hotspot Manager l Non-default User Database settings are updated to the default W-ClearPass Policy Manager user database. l Non-default Transaction Processing settings reference the correct transaction processor. l A cookie check (nwa_cookiecheck) is added to the default hotspot plan template. Import Information: Onboard To restore your Onboard device provisioning pages, you must import RADIUS Web logins.
l For all other authentication servers, an authentication source must be created in ClearPass. RADIUS Certificates l RADIUS certificates are unsupported. RADIUS Database Accounting Records l RADIUS database accounting records are unsupported. RADIUS Database Connections l The RADIUS database connection for the local RADIUS server is obsolete. l For any custom user databases, an authentication source must be created in ClearPass.
RADIUS User Roles l l For any role that does not have the default attributes ( Reply-Message :=
SSL Certificate Setup l The backup certificate is processed and ignored. l For other certificates, the certificate and the private key should be downloaded and the certificate imported into ClearPass. Subscription IDs l If the following settings do not have default values, they are updated to the new default values and migrated: n Session ID n Update URL n Facility l For non-default Application URLs, changes should be reviewed. l Subscription IDs must be added to ClearPass.
n From Address n Logout Warnings n Mail Transfer Settings n Override From n Password n Reply-To n Send Copies n Skin n SMTP Port n SMTP Server n Subject Line n Username n Use Sendmail n Use SSL encryption Plugin Manager Plugins are the software components that fit together to make your Web application. The Available Plugins list shows all the plugins currently included in your application. It lets you view information about each plugin and configure some aspects of most plugins.
Figure 441 The Available Plugins List View The About link displays information about the plugin, including the installation date and update date. The About page for the Kernel plugin also includes links to verify the integrity of all plugin files or perform an application check. Figure 442 The Plugin Information View for the W-ClearPass Guest Services Plugin Click a plugin’s Configuration link to view or modify its settings.
To view or change the configuration settings for a plugin, click the plugin’s Configuration link. The Configure Plugin form shows the current configuration settings for a plugin, and allows you to make changes to these settings. Figure 444 The Configuration Form for the MAC Authentication Plugin To undo any changes to the plugin’s configuration, click the plugin’s Restore default configuration link. The plugin’s configuration is restored to the factory default settings.
Configuring AirGroup Services To enable support for dynamic notification of AirGroup events when new devices are added, each AirGroupenabled controller must also be defined in Dell Networking W-ClearPass Guest. Configuration options include specifying roles to exclude from the user interface, and setting an automatic polling schedule, message parameters, and logging levels. To configure AirGroup Services, go to Administration > AirGroup Services > Configuration. The Configure AirGroup Services form opens.
Field Description the check boxes in the Hours field to specify which hours of the day the poll should run. l Daily: Use the text boxes in the Time of Day field to enter the hour and minute of the day the poll should run. l Weekly: Use the check boxes in the Weekdays field to specify the day or days of the week the poll should run, then use the text boxes in the Time of Day field to enter the hour and minute of the day the poll should run.
2. Scroll to the Standard Plugins > API Framework row and click its Configuration link. The Configure API Framework form opens. Figure 446 The API Framework Plugin Configuration Form 640 | Administration Dell Networking W-ClearPass Guest 6.
Table 289: API Framework Plugin Configuration Field Description Access Token Lifetime (Optional) Specifies the default lifetime of an OAuth2 access token. Unless it is changed, the default value is 8 hours. To change the value, enter a number in the first text field, and use the drop-down list to indicate the unit of time.
your own complete HTML page, or custom skin plugins that let you configure the colors, navigation, logo, and icons. 1. To modify the Dell W-ClearPass skin plugin, click its Configuration link on the Available Plugins page. 2. The default navigation method is “Simple navigation with expanding/collapsing menus.” To change the behavior of the navigation menu, click the Navigation drop-down list and select a different expansion level for menu items. 3.
The default skin used by the W-ClearPass Guest application is the one that is enabled in the Plugin Manager. To change the default skin globally, go to the plugin list and click the Enable link for the skin you would like to use as the default. When you install a new custom skin, it is automatically enabled and becomes the default skin. If your application’s appearance does not automatically change, find the custom plugin in the list, click Configure, and click its Enable link.
Table 290: Configure Guest Manager Form, Username Options Area Field Description Username Type (Required) Specifies the default method used to generate random account usernames (when creating groups of accounts). This may be overridden by using the random_username_method field. Username Length (Required) Default length of random account usernames (when creating groups of accounts). This may be overridden by using the random_username_length field.
Table 291: Configure Guest Manager Form, Password Options Area Field Description Random Password Type (Required) Default method used to generate random account passwords (when creating groups of accounts). This may be overridden by using the random_password_method field. Random Password Length (Required) Default length of random account passwords (when creating groups of accounts). This may be overridden by using the random_password_length field.
Figure 449 The Configure Guest Manager Form, Expiration Options Area Table 292: Configure Guest Manager Form, Expiration Options Area Field Description Expire Action (Required) Default action when the expiration time is reached.
Figure 450 The Configure Guest Manager Form, Expiration Warning Options Area Table 293: Configure Guest Manager Form, Expiration Warning Options Area Field Description Account Expiry Warning If selected, users will receive an email notification before their device's network credentials are about to expire. Expiration warning configuration options are added to the form. Account Expiry Notification (Required) Number of days before account expiration that the notification email will be sent.
Table 293: Configure Guest Manager Form, Expiration Warning Options Area(Continued) Field Description Email Message (Required) Specifies the print template to use when generating the email message. Options include: l Account List l Certificate Expiry l Download Receipt l Guest Account Expiry l GuestManager Receipt l One account per page l SMS Receipt l SMS Sponsor Confirmation Alert l Sponsorship Confirmation l Two-column scratch cards Email Skin (Required) Specifies the format for the email receipts.
Table 294: Configure Guest Manager Form, Receipt Options Area Field Description Site SSID Public name of the wireless local area network (WLAN). The site SSID is displayed in the guest receipt as the WiFi Network, shown below this table. Site WPA Key Encryption key used to secure the wireless network. If a value is entered in this field, it will appear on guest print receipts.
Figure 453 The Configure Guest Manager Form, General Options Area Table 295: Configure Guest Manager Form, General Options Area Field Description Terms of Use URL URL of a terms and conditions page provided to sponsors. The default, terms.php, displays the preconfigured Web page provided at Configuration > Pages > Web Pages > Terms and Conditions.
Table 296: Configure Cisco IP Phone Services Plugin Form Field Description Debugging (Required) Specifies the debugging level for Cisco IP Phone service requests. Higher levels provide more information in the application log. Options include: l 0 — No debugging output l 1 — Log requests l 2 — Log requests with full details Save Configuration Saves your changes. Configuring the Kernel Plugin The Kernel Plugin provides the basic framework for the application.
Table 297: Configure Kernel Plugin Form Field Description Application Title Name to display as the title of your Web application (for example, your company name). Debug Level The Debug Level and Application URL options should not be modified unless you are instructed to do so by Dell support. Application URL Form Auto Complete If selected, turns turn off autocomplete on forms. Selecting this option will disable credentials caching.
Configuring the MAC Authentication Plugin Different vendors format the client MAC address in different ways—for example: l 112233AABBCC l 11:22:33:aa:bb:cc l 11-22-33-AA-BB-CC W-ClearPass Guest supports adjusting the expected format of a MAC address. To configure formatting of separators and case in the address, as well as user detection and device filtering for views, go to Administration > Plugin Manager and click the Configuration link for the MAC Authentication plugin.
Configuring the Platform Services Plugin The Platform Services plugin may be used to set default options for W-ClearPass platform services. To view or configure platform services options: 1. Go to Administration > Plugin Manager. The Available Plugins list opens. 2. Scroll to the Standard Plugins > Platform Services row and click its Configuration link. The Configure Platform Services form opens.
Figure 459 The SMS Services Plugin Configuration Form Table 300: Configure SMS Services Plugin Form Field Description Service Provider Specifies the default SMS gateway to use when sending messages. Options include ClearPass Guest SMS and any other gateways that have been configured. SMS Receipt Specifies the plain-text format print template to use when an SMS receipt is generated.
Table 300: Configure SMS Services Plugin Form(Continued) Field Description used to create an “opt-in” facility for guests. Use a check box for the auto_send_sms field and add it to the create_user form, or a guest self-registration instance, and SMS messages will be sent to the specified phone number only if the check box has been selected. Credit Warning (Required) The number of available credits at which a warning is sent.
Configuring the SMTP Services Plugin The SMTP Services plugin may be used to set default options for SMTP Services and email receipts. To view or configure SMTP services options: 1. Go to Administration > Plugin Manager. The Available Plugins list opens. 2. Scroll to the Standard Plugins > SMTP Services row and click its Configuration link. The Configure SMTP Services form opens. Figure 460 The Configure SMTP Services Form Dell Networking W-ClearPass Guest 6.
Table 301: Configure SMTP Services Form Field Description Subject Line Template specifying the subject line for visitor account receipts sent by email. May contain template code, including references to guest account fields. The default value, Visitor account receipt for {$email}, uses the value of the email field. See "Smarty Template Syntax" on page 700 for more information on template syntax. Email Receipt (Required) Specifies the plain text or HTML template to use for the email receipt.
Field Description of the user, or by the admin's email. When you select this check box, the Override From field is added to the form. To use the global From Address, do not select the check box in this field. Override From If selected, overrides the From Address instead of using the Reply-To value. Email Field (Required) Specifies the field that will contain the visitor's email address.
2. Scroll to the Standard Plugins > Translation Assistant row and click its About link. The Plugin Information form opens. Figure 461 The Translation Assistant Plugin Information View By default, the display language for the W-ClearPass Guest user interface is automatically detected based on the user's browser settings. To enable or disable language packs, set a default language for W-ClearPass Guest, or customize label and message text, see "About Translations" on page 463.
Table 302: Configure Web Analytics Plugin Form Field Description Tracking Code The page tracking code to add before the
