cc/td/doc/product/rtrmgmt/csrc/101/ur
hometocprevnextglossaryfeedbacksearchhelp

Table of Contents

Using User Registrar

Using User Registrar

The cable subscriber interacts with User Registrar through the User Registrar Subscriber Web UI, which consists of pages that allow the subscriber to do the following:

Note The following sections describe each of the pages in the User Registrar Subscriber application. The pages are referred to by their file names.

User Registrar User Interface

The User Registrar Subscriber Web UI has common user interface tools that appear on every page.

User Registrar Toolbar

The User Registrar Toolbar (Figure 2-1) appears in the upper right corner on each of the User Registrar pages. The toolbar consists of the following buttons:

You can configure when this button is displayed. For more information about configuring when to display this button, see the "Logout Mode" section.

Figure 2-1: User Registrar Subscriber Toolbar


Back Button

Subscribers should not use their Web browser's Back button to retrace their steps. The subscriber registration is based on a wizard-like application in which one screen builds on another. If subscribers use the Back button, User Registrar displays the invalid_nav page (Figure 2-2).


Figure 2-2: The invalid_nav Page


Subscriber Redirection

You can configure User Registrar Subscriber so that no matter what URL unprovisioned subscribers type, they will always reach your Login page.

Usually when a user types a Web address, such as www.abc.com the Web browser looks for the file index.html. As a post User Registrar installation step, you might want to setup the index.html page as a welcome message whereas other customers might want to direct subscribers immediately to activation. For the latter, simply create a link or copy of the ur-redirect.html page to index.html in your Web server's doc area.

For example, the user starts up a Web browser on an unprovisioned system and the browser defaults to a URL on the netscape system.

http://home.netscape.com/news/online.html

The DNS server will return the IP address of home.netscape.com as the IP of ur.abc.com; however the Web browser will not know that it is not getting a page from netscape.com.

To the server the request to ur.abc.com will look like:

http://ur.abc.com/news/online.html

One of theWeb server configuration steps is to set up the error code for unknown page requests (404 Not Found) to return the ur-redirect page. So, when subscribers request the initial page, they are really getting:

http://ur.abc.com/csrc/ur-redirect.html

However the Web browser still thinks it is getting:

http://home.netscape.com/news/online.html

If the ur-redirect page included only a relative redirect, the Web browser would request:

http://home.netscape.com/cgi-bin/gx.cgi/GXGUID-guid

If subscribers bookmarked this page, after they were subscribed, they would no longer be able to use their bookmark. To fix this, specify an absolute URL in ur-redirect.html so that, when the ur-redirect.html page is returned, the Web browser will properly display the current URL:

http://ur.abc.com/cgi-bin/gx.cgi/GXGUID-guid

User Registrar allows you to customize the main /index.html file, while the ur-redirect.html page serves as a way of automatically directing unsubscribed users to User Registrar Subscriber.

Enabling Redirection

To enable redirection, do the following:

Step 1 Edit the redirection page, <csrc-root>/html/ur-redirect.html, to specify the URL of your login page.

Step 2 Configure your Web server to send all 404 (missing page) errors to /csrc/ur-redirect.html.

Step 3 On the Web server dedicated to CSRC, create a symbolic link (or copy) of the /csrc/ur-redirect.html to /index.html.

In UNIX: <on one line>

    ln -s /opt/csrc/html/ur-redirect.html /usr/apache/htdocs/index.html

In NT: <on one line>

    copy c:\program files\csrc\html\ur-redirect.html
      c:\program files\apache\htdocs\index.html

Accessing User Registrar

When a subscriber starts a User Registrar session, the first page accessed is the init page. User Registrar does not display this page during normal operation.

The next page User Registrar displays depends on whether you have enabled optional pages.

If you choose not to enable either one or any of these pages, User Registrar skips that page or pages, and displays the login page. For more information about how to enable these pages, see the "Customizing Subscriber Pages" section.

Figure 2-3 displays the optional select_locale page. This page allows subscribers to choose the language they prefer for the User Registrar Subsriber application. Once subscribers have selected a language, User Registrar automatically displays this language when the subscriber logs in again.

