Cisco Prime Home User Guide, 5.1
Chapter 8: Administration Overview
Downloads: This chapterpdf (PDF - 1.46MB) The complete bookPDF (PDF - 7.68MB) | Feedback

Table of Contents

Administration Overview

Licensing

Managing Labels

Labels Window

Adding a New Label

Editing a Label

Deleting a Label

Managing Users

Adding a New User

Editing User Information

Deleting a User

Managing Device Types

Device Type Page

Adding a Device Type

Editing a Device Type

Deleting a Device Type

Managing Firmware Versions

Firmware List Window

Adding a Firmware Version

Editing a Firmware Version

Cloning a Firmware Version

Managing Services

Services Window

Adding a New Service

Editing a Service

Managing User Interface Groups

Adding a User Interface Group

Editing a User Interface Group

Deleting a User Interface Group

Managing Scripts

Scripts Window

Adding a New Script

Editing a Script

Deleting a Script

Managing Events

Events Window

Adding a New Event Action

Editing an Event Action

Deleting an Event Action

Managing Announcements

Using the Announcements Editor

Adding a New Announcement

Editing an Announcement

Deleting an Announcement

Managing Device Synchronization

Resolving Synchronization Failures

Administration Overview

You use the Administration tab to control and manage the Prime Home software.

System admins can:

  • Create global system labels
  • Add new user accounts to Prime Home and manage existing accounts
  • Set roles for each new user to Prime Home
  • Create and set up various actions
  • Add device types
  • Create new services that can be added to subscriber accounts
  • Manage firmware
  • Create automated action schedules
  • Create and edit system announcements
  • Synchronize devices

Licensing

The content in this guide is subject to your licensing agreement with Cisco. You might not have access to all features and sections of Prime Home. Features that must be explicitly licensed include:

  • The number of users that can be logged into the system at the same time.
  • The ability to run reports.
  • The ability to write and run scripts.

Managing Labels

Use the Labels window (Figure 8-1) to review, edit, and create new labels to apply throughout Prime Home. You can apply labels to devices, subscribers, firmware, users, and scripts.

Figure 8-1 Labels Window

 

Labels Window

The Labels window comprises:

  • Existing Labels —Shows all the current labels in the system. Click
  • to add a new label to the system with the Label Editor.
  • Label Editor —Use the Label Editor to create new labels or edit existing labels. From here:

Click to close the editor and discard your changes.

Click to delete a label from the system.

Click to save your changes.

Adding a New Label

To add a new label:


Step 1 On the Administration tab, click Labels .

Step 2 Click .

The system displays the Label Editor.

Step 3 Enter the label name in the Label Text field.

Step 4 Click . A color palette window displays the colors you can use to distinguish your label.

Step 5 Select a color to apply from the color palette.

Step 6 Click .


Note Labels can include alphanumeric characters, underlines, and spaces only. Labels cannot exceed 32 characters in length.



 

Editing a Label

To edit a label:


Step 1 On the Administration tab, click Labels .

Step 2 Click a label to edit from the Existing Labels List.

Step 3 Make your changes to the fields. You can change a label's name or color scheme.

Step 4 Click .


 

Deleting a Label

To delete a label:


Step 1 Locate the label to delete from the Label list.

Step 2 Click next to the label’s name to remove it. The system refreshes the page, listing the remaining labels. If this label was applied to devices or subscribers, it is removed from those items.


 

Managing Users

The Users window (Figure 8-2) lets you manage users in Prime Home. This window includes a secondary search field that allows you to quickly search for user information. The field appears just under the User List heading.

Prime Home includes the following roles that you can apply to a user account:

  • Admin —An Admin account allows access to all the functions in Prime Home.
  • Customer Support Representative —A customer support representative (CSR) account can perform customer service tasks. The specific tasks that are available depends on how your Prime Home installation is configured.

Figure 8-2 Users Window

 

The Users window comprises:

 

  • User list—Displays a search result list of users in Prime Home. From here:

Click to add a new user to Prime Home.

Click to refresh the User list.

  • Search field and
  • —Use the search field to search for a username.
  • Search Results List —This list displays all your search results. If your results are more than the page can handle, then use the page forward and page backward buttons to see more results. Use the Items per page drop-down menu to set the limit of results to 10, 25, or 50 per page.
  • Click
  • to delete a user from the system.
  • User Editor —The User Editor allows you to enter or edit user information. Enable the account by checking the Enabled check box. Disable the account by unchecking the Enabled check box.
  • User Actions —Assign or remove labels from the user. From here:

Click to expand the User Editor to full size. When in full-size mode, click to restore the window to its original size.

Click to close the editor and discard your changes.

Click to save your changes.

Adding a New User

To add a new user:


Step 1 On the Administration tab, click Users .

Step 2 Click .

Step 3 Enter the user’s login name in the Login field.

Step 4 Check the Enabled check box to activate the account and allow the user to log in. (To disable the account later, uncheck the Enabled check box.)

Step 5 Enter the user’s full name in the Full Name field.

Step 6 Enter the user’s e-mail address in the Email field.

Step 7 Enter the user’s password in the Password field.

Step 8 Enter the user’s password again in the Confirm field.

Step 9 Select a role for your user from the Roles list.

Step 10 (Optional) Select one or more domains that this user can view and work with. To select more than one domain, hold the Control (PC) or Command (Mac) key while selecting and deselecting.

Step 11 Click .


 

Editing User Information

To edit user information:


Step 1 Search for the user.

Step 2 Click a username in the Users List to display the User Editor.

Step 3 Edit any of the fields for that user.

Step 4 Click .


 

Deleting a User

To delete a user:


Step 1 Locate the user to delete from the User List.

Step 2 Click in the user’s row to remove the user from the system.

The system refreshes the page, listing the remaining users.


 

Managing Device Types

Use the Device Type List page (Figure 8-3) to manage device type profiles in your system. A device type maps to a hardware model. Each model has its own unique signature. Prime Home uses device types to differentiate between different types of hardware.

When a device is created in the system, it gets associated to a device type. The system pulls in this information to create the association by locating the device's built-in hardware version or hardware class. The system tries to pull as much information from the device into the profile as it can.

When you connect a new device to Prime Home, the system automatically associates it to a device type. The system either uses an existing device type or creates a new one to match the device. When a new type is created, Model Name and Manufacturer are set to default values that can be modified by editing the device type.

Figure 8-3 Device Type List

 

Device Type Page

The Device Type page consists of the following:

  • Device Type List —This list displays all the available device types in the system. From here:

Click to refresh the list.

Click to add a new device type to the system.

Click to delete a device type from the system.

  • Device Type Editor —Click a device name from the Device Type list to open the Device Type Editor. Use the Device Type Editor to create or edit device types. From here:

Click to clone and create a new device type based on the current settings. This option appears only when you are editing a pre-existing device type.

Click to expand the Device Types Editor window to full size. To restore the window to its original size when in full-size mode, click again.

Click to close the editor and discard your changes.

Click to save changes to the device type.

Adding a Device Type

To add a device type:


Step 1 On the Administration tab, click Device Types .

Step 2 Click .

Step 3 Enter the device name in the Hardware Version field.

Step 4 Enter the device product class in the Product Class field.

Step 5 From the WAN Interface Type menu, select the WAN interface type.

Step 6 Enter the model name in the Model Name field.

Step 7 Enter the manufacturer name in the Manufacturer field.

Step 8 Enter a URL to a product icon (if desired) in the Product Icon URL field. The icon can be no bigger than 64 x 64 pixels high and wide.

Step 9 Click .


 

Editing a Device Type

To edit a device type:


Step 1 On the Administration tab, click Device Types .

Step 2 Select the device name from the Device Types list.

The system displays the Device Types Editor window.

Step 3 Manually edit the fields.

Step 4 Click .


 

Deleting a Device Type

To delete a device type:


Step 1 Locate the device type to delete from the Device Types List.

Step 2 Click to remove a device type from the system. The system refreshes the page, listing the remaining device types.


 

Managing Firmware Versions

Use the Firmware List window (Figure 8-4) to manage firmware versions for the CPE.

Figure 8-4 Firmware List Window

 

From this window, you can see various firmware for device types and track upgrade paths to verify that each upgrade is compatible with the previous firmware. If a subscriber’s current system has errors, you might want to update or downgrade the firmware running on the subscriber’s device.

Firmware List Window

The Firmware List window consists of the following:

  • Firmware List —Displays a list of all available firmware versions for all CPE models available on the system.

Click to add a new firmware release to the list.

Click to refresh the list.

Click to delete a firmware release from the system.

  • Firmware Editor —Use the Firmware Editor to create new firmware releases or edit existing firmware releases.

Click to create a new firmware release based on the current settings.

Click to expand the Firmware Editor window to full size. To restore the window to its original size when in full-size mode, click again.

Click to close the editor and discard your changes.

Click to save the changes to the firmware.

Adding a Firmware Version

To add a firmware version:


Step 1 On the Administration tab, click Firmware .

Step 2 Click .

The system displays the Firmware Editor window.

Step 3 From the Device Type drop-down list, choose the model of a device to associate the firmware version to.

Step 4 Enter the software version number in the Software Version field.

Step 5 Enter a release date in the Release Date field. You can click to open up a calendar to select a release date as well.

Step 6 Specify a web location for the firmware in the Binary URL field.


Note You do not upload firmware directly to Prime Home. The URL must be accessible to the device.


Step 7 Click .


 

Editing a Firmware Version

To edit a firmware version:


Step 1 On the Administration tab, click Firmware .

Step 2 Select the firmware version from the Firmware List.

The system displays the Firmware Editor window with the firmware version info.

Step 3 Manually edit the fields.

Step 4 Click .

You can clone a firmware version to quickly create new update releases that contain information similar to that of the previous firmware.


 

Cloning a Firmware Version

To clone a firmware version:


Step 1 Click to create a new firmware version based on current settings.

Step 2 Edit and adjust the information in the Firmware Editor.

Step 3 Click .


 

Managing Services

Use the Services window (Figure 8-5) to manage services offered by your company. You can create new services and edit them directly in this window.

When you are done setting up your services on this window, you can activate or deactivate the service on your customers’ devices from the Customer Support tab.

Figure 8-5 Services Window

 

Services Window

The Services window comprises the following:

  • Services —A list of all services in the system.

Click to force a refresh of all services and refresh the service list.

Click to add a new service.

Click to delete a service. (This option is only available for custom services.)

Click to save the service.

  • User Interface Groups —Lets you create groups of services, which control how services are grouped together onscreen.

Click to add a new user interface group.

Click to delete a user interface group. (Only available for custom groups.)

Click to save the user interface group.

Adding a New Service

To add a new service:

1. Add service information. For details, see Adding Service Information.

2. Configure When Enabled properties. For details, see Configuring When Enabled Properties.

3. Configure When Disabled properties— Add the settings, user interfaces, and actions as described in Step 2.

4. Click .

Adding Service Information

To add service information:


Step 1 On the Administration tab, click Services .

Step 2 Click to open the Service Editor window (Figure 8-6).

Step 3 In the Name field, enter the name of the service. (This name appears in the list of services on the Customer Support tab or on the subscriber’s control panel.)

Step 4 In the Code field, enter a unique identifier for this service.

Step 5 In the Color field, click the field to display the color picker. Use the sliders to select a color, or enter RGB, HSB, or hex color values. Click to set the color.

The color appears next to the service name on the Customer Support tab.

Step 6 From the Status menu, choose Active or Inactive . (Active services appear on the Customer Support tab; inactive ones do not.)

Step 7 Do one of the following:

  • Check the Is Always Enabled check box for services that are always enabled.
  • Uncheck the Is Always Enabled check box for services that can be enabled and disabled on the Customer Support tab.

Note If a service is always enabled, you can configure only the When Enabled User Interface properties.


Figure 8-6 Service Editor Window

 

Step 8 Choose where and how to display this service:

  • Portal Display—Determines where this service appears in the Services list on the Customer Support tab.
  • Control Panel Display—Determines where this service appears in the subscriber’s control panel.

From the Group menu, select the user interface group under which this service will appear.

In the Order field, type a number indicating the order for this service within the group. Smaller numbers appear closer to the top.


 

Configuring When Enabled Properties

To configure the properties for a service that has been enabled:


Step 1 Configure the access level (to specify whether subscribers can modify settings for this service):

a. In the Access Level section, click Add Setting .

b. Enter the element of the data model that describes the setting (for example, settings.enabled.timeblocking).

c. From the menu, choose None to deny access or Modify to allow access.

d. Repeat steps a through c for each access level you want to add.

Step 2 Configure the user interface. This lets you control information and settings that are displayed for different user interface areas related to this service, both on the Customer Support tab and on the subscriber’s control panel.

a. In the User Interface section, click Add User Interface .

b. From the Slot menu, choose how much information to display:

Detail —Shows detailed information and settings for the selected user interface area. It appears in the window for the service on the Customer Support tab and the subscriber control panel.

Summary —Information is a brief read-only version of the settings for this user interface. It appears in the left navigation of the subscriber’s control panel.

Help —Lets you display helpful information in the subscriber’s control panel.

Status —Reserved for future use.

LAN Device Detail —Appears within the control panel when the user is viewing a particular local device. It shows device-specific information and settings for the service.

LAN Device Summary —Appears on the subscriber’s control panel when they pause the mouse over a device.

c. From the menu, choose one of the available user interfaces.

d. Enter values for Portal Order and Control Panel Order to determine the order in which user interface information is displayed. Smaller numbers appear closer to the top.

e. Select the roles the user interface is visible to:

Admin —Appears to Admin users only.

CSR —Appears to CSR users only.

Subscriber —Appears on the subscriber’s control panel.

f. Repeat steps a through e to add additional user interfaces.

Step 3 Configure Actions.

a. In the Actions section, click Add Action .

b. From the Actions menu, choose an action:

sync app —Synchronizes an application. Choose the application from the Application menu.

run script —Runs a script. Choose a script from the menu.

set attribute value —Sets a value for a data model element. Enter the setting and value. Check the Force check box to change the value regardless of prior setting; uncheck the Force check box to leave an existing value unchanged.

remove attribute —Removes a setting from the data model. Enter the data model element.


 

Editing a Service

To edit a service:


Step 1 On the Administration tab, click Services .

Step 2 Locate the service from the Services List.

Step 3 Edit any field.

Step 4 Click .


 

Managing User Interface Groups

User interface groups let you control how services are grouped together on the Prime Home Customer Support tab and on the subscriber’s control panel. Once you have created the groups that make sense for your users, you then assign new and existing services to those groups.

Adding a User Interface Group

To add a user interface group:


Step 1 On the Administration tab, click Services .

The system displays the User Interface Groups window.

Step 2 In the User Interface Groups window, click .

Step 3 In the Code field, enter a unique identifier for this group.

Step 4 In the Name field, enter the name of the group.

Step 5 In the Order field, type a number indicating where you want this group to appear in the list. Smaller numbers appear closer to the top.

Step 6 From the Realm menu, choose where this group appears:

  • Portal—Appears on the Prime Home Administrator tab in the Services list.
  • Control Panel—Appears on the screen used by subscribers to manage their services.

Step 7 Click .


 

Editing a User Interface Group

To edit a user interface group:


Step 1 On the Administration tab, click Services .

Step 2 Locate the service in the User Interface Group window.

Step 3 Edit any field.

Step 4 Click .


 

Deleting a User Interface Group


Note Only custom user interface groups can be deleted from the system.


To delete a user interface group:


Step 1 In the User Interface Groups window, locate the group you want to delete.

Step 2 Click to delete your custom group from the system. The system refreshes the page, listing the remaining groups.


 

Managing Scripts


Note Your system might restrict script editing based on your license with Cisco. If your license restricts editing scripts, you cannot add new scripts or edit the source of existing scripts. You can change a script’s name field and the Usable With option field.


Scripts are implemented using a customized JavaScript-based environment that runs on the ACS. This environment supports complete manipulation of the CPE via TR-069, as well as access to data models stored locally on the ACS, such as the subscriber’s.

Use the Scripts window (Figure 8-7) on the Customer Support tab to manage scripts on your system. You can add new scripts, edit existing scripts, or delete custom scripts. When a device checks into the system, scripts are executed on the device in the order in which they were put into the queue.

Figure 8-7 Scripts Window

 

Prime Home contains two types of scripts:

  • Bundled scripts —Scripts that are bundled with Prime Home.
  • Custom scripts —Scripts that you set up and apply to your own network.

All script names must be unique. When writing custom scripts, write them with the idea that the script will run against one device at a time. Scripts that run on a device that is associated with a subscriber have access to the subscriber’s information.

For more information on building scripts, contact Cisco Advanced Services.

Scripts Window

The Scripts window comprises the following:

  • Script List —This list displays all existing scripts. The Name column displays the action name. The Labels column displays any labels applied to the script. From here, you can:

Click to refresh the Script List.

Click to add a new script.

Select a script from the list to edit it in the Script Editor.

Click to delete a script. (Only available for custom scripts.)

  • Script Editor —The Script Editor allows you to write new scripts or edit existing ones. From here:

Click to expand the Script Editor to full size. When in full-size mode, click to restore the window to its original size.

Click to close the editor and discard your changes.

  • Script Labels —Apply labels to the script currently selected. From here, click
  • to save your changes.

Adding a New Script

To add a new script:


Step 1 On the Administration tab, click Scripts .

Step 2 Click .

The system displays the Script Editor window.

Step 3 In the Name field, enter the name of the script.

Step 4 In the Code field, enter a unique identifier for this script.

Step 5 Select where you want the script to execute. You can select more than one of the following locations:

  • Users —Script executes on user accounts.
  • Events —Script executes upon specific events.
  • Bulk Operations —Script executes during bulk operations.
  • Services —Script executes on services.

Step 6 Click Add New Parameter and specify a type, name, and description. Click Add Another Parameter to add additional parameters.

Step 7 In the JavaScript Source text box, enter the code for the script.

Step 8 Select a script label, if appropriate to the action.

Step 9 Click .


 

Editing a Script


Note You can edit any script in the system.


To edit a script:


Step 1 On the Administration tab, click Scripts .

Step 2 In the Script List, select the name of the script to edit.

The system displays the Script Editor window.

Step 3 Make changes to any of the fields.

Step 4 Click .


 

Deleting a Script


Note Only custom scripts can be deleted from the system.


To delete a script:


Step 1 In the Script List, locate the script you want to delete.

Step 2 Click to delete your custom script from the system. The system refreshes the page, listing the remaining scripts.


 

Managing Events

An event is a predefined occurrence on a CPE that triggers scripts at specified moments. Events represent various points within the device's lifecycle. You cannot add new events to the list, but you can add new scripts to be run at each event point. An event can have multiple scripts. However, each script needs to be added one at a time.

Prime Home defines the following types of events:

  • Initial Contact —Occurs when the server sees the CPE appear on its network for the first time.
  • Subscriber Associated —Occurs when a device is associated to a subscriber. This event also occurs when a future device informs for the first time.
  • Reboot —Occurs when the CPE reboots due to a power outage or specific request. This event also typically occurs with Initial Contact.
  • Service Enable —Occurs after a service is enabled on a device.
  • Service Disable —Occurs after a service is disabled on a device.
  • Firmware Upgraded —Occurs when firmware is upgraded.
  • Inform —Occurs every time the CPE contacts the server, after any previously scheduled actions have run. Because this happens so frequently, it is a good idea to avoid using this event as a script trigger and to find a different way to accomplish your goal. For example, Reboot is generally a better alternative for reporting purposes.

Events Window

Use the Events window (Figure 8-8) on the Administration tab to manage events and their actions. You can add new actions to events and rearrange the order in which the actions execute.

Figure 8-8 Events Window

 

The Events window comprises:

  • Event List —Shows a list of all available events for the CPE. Click the event name from the list to open the Event Editor.
  • Event Editor —Use the Event Editor to add new event actions or edit existing event actions. From here, you can:

Click to expand the Event Editor window to full size.

When in full-size mode, click to restore the window to its original size.

Click to cancel the event and discard your changes.

Click to save your changes.

Adding a New Event Action

To add a new event action:


Step 1 On the Administration tab, click Events .

Step 2 Select an event from the Events List.

The system opens the Event Editor window.

Step 3 Select an action from the Action drop-down list.

Step 4 Click to add the action to the event. Some actions require user input to complete and display the appropriate fields.

Step 5 Click .


 

Editing an Event Action

To edit an event action:


Step 1 On the Administration tab, click Events .

Step 2 In the Event List, select the name of the event.

Step 3 In the Event Editor, click the name of the action.

Step 4 Edit the properties for the action, if any.

Step 5 Use the and icons to rearrange the order in which the actions execute.

Step 6 Click .


 

Deleting an Event Action

To delete an event action:


Step 1 On the Administration tab, click Events .

Step 2 In the Event List, select the name of an event.

Step 3 Click next to the action you want to delete from the event.

Step 4 Click .


 

Managing Announcements

You can create custom announcements to communicate with your CSRs. For example, you can use announcements to alert CSRs to problems or to issue reminders about new services.


Note The location of the announcements depends on how your Prime Home installation is configured. Announcements can be configured as a standalone service, or an announcements panel can be added to another service.


Prime Home supports the following types of announcements:

 

 

Information

 

Warning

 

Alert

Using the Announcements Editor

Use the Announcements editor (Figure 8-9) to create your announcements.

Figure 8-9 Announcements Editor

 

Adding a New Announcement

To add a new announcement:


Step 1 On the Administration tab, click Announcements .

Step 2 Click to add a new announcement.

Step 3 From the Announcement Type menu, choose an announcement type.

Step 4 Enter the announcement text.

Step 5 Click .


 

Editing an Announcement

To edit an announcement:


Step 1 On the Administration tab, click Announcements .

Step 2 Edit announcements as desired.

Step 3 Click .


 

Deleting an Announcement

To delete an announcement:


Step 1 On the Administration tab, click Announcements .

Step 2 Locate the announcement to delete and click Delete .


 

Managing Device Synchronization

The Synchronization window (Figure 8-10) lets you view parameters that can be synchronized between the device and server. You can see which applications need to be initialized or synchronized, and you can select items to synchronize. Use the Synchronization window to assess any synchronization failures that occur when you use the primary tools under the Account and Services menus (on the left sidebar).


Caution Do not use the Synchronization window for routine synchronizing of applications. This function is exposed for deep level troubleshooting and requires training for use. Instead, use the primary tools under the Account and Services drop-down menus; doing so invokes multiple applications that synchronize the entire device, not just parts of the device.

Figure 8-10 Synchronization Window

 

 

Resolving Synchronization Failures

If you receive a “failed to sync” error while using the primary tools under the Account and Services menu, do the following:


Step 1 Expand the Advanced drop-menu on the left sidebar.

Step 2 To the right of the Synchronization option, click view .

The Synchronization window opens.

Step 3 In the State column, locate the “Failed” notification and check the corresponding Pending Sync check box.

Step 4 Click Save to force the selected application to resynchronize.

Step 5 Verify that the “failed to sync” error clears.