Cisco Cisco Prime Collaboration 10.5 Developer's Guide

 

 

© 2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 

5 

Chapter 1: Getting Started  

 

This chapter describes how to start using the Cisco Prime Collaboration Provisioning Northbound Interface (Prime 

Collaboration Provisioning NBI) as part of the Prime Collaboration Provisioning Software Development Kit (SDK) 

program. It also includes feature descriptions, sample applications, typical workflow steps, and other relevant 

information. 

This chapter contains the following sections: 

•  Description of the Prime Collaboration Provisioning NBI 

•  Feature Summary 

•  Functional Architecture 

•  Client Requirements 

•  Prime Collaboration Provisioning Web Services Resources 

•  General Prerequisites 

•  How to Use the Prime Collaboration Provisioning NBI SDK 

Description of the Prime Collaboration Provisioning NBI 

The Prime Collaboration Provisioning NBI enables external command interface. The scope of the interface is to 

manage basic IPT devices; manage Prime Collaboration Provisioning objects; submit work orders; and query the 

configured products, inventory manager, and subscriber services. 

The Web Services architecture, using WSDL/SOAP over https, provides a standards-based request/response 

interaction with Prime Collaboration Provisioning for submitting NBI requests. Following the WS-Notification 

standards, Prime Collaboration Provisioning publishes a notification which is the asynchronous result of the NBI 

request. 

Each NBI request the client sends to the server is a synchronous request message. If the Prime Collaboration 

Provisioning server accepts the NBI request for execution, the server returns a synchronous response. The Prime 

Collaboration Provisioning server executes the NBI request asynchronously. The client will receive an 

asynchronous notification with the NBI results when the Prime Collaboration Provisioning server has completed 

execution of the NBI request. 

Audience 

This guide is intended to be a technical resource for application developers who want to use the Prime 

Collaboration Provisioning NBI to provision Cisco Unified Communications deployments and implementations. 

You should have an advanced level of understanding of Internet network design, operation, and terminology, and 

have a basic understanding of the Prime Collaboration Provisioning product. 

Also, you should have an understanding of a high-level programming language such as Java, or an equivalent 

language. Additionally, you should have knowledge of the following: 

•  XML and XML Schema