Note To be able to offer this lanaguage selection, you need to have created User Registrar Subscriber pages in the additional languages. For more information about supporting multiple languages, see the "Using Locales" section.

Figure 2-3: The select_locale Page


Figure 2-4 displays the optional welcome page.This is an introductory page that welcomes the subscriber to the User Registrar Subscriber application.


Figure 2-4: The welcome Page


Figure 2-5 displays the optional steps page. This is a page that provides a list of steps required for self-registration.


Figure 2-5: The steps Page


Logging to User Registrar

When a subscriber starts the session, User Registrar displays one of three login pages depending on the login method and whether it recognizes the subscriber.

Note In all cases, if registered subscribers change their computer and modem, User Registrar displays the site's original login page. For example, if the original page was new_login_pinonly, that is the page User Registrar displays.

Figure 2-6 displays the Web page hierarchy of the login pages.


Figure 2-6: Login Web Pages


Figure 2-7 and Figure 2-8 display the page subscribers see when they access User Registrar for the first time, or if they have changed their computer or modem.


Figure 2-7: The new_login Page


Table 2-1 displays the fields and buttons on this page.


Table 2-1: Login to User Registrar
Field or Button Description

Specify account number

Requests that the subscriber enter an account number.

Specify PIN

Requests that the subscriber enter a PIN.

Login

Executes the login process.

Login by user name

Allows subscribers to use their user name instead of their account number to log in if they are already subscribed.

I forgot my PIN

Allows subscribers to login by account number and security response.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-2:


Table 2-2: Login to User Registrar Errors
Error Action

Invalid account number or PIN

Specify a valid account number.

An account number must be specified.

Specify an account number.

A PIN must be specified.

Specify a PIN.

Figure 2-8 displays the page subscribers see when they access User Registrar by PIN number.


Figure 2-8: The new_login_pinonly Page


Table 2-3 displays the fields and buttons on this page.


Table 2-3: PIN-Only Login to User Registrar
Field or Button Description

Specify PIN

Requests that the subscriber enter a PIN.

Login

Executes the login process.

Login by user name

Allows subscribers to use their user name instead of their account number to log in if they are already subscribed.

I forgot my PIN

Allows subscribers to login by account number and security response.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-4:


Table 2-4: PIN-Only Login to User Registrar Errors
Error Action

Invalid PIN

Specify a PIN.

A PIN must be specified.

Specify a PIN.

Figure 2-9 displays the lost_pin page. User Registrar displays this page when the subscriber has clicked I forgot my PIN. The lost_pin page requires the subscriber to enter a valid account number.


Figure 2-9: The lost_pin Page


Table 2-5 displays the fields and buttons on this page.


Table 2-5: Specify Account Number
Field or Button Description

Specify account number

Requires the subscriber to enter an account number.

Accept

Confirms the subscriber's response.

Cancel

Cancels the subscriber's response.

When the subscriber enters the correct account number, User Registrar displays the verify_account page (Figure 2-9). This page works in conjunction with the lost-pin page. It checks that the subscriber knows the answer to the account's chosen security question. If the subscriber answers the security question correctly, User Registrar displays the next normal UR subscriber page.

Note User Registrar reads the account number and the security question from the Account object in the CSRC database. For more information about the Account object, see Account Class.

Figure 2-10: The verify_account Page


Table 2-5 displays the fields and buttons on this page.


Table 2-6: Specify Security Response
Field or Button Description

Your security question

Requires the subscriber to enter the answer to the security question.

Accept

Confirms the subscriber's response.

Cancel

Cancels the subscriber's response.

Figure 2-11 displays the page subscribers see after they have registered.


Figure 2-11: The known_login Page


Table 2-7 displays the fields and buttons on this page.


Table 2-7: Login to User Registrar
Field or Button Description

Specify user name

Requests that the subscriber enter a User Registrar log-in name.

Specify password

Requests that the subscriber enter a password.

Login

Executes the login process.

I forgot my username

Allows subscribers to log in by account number and PIN.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-8:


Table 2-8: Known Login to User Registrar Errors
Error Action

Invalid user name or password.

Specify a valid user name or password.

A password must be specified.

Specify a password.

A user name must be specified.

Specify a user name.

Enabling Service Agreement

After a new subscriber has logged in to User Registrar, the next page User Registrar displays depends on how your site is configured. Your site can choose to use the optional accept_svc_agreement page (Figure 2-12) to require that the subscriber accept or decline a service agreement.

Figure 2-12 displays the optional accept_service_agreement page. When this page is enabled, User Registrar updates the Account object's AcceptedServiceAgreement attribute so that you can track when users have accepted the agreement.

Note For more information about the AcceptedServiceAgreement attribute, see Account Class.

Figure 2-12: The accept_svc_agreement Page


Table 2-9 displays the fields and buttons on this page.


Table 2-9: Accept Service Agreement
Field or Button Description

Accept

Indicates that the subscriber has accepted the service agreement.

Decline

Indicates that the subscriber has declined the service agreement.

Figure 2-13 displays the Decline the Service Agreement page. This page works in conjunction with the Review the Service Agreement page.


Figure 2-13: The confirm_decline_svc_agr Page


Table 2-10 displays the fields and buttons on this page.


Table 2-10: Decline Service Agreement
Field or Button Description

Decline

Indicates that the subscriber has declined the service agreement.

Cancel

Indicates that the subscriber has accepted the service agreement.

Figure 2-14 displays the declined_svc_agreement page. This page works in conjunction with the confirm_decline_svc_agr page.


Figure 2-14: The declined_svc_agreement Page


The subscriber can only log out from this page.

Logging In as a New User

When new subscribers log in, they must chose a username, password, service, and register their computer.

The following is the registration process with the associated Web page.

    1. Choose user name (choose_username).

    2. Confirm user name (confirm_username).

    3. Choose service (choose_service).

    4. Confirm service (confirm_service).

    5. Register computer (activate_device).

    6. Activate equipment (activate_wait or activate_reboot).

    7. Congratulations (congratulations). Only displayed if you used activate_wait.

Choosing a Username

When the subscriber clicks Login on the New Subscriber Login to User Registrar page, User Registrar displays the choose_username page (Figure 2-15). This page allows subscribers to choose a username and password.

User Registrar displays the billing information for an authenticated account, which includes the account number, username, and address. This information is the Account object in the LDAP server. For more information about the Account Class, see the "Account Class" section.


Figure 2-15: The choose_username Page


Table 2-11 displays the fields and buttons on this page.


Table 2-11: Choose User Name
Field or Button Description

Specify a user name

Requests that subscribers enter the name they want to use to log in to User Registrar.

Choose your password

Requests that subscribers enter their password.

Confirm your password

Requests that subscribers enter their password again.

Choose

Confirms the subscriber's user name and password.

Cancel

Cancels the subscriber's user name and password selection.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-12:


Table 2-12: Choose User Name Error
Error Action

User name already in use.

Enter another name.

Passwords must be at least 3 characters.

Enter a longer password.

User names must be at least 3 characters.

Enter a longer user name.

Passwords do not match.

Enter your password confirmation again

You must re-enter the password.

Confirm your password.

You must select a user name.

Enter a user name.

You must select a password.

Enter a password.

Confirming a Username

When the subscriber clicks Choose on the Choose User Name page, User Registrar displays the confirm_username page (Figure 2-16). This page displays the name the subscriber has chosen, and gives the subscriber the choice of accepting the name or choosing another name.


Figure 2-16: The confirm_username Page


Table 2-13 displays the fields and buttons on this page.


Table 2-13: Confirm Username
Field or Button Description

Selected user name

Displays the name the subscriber entered.

Accept

Confirms the subscriber's selection.

Change User Name

Cancels the selection and returns the subscriber to the Choose User name page.

Choosing a Service

When the subscriber clicks Accept on the Confirm User Name page, User Registrar displays the choose_service page (Figure 2-17). This page displays the available services and allows users to choose a service.

The information on this page is the Service object in the LDAP server. For more information about the Service class, see the "Service Class" section.


Figure 2-17: The choose_service Page


Table 2-14 displays the fields and buttons on this page.


Table 2-14: Choose Service
Field or Button Description

Name

Displays the name of the service.

Description

Displays the description of the service.

Price

Displays the price of the service.

Choose

Confirms the service change.

Cancel

Cancels the service change.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-15:


Table 2-15: Choose Service Errors
Error Action

The service selected is not valid.

Choose another service. In a properly configured system, subscribers should never get this error.

You must select a service.

Select a service.

Confirming a Service

When the subscriber clicks Choose on the Choose Service Subscription page, User Registrar displays the confirm_service page (Figure 2-18). This page allows subscribers to confirm their service selection.


Figure 2-18: The confirm_service Page


Table 2-16 displays the fields and buttons on this page.


Table 2-16: Confirm Service
Field or Button Description

Service selected

Displays the service the subscriber selected.

Accept

Confirms the subscriber's selection.

Change Service

Allows subscribers to change their service selection.

Activating a Computer

When the subscriber clicks Accept on the Confirm Service Subscription page, User Registrar displays the activate_device page (Figure 2-19). This page allows subscribers to register their computers.

User Registrar displays this page the first time the subscriber accesses User Registrar. For subsequent computer activations, User Registrar displays the add_computer and update_computer pages. For more information about these pages see the "Registering Computers" section.

The subscriber can choose a new hostname and description.


Figure 2-19: The activate_device Page


Table 2-17 displays the fields and buttons on this page.


Table 2-17: Register Computer
Field or Button Description

Choose computer name

Requests that subscribers enter the hostname of their computer.

Choose description

Requests that subscribers enter a description for their computer.

Activate

Verifies the hostname the subscriber chose.

Cancel

Exits User Registrar.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-18:


Table 2-18: Registrar Computer Errors
Error Action

Computer already in use.

Choose another name.

You must select a description

Enter a computer description

Reconfiguring a Computer

When the subscriber clicks Activate on the Register Computer page, User Registrar displays the activate_wait or activate_reboot page (Figure 2-20). This page tells subscribers that User Registrar is activating their computer and modem.

You can decide whether you want subscribers to wait while User Registrar reconfigures their computer or you can ask subscribers to reboot their computers.


Figure 2-20: The activate_reboot Page


During the activation phase, User Registrar does the following:

When subscribers come back online, they have access to the Internet.

Logging in as a Known User

When registered subscribers log in to User Registrar, they can change their password service, their computer's name or description, or delete their computer.

If they have changed their computer or modem since they last logged in, User Registrar displays computer and modem registration pages so that subscribers can update that information.

Figure 2-21 displays the Web-page hierarchy for known subscribers.


Figure 2-21: Known Subscriber Web Pages


Updating Subscriber Information

When registered subscribers log in from the known_login page and their equipment has not changed since the registration, User Registrar displays the subscriber_info page (Figure 2-23). This page allows subscribers to view their current information, and make changes or deletions.

Figure 2-22 displays the Web-page hierarchy for the subscriber pages.


Figure 2-22: Subscriber Provisioning Web Pages



Figure 2-23: The subscriber_info Page


Table 2-19 displays the fields and buttons on this page.


Table 2-19: Subscriber Information
Field or Button Description

Account number

Displays the subscriber's account number.

Name

Displays the subscriber's name.

Address

Displays the subscriber's address.

User name

Displays the subscriber's username.

Password

Displays the subscriber's password.

Service

Displays the service the subscriber chose.

Name

Displays the name of the subscriber's computer.

Description

Displays the description of the subscriber's computer.

Change Password

Sends subscribers to the Change Password page.

Change Service

Sends subscribers to the Change Service page.

Edit

Sends subscribers to the Update Computer Information page.

Delete

Sends subscribers to the Confirm Delete Computer page.

Changing a Password

When the subscriber clicks Change Password on the Subscriber Information page, User Registrar displays the change_password page (Figure 2-24). This page allows subscribers to change their passwords. Subscribers must first enter their current password and then enter their new password. If User Registrar cannot authenticate the current password, the subscriber cannot create a new password.


Figure 2-24: The change_password Page


Table 2-20 displays the fields and buttons on this page.


Table 2-20: Change Password
Field or Button Description

Enter current password

Requests that subscribers enter their current password.

Specify new password

Requests that subscribers enter a new password.

Confirm new password

Requests that subscribers enter their password again.

Change

Confirms the password change.

Cancel

Cancels the password change.

Specify

If the subscriber neglects to enter all of the information or if the information is incorrect, User Registrar displays the errors described in Table 2-21:


Table 2-21: Change Password Errors
Error Action

Passwords must be at least 3 characters

Enter a longer password.

You current password is not correct

Enter a valid password.

New passwords do not match.

Enter the confirmation password again.

A new password must be specified.

Enter a password.

Your current password must be specified.

Enter the current password.

Changing a Service

When the subscriber clicks Change Service on the Subscriber Information page, User Registrar displays the change_service page (Figure 2-25). This page allows subscribers to change their service type.

Note  The look and offerings of this page are dependent on your company's particular business requirements and can be modified by the UR configurer. For more information about modifying User Registrar, see "Configuring User Registrar."

Figure 2-25: The change_service Page


Table 2-22 displays the fields and buttons on this page.


Table 2-22: Change Service
Field or Button Description

Name

Displays the name of the service.

Description

Displays the description of the service.

Price

Displays the price of the service.

Choose

Sends the subscriber to the Confirm Service Subscription page.

Cancel

Cancels the service change.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-23:


Table 2-23: Change Service Errors
Error Action

The service selected is not valid.

Choose another service. In a properly configured system, subscribers should never get this error.

You must select a service.

Select a service.

Confirming a Service Change

When the subscriber clicks Choose on the Change Service page, User Registrar displays the confirm_change_service page (Figure 2-26). This page allows subscribers to confirm the change of service. The page displays the service chosen and allows subscribers to accept or change their selection.


Figure 2-26: The confirm_change_service Page


Table 2-24 displays the fields and buttons on this page.


Table 2-24: Confirm Change Service
Field or Button Description

Service selected

Displays the service the subscriber chose.

Accept

Confirms the subscriber's selection.

Change Service

Allows subscribers to change their service selection.

Updating Computer Information

When the subscriber clicks Accept on the Confirm Service Subscription page, User Registrar displays the update_wait or update_reboot (Figure 2-27) page. These pages tell subscribers that User Registrar is reconfiguring their equipment. For the changes to take effect, subscribers must reboot their computers.


Figure 2-27: The update_reboot Page


If your site is using a separate pool of IP addresses for unrecognized devices, the computer receives a new address the next time it renews its DHCP lease. Any network connections that are open during the reconfiguration (such as an HTTP request for this page) are reset when the IP stack gets a new address. While the subscriber reboots the computer, User Registrar also reboots the CM.

User Registrar does following:

Changing a Computer

When the subscriber clicks Edit on the Subscriber Information page, User Registrar displays the update_device page (Figure 2-28). This page allows subscribers to change the name and description of their computers.


Figure 2-28: The update_device Page


Table 2-24 displays the fields and buttons on this page.


Table 2-25: Update Device Information
Field or Button Description

New name

Requests that the subscriber enter a new computer name.

New description

Requests that the subscriber enter a new description.

Change

Confirms the subscriber's changes.

Cancel

Cancels the subscriber's changes.

If you choose a name that already exists, User Registrar displays the error message, "Computer name already in use."

Confirming a Computer Update

When the subscriber clicks Change on the Update Computer Information page, User Registrar displays the confirm_update_device page (Figure 2-29). This page allows subscribers to confirm the computer name associated with their account.


Figure 2-29: The confirm_update_device Page


Table 2-26 displays the fields and buttons on this page.


Table 2-26: Confirm Update Computer
Field or Button Description

Rename computer

Displays the new computer name and description

Accept

Confirms the changed computer information.

Cancel

Cancels the change and returns to the subscriber to the Subscriber Information page.

Deleting a Computer

When the subscriber clicks Delete on the Subscriber Information page, User Registrar displays the confirm_delete_device page (Figure 2-30). This page allows subscribers to confirm the deletion of their computer name and its description.

