ClearAccess® ClearVision 2.4 Best Practices
-
Upload
independent -
Category
Documents
-
view
4 -
download
0
Transcript of ClearAccess® ClearVision 2.4 Best Practices
ClearAccess® Proprietary and Confidential. Copyright © 2012. All Rights Reserved.
ClearVision 2.4 Best Practices
A Practical Overview
December 13, 2011
ClearAccess, Inc. 501 SE Columbia Shores Blvd. Suite 500 Vancouver, WA 98661 Phone: +1 360 859 1780 Fax: +1 360 576 2980 Email: [email protected] Internet: www.clearaccess.com
ClearVision 2.4 Best Practices – A Practical Overview
Page 2 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Table of Contents Table of Contents ............................................................................................................. 2
Revision History ............................................................................................................... 3
Document Purpose ........................................................................................................... 4
Introduction ..................................................................................................................... 5 TR-69 Overview ....................................................................................................................... 5 ClearVision Platform Summary ................................................................................................. 6
ClearVision Installation and Validation ............................................................................... 9 Standard Services .................................................................................................................... 9 Optional Services (requires PBCA) ............................................................................................. 9 Domains Management ............................................................................................................. 9 Scripting Engine ..................................................................................................................... 10 ClearVision Analytics .............................................................................................................. 10
Device Trends .............................................................................................................................. 10
Administration of ClearVision users ................................................................................. 11 Creating new ClearVision Users ............................................................................................... 11
Define the Default Configuration ..................................................................................... 13
Define ACS Scripts, Services, and Events ........................................................................... 14 Scripts ......................................................................................................................................... 14 Services ....................................................................................................................................... 14 Events .......................................................................................................................................... 14
Check in a Device and associate with a Subscriber ............................................................. 16 Connect a Gateway ................................................................................................................. 16 Associating a subscriber .......................................................................................................... 16
Batch import of Device and Subscriber data ...................................................................... 18 Importing batch subscriptions ................................................................................................. 18
Enabling Gateway Services .............................................................................................. 19 Enabling Services on a Gateway ............................................................................................... 19 ClearVision Bulk Operations .................................................................................................... 19
Initiating a scripted action against the gateway ................................................................ 21
Integration points using ClearVision APIs ......................................................................... 21
ClearVision 2.4 Test Cases ............................................................................................... 23
Appendix A: Acronyms & Abbreviations ........................................................................... 24
Table of Tables
Table 1: Revision History .............................................................................................................................. 3 Table 2 – CPE and Associated Data Models ............................................................................................. 5 Table 3: Core Scripts Overview ................................................................................................................. 14 Table 4: Core Services Overview ............................................................................................................... 14 Table 5: Core Events Overview .................................................................................................................. 15 Table 6: CV 2.4 Test Cases......................................................................................................................... 23
ClearVision 2.4 Best Practices – A Practical Overview
Page 3 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Table 7: Document Acronym's & Abbreviations Defined ......................................................................... 25
Table of Figures Figure 1 ClearVision Architecture ................................................................................................................ 6 Figure 2: Control Panel Overview ................................................................................................................ 7 Figure 3: ClearVision Portal View ................................................................................................................ 7 Figure 4: ClearVision Analytics Engine ........................................................................................................ 8 Figure 5: Report showing LAN device count and descriptions by gateway .......................................... 10 Figure 6: : Administration Panel for ClearVision 2.4 ................................................................................ 11 Figure 7 : Customer support screen with subscriber association link .................................................... 16 Figure 8: Device Status Screen for Gateway under management .......................................................... 17 Figure 9 : Gateway Services management – Wi-Fi .................................................................................. 19 Figure 10 : Gateway Management with Advanced Scripts showing ...................................................... 21
Revision History
Version Date Author Description
1.0 12/01/2011 P. McGuinness Document Creation
Table 1: Revision History
ClearVision 2.4 Best Practices – A Practical Overview
Page 4 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Document Purpose The following document outlines the main administrative steps and best practices for deployment and integration of ClearVision. The aim is to help service providers evaluate the functionality and benefits of the ClearVision platform. The following topics will be discussed;
TR-069 Overview
ClearVision Platform Summary
ClearVision Installation and Validation
Administration of ClearVision users
Define the default configuration
Define Scripts, Services and Events
Check-in a Device and associate with a Subscriber
Batch import of Device and Subscriber data
Enabling Gateway Services
Initiating a scripted action against the gateway
Integration points using ClearVision APIs
Run test cases on ClearVision
ClearVision 2.4 Best Practices – A Practical Overview
Page 5 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Introduction All service providers share the same reality that more and more IP devices are making their way into their subscribers’ homes at staggering rates. Likewise, today’s subscribers want instant gratification which translates to what they want, when they want it. These trends present a number of challenges and opportunities for both service providers and solution vendors alike. Today TR-069 is being used to manage millions of residential gateways (RGs) along with an increasingly wide variety of networking devices. TR-069 deployment scenarios vary based on the type of service provider (e.g. telco, cable, wireless) along with their business objectives. Some of the more innovative deployments involve portfolios of new manageable data services with corresponding subscriber portals that leverage TR-069. The TR-069 value proposition enables service providers to own the connected home and benefit from OPEX reductions combined with additional revenue opportunities through the delivery of manageable data services.
TR-69 Overview In 2004, the DSL Forum, later named the Broadband Forum, released the groundbreaking CPE WAN Management Protocol (CWMP), more commonly referred to as TR -069. This specification defines a an application layer protocol; common communication mechanism between customer premise equipment (CPE) and a TR-069 Auto Configuration Server (ACS). Initially service providers were focused on using the ACS to manage DSL and Ethernet residential gateways (RG). Today service providers are increasingly using the ACS to manage cable gateways, optical network terminals (ONTs), IPTV set -top boxes (STBs), network attached storage (NAS), powerline adapters, femtocells, IP phones, and more. All devices managed with TR-069 have a well defined data model associated with them (see Table 1 below). The data model is the set of common management objects for a given CPE – many if not all of which are remotely accessible by the ACS for provisioning, device management, and service delivery.
Table 2 – CPE and Associated Data Models
ClearVision 2.4 Best Practices – A Practical Overview
Page 6 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
ClearVision Platform Summary ClearAccess specializes in offering service providers an end-to-end management and application platform (ClearVision) based on the TR-069 open standard. Specifically, ClearAccess offers auto configuration server (ACS) software, advanced service extensions, full analytics capability, and a client software stack for CPE partners (through our Powered by ClearAccess™ program ‘PBCA™’). This portable PBCA stack is provided to our ecosystem partners for incorporation into their CPE devices that require TR-069 management (e.g. Cable Gateways, STB, NAS, IP Phones, etc.). The ClearVision management platform features a customer service and a subscriber portal that provides visibility, as well as manageability, of a subscriber’s home network (LAN). The IP enabled devices connected to the network are auto detected, identified and presented on these portals.
Figure 1 ClearVision Architecture
To date, the ClearVision management platform has been deployed across 65+ service providers and is the only TR-069 based platform being deployed by cable operators to manage cable gateways in North America. Specifically Cox Communications (4.0 M BB Subs), Rogers Communications (1.9M BB Subs) and Mediacom (850K BB Subs) have all selected ClearVision. ClearVision is also in trials with 7 of the top 10 cable operators across North America and with 3 cable operators in Europe. To ensure end-to-end interoperability and a robust ecosystem, ClearAccess uniquely provides our OEM partners with a very lightweight standards based TR-69 client stack, with advance service extensions. To facilitate this we have established partnerships with partners such as Broadcom, whereby they include the ClearAccess TR-69 client stack in their DOCSIS 3.0 gateway SDK. This enables OEMs including Cisco, Netgear, Technicolor, Arris and SMC to easily support cable operator’s plans to use TR -69 management.
ClearAccess is hardware agnostic, allowing cable service providers to select the CPEs of their choice, while maintaining the same subscriber and customer service portal look and feel across all CPEs. ClearAccess offers a number of foundational enhancements, which enhance the value of the platform, including the abstraction of the subscriber and customer service portal into the cloud. Screen shots of these portals are shown in Figure 2 and Figure 3.
ClearVision 2.4 Best Practices – A Practical Overview
Page 7 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Figure 2: Control Panel Overview
Figure 3: ClearVision Portal View
Additional enhancements, evident in the above screen shots, include monitoring wireless signal strength (Figure 3) and local web interface access (Camera or Printer) (Figure 2 and Figure 3). Additional planned applications for ClearVision include the ability to monitor bandwidth consumption per IP device. ClearVision also enables a whole new set of revenue generating services, including managed Wi-Fi, content filtering, Internet time blocking, online backup, and home surveillance. The ClearVision management platform supports a robust analytics engine enabling cable operators to collect date related to their network and generate customized reports to proactively trouble shoot problems or obtain insight into trends in usage (See Figure 4). These
ClearVision 2.4 Best Practices – A Practical Overview
Page 8 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
reports, along with support for bulk operations and captive portal redirects, allow cable operators to proactively present subscriber’s messages for improving performance, pending outages or even up selling service based on usage patterns.
Figure 4: ClearVision Analytics Engine
ClearAccess’ leadership in the TR -69 community has set us apart in the industry, substantiated by the top cable operators selecting ClearVision for deployment across their residential and SMB networks. This leadership has put ClearAccess in the unique position to help architect our customer’s strategic roadmaps so they may capture fu ture managed service revenue streams and positioning them to more effectively compete with over the top services available to their subscribers. In summary, ClearAccess offers a proven and complete standards -based management and applications platform that meets Service Providers desired objectives and is being deployed on a variety of gateways allowing service providers to select the CPEs of their choice
ClearVision 2.4 Best Practices – A Practical Overview
Page 9 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
ClearVision Installation and Validation Installation and Validation is carried our by ClearAccess for hosted or onsite deployments. The installation includes the publically accessible ClearVision platform, Database deployment, System Redundancy where required.
Standard Services By default, the following standard services will be enabled in the ClearVision Customer Support Portal UI: Account management:
Device details including PPP information Local Network status Account status Subscriber status
Services:
WiFi Service (single SSID) Firewall Service Reboot Service Local GUI Click Through
Advanced Actions:
Event Logs Parameter Browser Replace Device Scripts Firmware Update
The following applications are optional and can be added to any ClearVision deployment for an additional fee. These applications are dependent on CPE capabilities and may vary depending on CPE manageability. Some features require Powered by ClearAccess CPE software.
Optional Services (requires PBCA) Parental Controls Time Blocking
Allows parents to specify time of day and amount of time allowed for Internet Access (bot h globally and per device).
Parental Controls Website Blocking Allows parents to specific particular websites that are allowed/blocked for a particular device, or as a default for new devices.
Parental Controls Dynamic Filtering Enables dynamic URL-based filtering based on predefined profiles. Each profile (i.e. kids, teens) can be applied individually to every device in the home.
Domains Management Separates subscribers, devices, and system users into distinct domains. Ideal for segmenting support entities, and creating wholesale support offerings
ClearVision 2.4 Best Practices – A Practical Overview
Page 10 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Scripting Engine The scripting engine provides access to the ClearVision Javascript editing tool, which can be used to create and customize scripts for managing end devices.
ClearVision Analytics Analytics is used to aggregate data maintained in ClearVision. This data can be used to study a wide variety of conditions. An example ClearVision Analytics use case is the Studying Managed
Device Trends
This includes providing a snapshot of shipment trends during promotions or watching for information about which devices tend to churn more quickly than others. This data is useful when deciding on the value of higher- vs. lower-end managed devices. It may also help indicate product longevity, based on a first-inform time analysis.
Figure 5: Report showing LAN device count and descriptions by gateway
Examples of other trend reports: Managed devices by Manufacturer, Model, and Firmware version Monitoring the uptake of ClearVision Services by subscribers (are enabled services
being used) Watching the distribution of Wired vs. Wireless networks Studying device trends in the home, which is helpful for understanding device trends and
up-sell potential. Examples of in-home managed device trends would include: Number of LAN devices per subscriber Number of Wi-Fi vs. Ethernet devices per subscriber Percentage of subscribers using Wi-Fi security (and, if so, at what level of security) Wi-Fi channel use Port forward use
ClearVision 2.4 Best Practices – A Practical Overview
Page 11 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Administration of ClearVision users
Creating new ClearVision Users Creating a new user, whether it is an Administrator, CSR agent, Report Administrator or any hybrid of each is a necessary and easy task. The Roles can be assigned to specific Users and their job requirements
Tier 1 Tier 2 Provisioning Administration
First test and validate connection status with the ACS management URL for the ClearVision administrative and CSR portal. The URL address will be the ClearVision server management login for your trial or deployment service and will be in the form of: https://cable.clearaccess.com The URL and login credentials will be provided by ClearAccess following installation and validation.
Note: Credentials are case sensitive Once connected and authenticated on ClearVision follow these steps to Create New ClearVision users.
1. Select the Administration link from the top of the navigation tabs as seen in Error! Reference
source not found.Error! Reference source not found.
2. Select the Users navigation link on the left panel as seen in Error! Reference source not
found.
Figure 6: : Administration Panel for ClearVision 2.4
ClearVision 2.4 Best Practices – A Practical Overview
Page 12 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
3. All currently provisioned system users will be shown here.
4. To modify existing users, select the link.
5. To create new users, select the PLUS sign and fill out the
6. Select the appropriate user roles. Admin, ReportAdmin or CSR from the roles list.
7. When complete, click the save button.
Your new user will now appear in the list of available users and is now ready function on the ClearVision system in their prescribed roles.
ClearVision 2.4 Best Practices – A Practical Overview
Page 13 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Define the Default Configuration The ClearVision platform has core configuration items that allow for default configuration for a population. These configuration items control various aspects of device and UI experience. Applicable defaults will be defined and provided as part of the ClearAccess Professional Services initial installation and setup consulting process as part of an engagement review. Access Control The Access Control section defines the enablement or disablement of FTP, HTTP, ICMP, SNMP, SHH, TFTP, and Telnet on the end user’s Gateway. Captive Portal The Captive Portal section defines the default URL an end user will be redirect to if enabled. Content Filtering The Content Filtering section defines the location of Content Filtering service nodes, Defined categorization lists, and rules for how the device behaves in specific use cases. Control Panel The Control Panel section defines the URL that devices are directed to when using the Control Panel. LAN The LAN section defines the LAN side defaults for the end user’s Gateway with items including, use of DHCP, Subnet and IP Range. Management Password The Management Password section sets the solicit credentials on the end user’s Gateway for communication with the ACS. Management Server The Management Server section defines the environment specific Management URL for the ClearVision Platform and the inform internal for the end user’s Gateway QOS (Quality of Service) The Quality of Service section defines the configuration of the end user’s device with specific settings for a routed network configuration. This is commonly used for routed IPTV configurations or for services with higher SLA requirements. Static Route The Static Route section predefines specific routing values to be loaded on the end user’s Gateway. This is useful in an environment s that leverages a public and private WAN topology. STUN This defines the STUN server address, port and client keep-alive values for the end user’s Gateway. Time Blocking The Time Blocking section defines the URL that hosts connected to the end user’s Gateway are directed to when Time Blocking is enabled. Time Zone The Time Zone section defines the default time zone for the end user’s Gateway.
ClearVision 2.4 Best Practices – A Practical Overview
Page 14 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Topology The Topology section defines the bridged groups and bridge WAN configuration as required. This is commonly used for non-routed IPTV configurations.
Define ACS Scripts, Services, and Events The primary method of updating or modifying settings on a gateway occurs with the use of Scripts, Services, and Events.
Scripts
Scripts are used by the system, and by administrators to execute code on the ACS. These scripts are written in JavaScript. To access the scripts first click on the Administration tab, then click on “Scripts” in the left navigation. ClearVision ships with a core set of scripts: administrations can write additional custom scripts.
Core Scripts Overview
Script Name Description
Initial Configuration Upon the first check of a gateway the Management URL, Solicit Credentials, and Periodic Inform Interval are set.
Service Initial Configuration Setup all enabled services to the gateway
Subscriber Associated Matches the gateway to the subscriber Inform Interval Set the Periodic Inform Interval on the gateway
Table 3: Core Scripts Overview
Services
Services are packaged capabilities delivered to the system users. Administrators define which services will be available and how they are displayed to Administrators, CSRs and Subscribers. To access the Services configuration first click on the Administration tab, then click on “Services” in the left navigation.
Core Services Overview
Service Name Description
Wireless Wireless Settings Port Forwards Port Forward Settings Local GUI Clickthrough Enable Remote Access to gateways local GUI Content Filtering Dynamic URL Filtering Setup Time Blocking Time Blocking Setup
Table 4: Core Services Overview
Events
Events are pre-defined occurrences during which the ACS can run scripts and enable services. Administrators can select which actions occur during an event. To access the Services configuration first click on the Administration tab, then click on “Services” in the left navigation.
ClearVision 2.4 Best Practices – A Practical Overview
Page 15 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Core Events Overview
Event Name Description
Initial Contact First Contact of Gateway Subscriber Associated Primary association of Gateway to Subscriber Inform Every standard contact of Gateway to the ClearVision
Platform Table 5: Core Events Overview
ClearVision 2.4 Best Practices – A Practical Overview
Page 16 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Check in a Device and associate with a Subscriber
Connect a Gateway Most components of the system will have already been exercised by the initial start of the ClearVision Platform. The key exercise left is to ensure that a device is able to reach the ACS and the gateway can be managed. The configuration of the gateway differs by gateway model, so see your equipment manufacturer instructions for setting the TR -069 Management Server URL. Confirm that the gateway has a management contact URL entry similar to: https://cable.acs.clearaccess.com Save any gateway configurations as needed and attach the gateway to the Internet via any physical layer provisioning methods that are required. When the device checks in you should see it show up in the listing on the Customer Support tab. Once you have confirmed device check-in, you have completed the basic setup of the ClearVision Platform.
Note: Public IP address will be required for the Gateway WAN interface in order to solicit the Gateway from ClearVision 2.4 trial server. If deployed behind a NAT, with a non-routable IP address, the device should support STUN.
Associating a subscriber Once the device has been connected to the ClearVision Trial instance, the option for associating subscriber information to the gateway is available. The Subscriber -Device association is at the core of service delivery, troubleshooting, and device replacement. ClearVision makes creating these associations easy.
Note: Until the subscriber is associated with the Gateway under management, the consumer control panel navigation link will not be available to the CSR.
Select the target Gateway to be managed Select the link titled “Associate with subscriber” as seen in Figure 7 below.
Figure 7 : Customer support screen with subscriber association link
ClearVision 2.4 Best Practices – A Practical Overview
Page 17 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
1. The subscriber information panel will be available at this stage.
2. Fill in the appropriate fields.
3. When completed, click the provision device button located in the lower right corner
4. Subscriber information is now associated with the Gateway and the CSR Control Panel link is
now available as seen in Figure 8
Figure 8: Device Status Screen for Gateway under management
ClearVision 2.4 Best Practices – A Practical Overview
Page 18 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Batch import of Device and Subscriber data The Subscriber-Device association is at the core of service delivery, troubleshooting, and device replacement. DEVICES: When creating a device using the integration APIs, the OUI and Serial Number are the minimal amount of data required. SUBSCRIBERS: A subscriber is a person (or account) who has devices. It is externally identified by a subscriber code. The format and contents of this code are determined by the integrator and may map to a phone number, billing account number, or some other unique value which has meaning in other systems.
Importing batch subscriptions For initial provisioning of Subscribers and their services it may be necessary to import large numbers of subscribers to ClearVision. This batch import of subscriber information may be provisioned with a CSV file or through integration with external systems via the ClearVision API. Use the Import Subscriptions Utility to batch upload subscription information. A subscription includes many pieces of data including subscriber, services, device information, device settings, device labels, and subscriber login credentials for the control panel. Your data must be in a Comma Separated Value (CSV) and must conform to the format described in the ClearVision 2.4 Admin Guide.
ClearVision 2.4 Best Practices – A Practical Overview
Page 19 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Enabling Gateway Services
Enabling Services on a Gateway After the gateway has been provisioned, certain services, depending upon configuration may not have been enabled. Utilize the following steps to either enable, or depending on the use case, disable services for a particular gateway under management.
1. Select a Gateway for management.
2. Select the left navigation link labeled SERVICES.
3. All available services for this gateway will be shown under this management tab.
4. Select a service to be enabled or disabled
Figure 9 : Gateway Services management – Wi-Fi
5. Enable or disable the service by selecting the appropriate button as seen in Figure 9
6. Click Save.
7. The Gateway will synchronize new settings from as requested by ClearVision after the save
button is activated. This will take approximately 20-30 seconds to accomplish.
8. Your service is now activated / de-activated depending upon the business case.
ClearVision Bulk Operations Bulk Operations provides a flexible framework for the creation of one time or repeatable mass operations. Operations can be run on demand or scheduled. Operations can actively solicit gateways or passively wait for a check in before performing the action. Operations can be filtered to almost any criteria. Below are some examples of how Bulk Operations is used:
Modify the inform interval of subset of devices. For example, for all CPEs that have been online for 60 days, backoff the inform interval to 72 hours to lessen network traffic.
ClearVision 2.4 Best Practices – A Practical Overview
Page 20 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Setup periodic retrieval of device information for reports. This would allow the operator to collect data during off-hours and run the report during the day.
Set Captive Portal settings for specific devices. Captive portal can be used to force the subscribers web browser to a specific site, which is applicable for bulletin notifications (security alerts, new offers, etc) or to get opt-in on new terms of service (See DMCA use cases).
Upgrade firmware to a CPE, and in the future to other TR -069 enabled LAN devices. Modify device settings on the CPE, for instance changing wireless channel to “auto” for devices
that are experiencing poor WiFi performance or are stuck on channel 6. Could be used for TR-069 parameters as well such as the ACS URL and SSL on/off.
Enable a new service to appear in the Control Panel for subscribers to try out. Makes it easy to enable new services on a trial basis.
ClearVision 2.4 Best Practices – A Practical Overview
Page 21 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Initiating a scripted action against the gateway In certain circumstances, actions that aren’t readily available in the ClearVision user interface may be required to be taken against the gateway. The task items below will illustrate sending scripted commands to the gateway under management to accomplish such an action. In this case, the action taken will be to modify the Gateway’s periodic inform rate.
Note: The periodic inform rate on the Gateway controls the window in which the gateway will contact the ClearVision server. This time is measured in seconds. Default is 82,800 seconds, or 23 hours.
1. Select a Gateway for management 2. Select the “Advanced” management link on the left navigation panel at the bottom as seen
in Error! Reference source not found.Figure 10
Figure 10 : Gateway Management with Advanced Scripts showing
3. Choose from the dropdown menu labeled “Select Script” 4. Once selected, click the “Add Script to Queue” button. 5. Click Save 6. The new scripted action will appear in the table labeled Script Log. This new action is now
pending next contact with the Gateway under management. 7. Note the Status indications in this Script log to determine the success of the scripted action.
Integration points using ClearVision APIs The ClearVision northbound interface API is based on RESTful services and can be easily integrated with Service Providers’ backend systems. The API is open and easy to use by Service Providers and
ClearVision 2.4 Best Practices – A Practical Overview
Page 22 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
third parties. ClearAccess’ professional services team are able to work on custom integration efforts or offer integration support as required. Examples of integration points include;
SSO Customer Support Representative,
SSO for the Subscriber Portal (for example from an existing customer portal),
Service enablement
Provisioning user data,
Wifi management SSID/Username/Password,
Content Filtering
Internet Time Blocking
RMA / Device replacement
Role Based authentication from any LDAP compliant authentication resource
OSS / BSS integration
The ClearVision CSR portal is rendered across Web Services 2.0 APIs and can easily be integrated within a Service Providers existing CSR interfaces for access by a CSRs and Administrators. Additionally the ClearVision subscriber portal (Control Portal) is rendered across Web Services 2.0 APIs and can easily be integrated within a Service Providers existing portal for access by a subscriber. What can the ClearVision 2.4 APIs do for me? Device Management:
creating, editing, and deleting subscribers, devices, and associated data
associating subscribers with managed devices
configuring managed devices (i.e. port bridging, wireless settings, etc.)
turning on/off specific services (i.e. IPTV, Content Filtering, etc.)
querying the state of device operations
Search: Find subscribers and devices given a number of fields to search by
Extract bulk data such as statistics
Create Control Panel Sessions: For subscriber single sign-on implementations
For full detail on the ClearVision APIs please refer to the ClearVision Integration Guide 2.4
ClearVision 2.4 Best Practices – A Practical Overview
Page 23 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
ClearVision 2.4 Test Cases Please refer to the ClearVision 2.4 Trial Guide for full test case details. The table below shows a typical 2.4 Test Matrix. Test Cases are dependent on Services provisioned and Devices used.
Test Number
Title Tested Date Comments
1 Associating a Subscriber 2 Home Network Map 3 CSR Access to the Home Wireless Service 4 Configure port forwarding 5 Configure content filtering 6 View LAN devices local interface 7 Set Time Control access on any attached LAN
device 8 Consumer Self Help Portal 9 Wireless Signal Strength on all Wi-Fi LAN devices 10 Generate wireless encryption and push to
gateway 11 Manage multiple Wireless SSIDs 12 Ability to push firmware to specific Device under
management (device dependent) 13 Ability to push release / renew IP Address to
LAN clients 14 Power Cycle Router 15 One Click RMA processing
Table 6: CV 2.4 Test Cases
ClearVision 2.4 Best Practices – A Practical Overview
Page 24 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
Appendix A: Acronyms & Abbreviations
Acronym /Abbreviation Description
ACS Auto Configuration Server
AP Access Point
API Application Programming Interface
BSS Business Support Systems
CAQL ClearAccess Query Language
CPE Customer Premise Equipment
CSR Customer Service Representative
CV ClearVision
CWMP CPE WAN Management Protocol
DB Database
DHCP Dynamic Host Control Protocol
DNS Domain Name System or Domain Name Service
DOCSIS Data over Cable Service Interface Specification
EMEA Europe, the Middle East and Africa
EU European Union
EuroDOCSIS European Standards for DOCSIS
FW FirmWare
GUI Graphical User Interface
GUID Globally Unique Identifer
HTTP HyperText Transfer Protocol
HTTPS HyperText Transfer Protocol Secure
HW Hardware
ICMP Internet Control Message Protocol
IP Internet Protocol
IPTV Internet Protocol Television
Ipv4 Internet Protocol version 4
Ipv6 Internet Protocol version 6
LoE or LOE Level of Effort
MAC Media Access Control
NOC Network Operations Center
OSI Open Systems Interconnection
OSS Operations Support Systems
OUI Organizationally Unique Identifier
PBCA Powered by ClearAccess
PM Project / Program Manager
PMBOK Project Management Body of Knowledge
POC Point of Contact
QA Quality Assurance
QoS Quality of Service
REST Representational State Transfer
RG Remote Gateway
RHEL RedHat Enterprise Linux
ROI Return on Investment
ClearVision 2.4 Best Practices – A Practical Overview
Page 25 of 25
ClearAccess | 501 SE Columbia Shores Blvd STE 500, Vancouver, WA 98661 USA | Copyright 2012, All Rights Reserved
Phone +1 360 859 1780 | Fax +1 360 576 2980 | Email [email protected] | Internet www.clearaccess.com
RPC Remote Procedure Call
RTO Return to Operation
SaaS or SAAS Software as a Service
SLA Service-Level Agreement
SNMP Simple Network Management Protocol
SOA Software Orientated Architecture
SOAP Simple Object Access Protocol
SPOC Single Point of Contact
SSID Service Set Identifier
SSL Secure Socket Layer
SSO Single Sign-On
STB Set-Top Box
STUN Session Traversal Utilities for NAT
SW Software
Sync Synchronization
TB Time Blocking
TBStatus Time Blocking Status
TCO Total Cost of Ownership
TCP Transport Control Protocol
TR-069 Technical Report 069 (from Broadband Forum)
TR-111 Applying TR-069 to Remote Management of CPEs
TR-135 Data Model for TR-069 enabled Set-Top-Box's (STB)
TR-181 Data Model for TR-069 Device Management
TR-181i2 Data Model for TR-069 Device Management Issue 2 (All Devices)
UDM Universal Device Management
UDP User Datagram Protocol
UI User Interface
URI Uniform Resource Identifier
URL Uniform Resource Locator
VM Virtual Machine or Virtual Memory
WAN Wide Area Netork
WEP Wired Equivalent Privacy a.k.a. Wireless Encryption Protocol
WiFi Wireless (rf: wireless contected devices based on IEEE 802.11 b/g/n standards)
WIP Work in Progress
WLAN Wireless Local Area Network
WME Wireless Multimedia Extensions
WMF Wireless Multicast Forwarding
WPA WiFi Protected Access
WPA2 WiFi Protected Access v2
WPS WiFi Protected Setup
ZTQ Zero-Term Query
Table 7: Document Acronym's & Abbreviations Defined