Cisco Cisco Prime Collaboration 10.6 User Guide

 

 

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

Page 65 of 2 

•  image-consumer 

After you have built an image, or installed an image on another platform, run the following Ant commands from the 

CUPM\sep\ipt\nbi-sdk\sample directory: 

•  setup-axis2-tomcat—Generates an AXIS2.war file from a new AXIS2 installation, then copies and 

expands that AXIS2.war file into a Tomcat installation. 

•  deploy-consumer—Installs the notification consumer in a version of Tomcat with AXIS2 installed and 

expanded. 

Running SDK Sample Clients 

After you have prepared your image directory, run the SDKSetup.bat command to set the appropriate environment 

variables and test the connection with the simple ping command. If you prefer to manually prepare your 

environment, set the environment variable. 

You now have access to the following SDK commands: 

•  SdkQueryEnvVar—Displays all Environment Variables that are used by the SDK clients, along with their 

current settings. 

•  ValidateRequest <XML-File>—Validates an XML file that contains any NBI request. The SAX parser 

performs the validation against the appropriate XSD file. 

•  PingRequest <Optional Arguments>—Sends a ping request to the specified Prime Collaboration 

Provisioning server and sets the EPR to the notification consumer service. 

Note: The Server URL and Notification Consumer URL can be specified by the environment variables, or by 
arguments on the command line. An argument of -h provides a description of the command arguments. 

•  SendXmlRequest <XML-File>—This client reads an XML file. It optionally substitutes the EPR in the file 

with the one specified by the environment variables. It optionally substitutes the setting for the idPrefix. It 

then sends the request and prints the response. If the request sends a notification, it is printed in the 

Tomcat command window by the notification consumer service. 

Environment Variables 

The sample NBI clients allow you to set the server information and notification either on the command line, or by 

using environment variables. The environment variables enable you to issue a set of requests to one server and 

receive notifications at one URL. It may be easier for you to set parameters using environment variables instead of 

setting them every time on the command line. 

 

Table 10: Environment Variables