Cisco BBSM 5.3 SDK Developer Interface Guide - 2 - Getting Started [Cisco Building Broadband Service Manager]

Table Of Contents

Getting Started

System Requirements

Installing the BBSM 5.3 Interface SDK

Installing the BBSM 5.3 AppWizards

Uninstalling the BBSM 5.3 Interface SDK

Stopping and Restarting BBSM Services

Getting Started

Before you start your project, make sure that your system meets the required requirements. Refer to these sections:

•System Requirements

•Installing the BBSM 5.3 Interface SDK

•Installing the BBSM 5.3 AppWizards

•Uninstalling the BBSM 5.3 Interface SDK

•Stopping and Restarting BBSM Services

System Requirements

You can develop access, accounting, and PMS protocol policies by using the BBSM Interface SDK on any of these systems:

•PC running Windows 2000 with Service Pack 4

•PC running Windows XP with Service Pack 1

•BBSM 5.3 server

If you install the Interface SDK on a non-BBSM system, you must have at least 500 MB of free space on your C drive. Even though you can develop your module on any system that meets the specified requirements, you do need a dedicated BBSM server to debug and test your custom module.

You need the following software to develop and build your custom modules:

•Microsoft Visual Studio .NET 2003 (Visual C++)

•Adobe Acrobat Reader (to view the SDK documentation)

(You cannot install the BBSM 5.3 Interface SDK on BBSM 5.0, 5.1, or 5.2 servers.)

Installing the BBSM 5.3 Interface SDK

This section describes how to install the BBSM 5.3 Interface SDK on your BBSM server. The SDK installs sample projects to c:\BBSM_SDK.

For information on viewing and building sample DLLs, refer to the sample DLL section in the relevant chapter, such as the "Viewing the Sample Accounting Policy Code" section.

Caution Although you can install the Microsoft development environment on a deployable BBSM server, make sure that your server is offline before you start development. Be sure to remove the development environment before you bring the server back online.

Step 1 Log on to the software download website for BBSM 5.3:

http://www.cisco.com/pcgi-bin/tablebuild.pl/bbsm53

Step 2 From the Select a File to Download menu, choose BBSM5.3SDK.exe. The Software License Agreement appears.

Step 3 Scroll to the bottom of the page and then click Accept. The Download web page appears.

Step 4 Double-click the BBSM5.3SDK.exe file and save it to a temporary folder on your hard drive.

Step 5 In the temporary folder, double-click the BBSM5.3SDK.exe file. The BBSM SDK - Installation Folder appears.

Step 6 Extract the files to the default temporary folder or browse to the desired folder. The BBSM SDK Setup Wizard starts and the Welcome window appears.

Step 7 Click Next. The Software License Agreement appears.

Step 8 Click Yes. Wait as setup copies the necessary files to your server and installs BBSM SDK. The Setup Complete window appears.

Step 9 To complete the installation, click Finish.

Installing the BBSM 5.3 AppWizards

Follow this procedure to install the Cisco BBSM 5.3 AppWizards:

Step 1 Open Windows Explorer and navigate to the c:\BBSM_SDK\AppWizards folder.

Step 2 Copy the following files to your vc7\vcprojects folder.

The default folder is c:\Program Files\Microsoft Visual Studio .NET 2003\vc7\vcprojects.

•AppWizAccessPolicy\AppWizAccessPolicy.ico

•AppWizAccessPolicy\AppWizAccessPolicy.vsdir

•AppWizAccessPolicy\AppWizAccessPolicy.vsz

•AppWizAccessPolicyASP\AppWizAccessPolicyASP.ico

•AppWizAccessPolicyASP\AppWizAccessPolicyASP.vsdir

•AppWizAccessPolicyASP\AppWizAccessPolicyASP.vsz

•AppWizAccountingPolicy\AppWizAccountingPolicy.ico

•AppWizAccountingPolicy\AppWizAccountingPolicy.vsdir

•AppWizAccountingPolicy\AppWizAccountingPolicy.vsz

•AppWizPMSProtocol\AppWizPMSProtocol.ico