Note Subscribers cannot delete the computer from which they are logged in. If they attempt to do so, User Registrar displays the error message: "You may not delete the active computer."

Figure 2-30: The confirm_delete_device Page


Table 2-27 displays the fields and buttons on this page.


Table 2-27: Confirm Delete Computer
Field or Button Description

Confirm computer deletion

Displays the computer's name and description.

Delete

Deletes the computer from the User Registrar list of registered computers.

Cancel

Cancels the change and returns the subscriber to the Subscriber Information page.

Managing Unregistered Equipment

When subscribers with unregistered equipment (modems and computer) attempt to log in, User Registrar displays pages that force equipment registration.

Registering Modems

When subscribers log in with unregistered modems, User Registrar displays the unknown_modem page (Figure 2-31). This page allows subscribers to update their modem information or cancel the update.

For more information about update_wait and update_reboot, see the "Updating Computer Information" section.

Figure 2-31: The unknown_modem Page


Table 2-28 displays the fields and buttons on this page.


Table 2-28: Unregistered Modem
Field or Button Description

Update my modem

Updates the subscriber's modem information.

Abort

Cancels the change and exits User Registrar.

Registering Computers

When subscribers log in with unregistered computers, User Registrar displays the unknown_computer page (Figure 2-33) or the max_cpe_reached page (Figure 2-32).

If the subscriber has already registered the maximum number of computers for the service, User Registrar displays the max_cpe_reached page. From this page, the subscriber has the choice of either upgrading the service or replacing a registered computer with this new computer.


Figure 2-32: The max_cpe_reached Page


The unknown_computer page allows subscribers to register a new computer or update their existing computer information.
Figure 2-33: The unknown_computer Page


Table 2-29 displays the fields and buttons on this page.


Table 2-29: Unregistered Computer
Field or Button Description

Registrar new computer

Registers a new computer.

Update computer

Updates the existing computer information.

Registering a New Computer

When the subscriber clicks Register new computer from the Unregistered Computer page, User Registrar displays the add_computer page (Figure 2-34). This page allows subscribers to specify a computer name and description for their new computer.


Figure 2-34: The add_computer Page


Table 2-30 displays the fields and buttons on this page.


Table 2-30: Registering a New Computer
Field or Button Description

Accept

Displays the update_wait or update_reboot page.

Cancel

Cancels the change and exits User Registrar.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-31.


Table 2-31: Registering a New Computer Errors
Error Action

Computer name already in use.

Choose another name.

You must select a computer name

Enter the computer name.

Reconfiguring an Existing Computer

When the subscriber clicks Update computer on the Unregistered Computer page, User Registrar displays the update_computer page (Figure 2-35). This page allows subscribers to reconfigure their computer or to cancel the change.

Tips Subscribers should choose this option if they are updating their NIC or if they are replacing their computer.

Figure 2-35: The update_computer Page


Table 2-32 displays the fields and buttons on this page.


Table 2-32: Reconfigure Existing Computer
Field or Button Description

Change

Displays the update_wait or update_reboot page.

Cancel

Cancels the change and exits User Registrar.

If the subscriber neglects to enter all the information or if the information is incorrect, User Registrar displays the errors described in Table 2-33:


Table 2-33: Reconfigure Existing Computer Errors
Error Action

The computer selected in not valid.

Select a valid computer.

You must select an existing computer.

Select a computer in the database.

Logging Out of User Registrar

The logout page allows subscribers to log out of User Registrar (Figure 2-36).


Figure 2-36: The logout Page


Table 2-34 displays the fields and buttons on this page.


Table 2-34: Log Out of User Registrar
Field or Button Description

Logout

Exits a User Registrar session.

Cancel

Returns the subscriber to the previous page.

Getting Help

The User Registrar Subscriber application has a corresponding help page for every Web page. The help consists of an HTML file with the same name as the Web page.

Note Subscribers should use the Exit Help button rather than their browser's Back button to exit help. If subscribers use their browser's Back button to return to the application, the next time they request help User Registrar will display the last help page---not the page associated with their current page.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Fri Oct 22 07:44:46 PDT 1999
Copyright 1989-1999©Cisco Systems Inc.