•AppWizPMSProtocol\AppWizPMSProtocol.vsdir

•AppWizPMSProtocol\AppWizPMSProtocol.vsz

Uninstalling the BBSM 5.3 Interface SDK

Follow this procedure to uninstall the BBSM 5.3 Interface SDK:

Step 1 Using Windows Explorer, delete the c:\BBSM_SDK folder and all subfolders.

Step 2 Navigate to the c:\Program Files\Microsoft Visual Studio .NET 2003\vc7\vcprojects folder.

Step 3 Delete all the Cisco AppWizard files listed in the "Installing the BBSM 5.3 AppWizards" section.

Stopping and Restarting BBSM Services

If you are building a sample access, accounting, or PMS protocol policy DLL on a BBSM server, you must stop BBSM services to ensure that the DLL is not in use, build the sample DLL, and restart services.

Follow these procedures to stop and restart BBSM services:

Step 1 Stop BBSM services. Note that if you do not stop these services, you may not be able to build your project:

a. Open the Services application from Start > Programs > Administrative Tools > Services.

b. Stop each of these services—AtDial, athdmn, WebPrint, and PMSTestService. Right-click the service. Then, from the pop-up menu, click Stop and wait for the service to stop.

c. Stop IIS Admin Service. Right-click the service. Then, from the pop-up menu, click Stop, then click Yes, and wait for the service to stop.

d. Close the Services application.

Step 2 Build your DLL.

Step 3 Restart BBSM services:

a. Choose Start > Programs > Administrative Tools > Services.

b. Restart each of the following services —AtEvent, AtDial, athdmn, WebPrint, and PMSTestService. Right-click the service. Then, from the pop-up menu, click Start and wait for the service to start.

c. Start each of these services—FTP Publishing Service, Routing and Remote Access, and World Wide Web Publishing Service. Right-click the service. Then, from the pop-up menu, click Start and wait for the service to start.

d. Close the Services application.

	Cisco BBSM 5.3 SDK Developer Interface Guide
	2 - Getting Started
Cisco BBSM 5.3 SDK Developer Interface Guide Index Preface 1 - Introduction 2 - Getting Started 3 - Creating Access Policy Modules 4 - Creating Accounting Policy Modules 5 - Creating PMS Protocol Modules 6 - Debugging Tips A - Requesting and Installing a Test SSL Certificate on a BBSM Server Glossary	Download this chapter 2 - Getting Started Download the complete book Cisco BBSM 5.3 Interface SDK Developer Guide (PDF - 2 MB) Feedback Table Of Contents Getting Started System Requirements Installing the BBSM 5.3 Interface SDK Installing the BBSM 5.3 AppWizards Uninstalling the BBSM 5.3 Interface SDK Stopping and Restarting BBSM Services Getting Started Before you start your project, make sure that your system meets the required requirements. Refer to these sections: •System Requirements •Installing the BBSM 5.3 Interface SDK •Installing the BBSM 5.3 AppWizards •Uninstalling the BBSM 5.3 Interface SDK •Stopping and Restarting BBSM Services System Requirements You can develop access, accounting, and PMS protocol policies by using the BBSM Interface SDK on any of these systems: •PC running Windows 2000 with Service Pack 4 •PC running Windows XP with Service Pack 1 •BBSM 5.3 server If you install the Interface SDK on a non-BBSM system, you must have at least 500 MB of free space on your C drive. Even though you can develop your module on any system that meets the specified requirements, you do need a dedicated BBSM server to debug and test your custom module. You need the following software to develop and build your custom modules: •Microsoft Visual Studio .NET 2003 (Visual C++) •Adobe Acrobat Reader (to view the SDK documentation) (You cannot install the BBSM 5.3 Interface SDK on BBSM 5.0, 5.1, or 5.2 servers.) Installing the BBSM 5.3 Interface SDK This section describes how to install the BBSM 5.3 Interface SDK on your BBSM server. The SDK installs sample projects to c:\BBSM_SDK. For information on viewing and building sample DLLs, refer to the sample DLL section in the relevant chapter, such as the "Viewing the Sample Accounting Policy Code" section. Caution Although you can install the Microsoft development environment on a deployable BBSM server, make sure that your server is offline before you start development. Be sure to remove the development environment before you bring the server back online. Step 1 Log on to the software download website for BBSM 5.3: http://www.cisco.com/pcgi-bin/tablebuild.pl/bbsm53 Step 2 From the Select a File to Download menu, choose BBSM5.3SDK.exe. The Software License Agreement appears. Step 3 Scroll to the bottom of the page and then click Accept. The Download web page appears. Step 4 Double-click the BBSM5.3SDK.exe file and save it to a temporary folder on your hard drive. Step 5 In the temporary folder, double-click the BBSM5.3SDK.exe file. The BBSM SDK - Installation Folder appears. Step 6 Extract the files to the default temporary folder or browse to the desired folder. The BBSM SDK Setup Wizard starts and the Welcome window appears. Step 7 Click Next. The Software License Agreement appears. Step 8 Click Yes. Wait as setup copies the necessary files to your server and installs BBSM SDK. The Setup Complete window appears. Step 9 To complete the installation, click Finish. Installing the BBSM 5.3 AppWizards Follow this procedure to install the Cisco BBSM 5.3 AppWizards: Step 1 Open Windows Explorer and navigate to the c:\BBSM_SDK\AppWizards folder. Step 2 Copy the following files to your vc7\vcprojects folder. The default folder is c:\Program Files\Microsoft Visual Studio .NET 2003\vc7\vcprojects. •AppWizAccessPolicy\AppWizAccessPolicy.ico •AppWizAccessPolicy\AppWizAccessPolicy.vsdir •AppWizAccessPolicy\AppWizAccessPolicy.vsz •AppWizAccessPolicyASP\AppWizAccessPolicyASP.ico •AppWizAccessPolicyASP\AppWizAccessPolicyASP.vsdir •AppWizAccessPolicyASP\AppWizAccessPolicyASP.vsz •AppWizAccountingPolicy\AppWizAccountingPolicy.ico •AppWizAccountingPolicy\AppWizAccountingPolicy.vsdir •AppWizAccountingPolicy\AppWizAccountingPolicy.vsz •AppWizPMSProtocol\AppWizPMSProtocol.ico •AppWizPMSProtocol\AppWizPMSProtocol.vsdir •AppWizPMSProtocol\AppWizPMSProtocol.vsz Uninstalling the BBSM 5.3 Interface SDK Follow this procedure to uninstall the BBSM 5.3 Interface SDK: Step 1 Using Windows Explorer, delete the c:\BBSM_SDK folder and all subfolders. Step 2 Navigate to the c:\Program Files\Microsoft Visual Studio .NET 2003\vc7\vcprojects folder. Step 3 Delete all the Cisco AppWizard files listed in the "Installing the BBSM 5.3 AppWizards" section. Stopping and Restarting BBSM Services If you are building a sample access, accounting, or PMS protocol policy DLL on a BBSM server, you must stop BBSM services to ensure that the DLL is not in use, build the sample DLL, and restart services. Follow these procedures to stop and restart BBSM services: Step 1 Stop BBSM services. Note that if you do not stop these services, you may not be able to build your project: a. Open the Services application from Start > Programs > Administrative Tools > Services. b. Stop each of these services—AtDial, athdmn, WebPrint, and PMSTestService. Right-click the service. Then, from the pop-up menu, click Stop and wait for the service to stop. c. Stop IIS Admin Service. Right-click the service. Then, from the pop-up menu, click Stop, then click Yes, and wait for the service to stop. d. Close the Services application. Step 2 Build your DLL. Step 3 Restart BBSM services: a. Choose Start > Programs > Administrative Tools > Services. b. Restart each of the following services —AtEvent, AtDial, athdmn, WebPrint, and PMSTestService. Right-click the service. Then, from the pop-up menu, click Start and wait for the service to start. c. Start each of these services—FTP Publishing Service, Routing and Remote Access, and World Wide Web Publishing Service. Right-click the service. Then, from the pop-up menu, click Start and wait for the service to start. d. Close the Services application.
	Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks