Main

Redirect Reason Code for 786, 802, 818, 834 and 850 1.0

Xin Piao — 2013-02-17T01:41:59Z

Here are explaination for Redirect Reason Code 786, 802, 818, 834 and 850 *NQ_QUEUE_CALL = 786 Native Call Queuing, queue a call *NQ_DEQUEUE_CALL = 802 Native Call Queuing, dequeue a call *NQ_SECONDARY_ROUTING_NO_AGENT_LOGGEDIN = 818 Native Call Queuing, redirect tothe 2nd DN on Hunt Pilot Configuration page. *NQ_SECONDARY_ROUTING_MAX_QUEUE_DEPETH_FULL = 834 Native Call Queuing, redirect to the 2nd DN on Hunt Pilot Configuration page. *NQ_SECONDARY_ROUTING_MAX_QUEUING_TIMER_EXPIRE = 850 Native Call Queuing, redirect to the 2nd DN on Hunt Pilot Configuration page.

Frequently Asked Questions 4.2

Xin Piao — 2013-02-17T01:40:00Z

*[[http://developer.cisco.com/web/sxml/wiki/-/wiki/Main/Frequently+Asked+Questions#section-Frequently+Asked+Questions-What+are+the+user+roles+needed+to+access+the+RisPort+service?|What are the user roles needed to access the RisPort service?]] *[[http://developer.cisco.com/web/sxml/wiki/-/wiki/Main/Frequently+Asked+Questions#section-Frequently+Asked+Questions-What+SNMP+traps+are+available+for+UC+Manager+in+CISCO-CCM-MIB?|What SNMP traps are available for UC Manager in CISCO-CCM-MIB?]] *[[http://developer.cisco.com/web/sxml/wiki/-/wiki/Main/Frequently+Asked+Questions#section-Frequently+Asked+Questions-What+is+the+mapping+of+UC+Manager+alarms+to+SNMP+traps+generated?|What is the mapping of UC Manager alarms to SNMP traps generated?]] *[[http://developer.cisco.com/web/sxml/wiki/-/wiki/Main/Frequently+Asked+Questions#section-Frequently+Asked+Questions-How+can+the+various+alarms/traps+be+artificially+generated+for+development+and+testing?|How can the various alarms/traps be artificially generated for development and testing?]] *[[Redirect Reason Code for 786, 802, 818, 834 and 850|Redirect Reason Code for 786, 802, 818, 834 and 850]] == What are the user roles needed to access the RisPort service? == # Standard CCM Admin Users (provides access to the CCMAdmin domain where RisPort is hosted, but not to the CCMAdmin web UI) # Standard SERVICEABILITY Read Only (to access risport API) == What SNMP traps are available for UC Manager in CISCO-CCM-MIB? == |=Trap |=Description | | ccmCallManagerFailed | Signifies that the CallManager process detects a failure in one of its critical subsystems. It can also be detected from a heartbeat/event monitoring process | | ccmPhoneFailed | Generated in the intervals specified in ccmPhoneFailedAlarmInterval if there is at least one entry in the ccmPhoneFailedTable | | ccmPhoneStatusUpdate | Generated in the intervals specified in ccmPhoneStatusUpdateInterv if there is at least one entry in the ccmPhoneStatusUpdateTable | | ccmGatewayFailed | Indicates that at least one gateway has attempted to register or communicate with the CallManager and failed | | ccmMediaResourceListExhausted | Indicates that the CallManager has run out a certain specified type of resource | | ccmRouteListExhausted | Indicates that the CallManager could not find an available route in the indicated route list | | ccmGatewayLayer2Change | Sent when the D-Channel/Layer 2 of an interface in a SCCP gateway that has registered with the CallManager changes state | | ccmMaliciousCall | Sent when a user registers a call as malicious with the local UC Manager | | ccmQualityReport | Sent when a user reports a quality problem using the Quality Report Tool | | ccmTLSConnectionFailure | Sent when CallManager fails to open TLS connection for the indicated device | == What is the mapping of UC Manager alarms to SNMP traps generated? == |= Trap |= Alarm | | ccmCallManagerFailed | CallManagerFailure | | ccmPhoneFailed | DeviceTransientAlarm for Phone | | ccmPhoneStatusUpdate | No specific alarm. Trap sent out on periodic interval if there are any changes to Phone table | | ccmGatewayFailed | DeviceTransientAlarm for Gateway | | ccmMaliciousCall | MaliciousCall | | ccmMediaResourceListExhausted | MediaResourceListExhausted | | ccmQualityReportRequest | QRTRequest | | ccmRouteListExhausted | RouteListExhausted | | ccmGatewayLayer2Change | DChannel OOS/DChannel ISV | == How can the various alarms/traps be artificially generated for development and testing? == * **General procedure and validation** **Ensure SNMP Master Agent and Cisco CallManager SNMP Service are activated and running. **Ensure that Community string/user is configured and should contain Notify permissions as well. (Serviceability web page, SNMP -> v1/v2c or v3 -> Community string or User) **Ensure that Notification destination is configured. (Serviceability web page, SNMP -> v1/v2c or v3 -> Notification Destination) **For Phones, ensure ccmPhoneFailedAlarmInterval (1.3.6.1.4.1.9.9.156.1.9.2) and ccmPhoneStatusUpdateAlarmInterv (1.3.6.1.4.1.9.9.156.1.9.4) are set between 30 and 3600 **For Gateways, ensure ccmGatewayAlarmEnable (1.3.6.1.4.1.9.9.156.1.9.6) is set to true **If traps are still not generated: ***Check if the corresponding alarms are generated: enable alarm and setup the Alarm Event level to 'Informational' for 'Local Syslogs'. (Serviceability web page, Alarm -> Confirguration -> Select Server -> Service Group (CM Services) -> Service (Cisco CallManager)) ***Reproduce the traps and check if the corresponding alarm is logged in CiscoSyslog file (either from RTMT or CLI) ***Execute the CLI for the corresponding trap and collect the output accordingly. ****For ccmPhoneFailed trap execute CLI "show risdb query phonefailed" ****For ccmPhoneStatusUpdate trap execute CLI "show risdb query phonestatsupd" * **Traps related to Phones and Gateways (ccmPhoneStatusUpdate, ccmPhoneFailed trap and ccmGatewayFailed trap)** **To trigger ccmPhoneStatusUpdate trap ***Set ccmPhoneStatusUpdateAlarmInterv (1.3.6.1.4.1.9.9.156.1.9.4) = 30 or higher in ccmAlarmConfigInfo mib table ***Select the phone from the CUCM Admin page and RESET it. ***Phones will unregister ***Phones will re-register ***ccmPhoneStatusUpdate trap will be generated **To trigger ccmPhoneFailed trap ***Set ccmPhoneFailedAlarmInterval (1.3.6.1.4.1.9.9.156.1.9.2) =30 or higher in ccmAlarmConfigInfo mib table ***Make a phone fail: delete a phone from CM and attept to register the phone again. *** Or: configure a 7960 phone MAC as 7940 device and attempt to register **To trigger GatewayFailed trap ***Remove the configuration of the gateway from the database through Web Admin (or) Change the MAC address of the gateway to some invalid value and update. ***Reboot the gateway *** Or: restart the Cisco CallManager service to which the gateway is connected. **To trigger GatewayFailed trap (Method 2) ***Set ccmGatewayAlarmEnable=true in ccmAlarmConfigInfo MIB table ***Restart CallManager service which will cause gateway failover to the redundant UC Manager server. On that server, the gateway should not be configured in the database. **To trigger ccmGatewayLayer2Change trap ***Set ccmGatewayAlarmEnable (1.3.6.1.4.1.9.9.156.1.9.6.0) = true in ccmAlarmConfigInfo MIB table ***Change the MAC address of the gateway to some invalid value and update. ***Reset the Gateway * **Other Traps (MediaResourceListExhausted trap, RouteListExhausted trap, MaliciousCallFailed trap)** **To trigger MediaResourceListExhausted trap ***Create a Media Resource Group (MRG), have it contain an instance of the standard ConferenceBridge resource (CFB-2). ***Create a Media Resource Group List (MRGL), have it contain the MRG just created. ***In the Phone Configuration page for three phones, set MRGL as the phone's Media Resource Group List. ***Stop the IP Voice Media Streaing App which makes the ConferenceBridge resource (CFB-2) stop working. ***Make conference calls with phones that using the media list, you will see "No Conference Bridge available" on the phone screen. ***MediaListExhausted Alarm/Alert/Trap is generated **To trigger RouteListExhausted trap ***Create a Route Group (RG), have it contains one Gateway ***Create a Route Group List (RGL), have it contains the RG just created ***Create a Route Pattern (9.XXXX) that reroutes a 9XXXX call through the RGL ***Unregister the gateway ***Dial 9XXXX from one of the phones ***RouteListExhausted Alarm/Alert/Trap is generated **To trigger MaliciousCallFailed trap ***Create a softkey template. In the template, add "MaliciousCall" softkey to the phone's different statuses ***Assign the new softkey template to a phone, reset the phone ***Making a call, select "MaliciousCall" softkey during or after the call ***MaliciousCallFailed Alarm/Alert/Trap is generated * **Receiving Syslog messages as SNMP traps** **To receive syslog messages above a particular severity as traps, set the following 2 MIB objects in clogBasic table: ***clogNotificationsEnabled (1.3.6.1.4.1.9.9.41.1.1.2) -> Set this to true(1) to enable syslog trap notification. Default value is false(2). Eg: snmpset -c -v 2c 1.3.6.1.4.1.9.9.41.1.1.2.0 i 1 ***clogMaxSeverity (1.3.6.1.4.1.9.9.41.1.1.3) -> Set the severity level above which traps are desired. Default value is warning (5). All syslog messages with alarm severity lesser than or equal to configured severity level will be sent as traps if notification is enabled. Eg: snmpset -c -v 2c 1.3.6.1.4.1.9.9.41.1.1.3.0 i **Limitations are: ***Traps are sent out based on selected severity. If the given alarm is of low severity then the management application needs to set the severity threshold lower to capture this low severity alarm/trap. In other words management apps need to deal with flooding of other low severity traps ***Syslog has a standard buffer size when generating a SNMP trap message; the data is trimmed to the specified field size (255). This avoids any errors caused by data that is too large for the field. For example, if you have specified the message text field to be 255 bytes, but a message arrives that is 300 bytes, the data will be truncated to 255 bytes before being logged. ***Not enabled by default. i.e. by default clogsNotificationEnabled (1.3.6.1.4.1.9.9.41.1.1.2) is set to FALSE (2). == Redirect Reason Code for 786, 802, 818, 834 and 850 == Here are explaination for Redirect Reason Code 786, 802, 818, 834 and 850 *NQ_QUEUE_CALL = 786 Native Call Queuing, queue a call *NQ_DEQUEUE_CALL = 802 Native Call Queuing, dequeue a call *NQ_SECONDARY_ROUTING_NO_AGENT_LOGGEDIN = 818 Native Call Queuing, redirect tothe 2nd DN on Hunt Pilot Configuration page. *NQ_SECONDARY_ROUTING_MAX_QUEUE_DEPETH_FULL = 834 Native Call Queuing, redirect to the 2nd DN on Hunt Pilot Configuration page. *NQ_SECONDARY_ROUTING_MAX_QUEUING_TIMER_EXPIRE = 850 Native Call Queuing, redirect to the 2nd DN on Hunt Pilot Configuration page.

How to gather logs for RisPort 1.5

Matthew J Denapoli — 2012-09-28T21:41:11Z

To troubleshoot Risport issues, the partner needs to gather the Soap Web Service logs and the SOAP Message logs at the debug level.

To Enable these logs:

Step 1
From Cisco Unified Serviceability administration, choose Trace > Configuration.
Step 2
From the Server drop-down list, choose a server in your network.
Step 3
From the Service Group drop-down list, choose Soap Services.
Step 4
From the Service drop-down list, choose the Cisco SOAPMessage Service.
Step 5
If you want debugging to apply to all nodes, check the Apply to All Nodes check box.
Step 6
Make sure that the Trace On check box is checked.
Step 7
From the Debug Trace Level drop-down list, choose Debug. Click Save.
Step 8
Repeat for the Soap Web service log.
Step 9
In the Trace Output Settings section, set Maximum No. of Files*: 200 and Maximum File Size (MB)*: 2MB
Step 10
Click Save.

Then the partner needs to use the RTMT tool to gather the logs.

Troubleshooting 1.5

Matthew J Denapoli — 2012-09-28T21:33:20Z

Testing SXML with Telnet 2.0

Matthew J Denapoli — 2012-09-28T21:33:04Z

CUCM/AXL Version tested: 7.0(1)
Platform: Ubuntu 8.10, using telnet-ssl

Using a command-line Telnet connection to CCM, it is possible to test the secure AXL web services by sending raw text data. In this example, the Serviceability RisPort is queried for all devices, using a text editor and telnet-ssl.

The first step is to carefully devise the HTTP message to be sent to AXL. The request is made up of the type/header and body. The type/header should look something like this:

POST /realtimeservice/services/RisPort HTTP/1.1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://schemas.cisco.com/ast/soap/action/#RisPort#SelectCmDevice"
Content-Length: 1380
Authorization: Basic QWRtaW5pc3RyYXRvcjpjaXNjbyExMjM=
Host: 10.88.131.133:8443

Be sure and modify the headers as necessary to match your request:

POST - check the uri against the AXL docs to ensure it matches with the AXL service you're querying
SOAPAction - Both Administrative and Serviceability AXL need the SOAPAction header, make sure it is correct for your service/request
Content-Length - This will be the length in bytes of the 'payload' of the message, i.e. the XML
Authorization - Use Basic authorization, the username and password is in the form 'username:password' and is Base64 encoded (there are several free web-based sites/tools that can encode Base64 quickly for you.) Make sure this user is part of a group with AXL API role.
Host: this is the FQDN/IP address and port of the CCM with the AXL service on it

Each line of the type/header ends in a cr/lf, and the type/header itself should end in a blank line with cr/lf.

Next comes the message body, which is the (valid) SOAP XML for the request you want to test. Note the request will fail with 'HTTP 400 Bad Request' if there are any cr/lf's in the XML text - as will commonly occur if you have the XML formatted as multiple lines in a text editor and then copy/paste it. I solved this by removing all of the extra white space and cr/lf's, making the XML one long line in my editor.

At this point you should have something like the following:

SelectCmDevice.txt (download)

POST /realtimeservice/services/RisPort HTTP/1.1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://schemas.cisco.com/ast/soap/action/#RisPort#SelectCmDevice"
Content-Length: 1380
Authorization: Basic QWRtaW5pc3RyYXRvcjpjaXNjbyExMjM=
Host: 10.88.131.133:8443

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"...etc...

Making the request is pretty easy, simply copy the text to your clipboard, then from a command-line/terminal window:

dstaudt@ubuntu:~$ telnet -z ssl 10.88.131.133 8443
Trying 10.88.131.133...
SSL: Server has a self-signed certificate
SSL: unknown issuer: <self-signed cert info here>
Connected to 10.88.131.133.
Escape character is '^]'.

From here past the message request text into the window and press Enter twice (the message has to end with a blank line and cr/lf).

If all went well you should see and HTTP/1.1 200 OK message and your XML response text displayed:

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONIDSSO=B70632E7B77AAEE1E6524941C2E55EB6; Path=/
Set-Cookie: JSESSIONID=69F05B928C4AA7C0D86B0A523FAA0D1B; >Path=/realtimeservice; Secure
Set-Cookie: SoapSession.id=-451835773722921813
Content-Type: text/xml;charset=utf-8
Transfer-Encoding: chunked
Date: Fri, 19 Dec 2008 06:23:06 GMT

af4
<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">...etc...</soapenv:Envelope>
0

Connection closed by foreign host.

Serviceability XML Operations by Release Matrix 4.2

Matthew J Denapoli — 2012-09-28T21:33:00Z

Serviceability SOAP API Details

UCR - Under Consideration or Review
: supported, : not supported, : modified

SOAP Service	Operation	UCM 4.0	UCM 4.3	UCM 5.0	UCM 6.0	UCM 6.1	UCM 7.0	UCM 7.1	UCM 8.0	UCM 8.5	UCM 8.6
RisPort (Real Time Informtion Port)	selectCmDevice ( ipv4 devices)
	selectCtiItem (ipv4 devices)
	getServerInfo
	SelectCmDevice (includes ipv6 devices)
	selectCtiItem (includes ipv6 devices)
PerfmonPort (Performance Information Port)	perfmonOpenSession
	perfmonAddCounter
	perfmonRemoveCounter
	perfmonCollectSessionData
	perfmonCloseSession
	perfmonListInstance
	perfmonQueryCounterDescription
	perfmonListCounter
	perfmonCollectCounterData
ControlCenterServicesPort (All Service Control APIs )	soapGetStaticServiceList
	soapGetServiceStatus
	soapDoServiceDeployment
	soapDoControlServices
	getProductInformationList
LogCollectionPort (All Log Collection APIs)	listNodeServiceLogs
	selectLogFiles
CDRonDemand (All CDR APIs)	get_file_list
	get_file
DimeGetFileService (Geting Single File)	GetOneFile

Risport Case Opening Steps 4.0

Matthew J Denapoli — 2012-09-28T21:32:47Z

Open a Developer Support Case

For development issues and questions that cannot be addressed through these services, CDN also offers members the ability to open support cases with our development engineering team utilizing Cisco’s case tracking application.

For CDN Community Members: This service is available as an annual fee-based subscription. Pricing: This fee varies by theater.

For CDN Technology Partners: This service is included in your CDN Technology Partner memberships.

Learn more about purchasing a developer support subscription

To help resolve your case quickly, please provide the following information with opening a developer support case for a Risport issue.

General description of the problem
Is the problem reproducible or intermittent?
Observed vs. expected API behavior
Version Number of CUCM
Example Request/Response
Risport Logs (How to enable RisPort Logs,How to gather RisPort Logs )
Time Stamp of the Issue (If known)

Enabling Risport Logs

To troubleshoot Risport issues, the partner needs to gather the Soap Web Service logs and the SOAP Message logs at the debug level.

To Enable these logs:

Step 1
From Cisco Unified Serviceability administration, choose Trace > Configuration.
Step 2
From the Server drop-down list, choose a server in your network.
Step 3
From the Service Group drop-down list, choose Soap Services.
Step 4
From the Service drop-down list, choose the Cisco SOAPMessage Service.
Step 5
If you want debugging to apply to all nodes, check the Apply to All Nodes check box.
Step 6
Make sure that the Trace On check box is checked.
Step 7
From the Debug Trace Level drop-down list, choose Debug. Click Save.
Step 8
Repeat for the Soap Web service log.
Step 9
In the Trace Output Settings section, set Maximum No. of Files*: 200 and Maximum File Size (MB)*: 2MB
Step 10
Click Save.

Next, use the RTMT tool to gather the logs.

Steps to gather RisPort Logs through RTMT Tool

To use this tool, you must download it from CallManager.

Step 1 Log into CUCM Administration.
Step 2 Go to Applications, choose Plugins.
Step 3 Search and find the Real Time Monitoring Tool.
Step 4 Download the Cisco Unified CM Real-Time Monitoring tool (RTMT).
Step 5 Install the RTMT tool.
Step 6 Start the RTMT tool.
Step 7 Enter the address of the CUCM server you want to monitor.
Step 8 Log into the server.
Step 9 To collect logs and traces, go to Trace central and double-click Collect Files.
1. Check All Servers for Cisco CallManager, Cisco Database Layer Monitor, Cisco SOAP Web Service and Cisco SOAPMessage Service servers.
2. On Collect File Options screen, select an Absolute Range approx. 30 min before and after your test run. Zip-ing the files is convenient. Please email or attach to your case using the online TAC case tool.

Phone IP Address Report JSP 2.2

Matthew J Denapoli — 2012-09-28T21:32:40Z

This how-to illustrates using the Serviceability AXL SOAP service with Apache Axis to generate a simple HTML-based report of phones/devices in the Unified Communications Manager cluster, listing IP address, logged-in user and registration status.

Unified Communications Manager version: 7.0(1)
Application Server/Development Environment:

Operating System: Ubuntu Linux 8.10 (Desktop)
Web Server: Tomcat 6 (tomcat6-admin)
Java SDK: Sun Java 1.6 JDK (sun-java6-jdk)
IDE: Sun Netbeans 6.1 (netbeans)
Web-services Library: Apache Axis 1.2 (libaxis-java)

Note: Serviceability AXL is a standards-compliant API that can be accessed from many different kinds of platforms. Cisco formally supports the interface at the XML/HTTP interaction point (http://developer.cisco.com). Specific OS/server/library/platform configuration or implementation issues are outside the scope of Cisco support. This how-to is provided as-is...community help and feedback may be available via the developer.cisco.com forums.

Tomcat Server Setup

From a fresh install of the OS, the following configuration tasks were performed. Note that several of these settings effect security, and may not be appropriate or optimal for production systems. Many of the paths and files shown are specific to Ubuntu 8.10 and may vary according to the specifics of a given system's OS/JVM/config.

Verify the Tomcat manager/admin components (tomcat6-admin) are installed. This allows Netbeans to auto-deploy the JSP project.
A Tomcat user with the custom roles "manager" and "admin" needs to be created. On Ubuntu this file is /etc/tomcat6/tomcat-users.xml:

<role rolename="manager"/>
<role rolename="admin"/>
<user username="tomcat_user" password="secret" roles="manager,admin"/>

Restart Tomcat and use Firefox to verify the Tomcat user can access the "manager webapp" link at http://<Tomcat-IP>:8080
The self-signed certificate present on the UCM Publisher needs to be imported into the Sun Java certificate key store in order for Tomcat to connect to AXL via SSL
- Download the UCM cert file
  - Check Firefox Edit/Preferences/Advanced/Encryption/View Certificates and remove any certificate that may already be present for the UCM server: e.g. <UCM701-IP>:8443
  - Reopen Firefox and navigate to https://<UCM701-IP>/ccmadmin, a certificate warning should appear
  - Export the certificate file: Add Exception/Get Certificate/View/Details/Export - leave format as (PEM) and note the filename and download location
- Import the UCM certificate into the key store using keytool. "-file" is the certificate file downloaded above, for example 'UCM701-IP'. The default Sun Java keystore password is "changeit":

sudo keytool -import -alias UCM701-IP -file <path/to/UCM701-IP> -storepass changeit -keystore /usr/lib/jvm/java-6-sun/jre/lib/security/cacerts

Grant Tomcat webapps permission to connect to outside servers via Java sockets. On Ubuntu this policy file is /etc/tomcat6/policy.d/04webapps.policy:

permission java.net.SocketPermission "*","connect";

Note, this gives the "connect" permission to all Tomcat webapps for any target server. You may want to tighten this down: http://tomcat.apache.org/tomcat-6.0-doc/security-manager-howto.html.

Be sure to restart Tomcat.

Netbeans Setup

Configure the Netbeans Tomcat server settings, so Netbeans can auto-deploy

Install the Netbeans Tomcat plugin: Tools/Plugins/Available
Add the server: Tools/Servers/Add Server/Tomcat 6.0/
- Catalina Home: /usr/share/tomcat6
- Private Configuration Folder (yes)
- Catalina Base: /var/lib/tomcat6
- Username/password should be the Tomcat user created above. "Create user" unchecked.

JSP Project Code

The first step in creating the project code is to use Axis to automaticaly generate Java classes which encapsulate all the backend tasks associated with using the RisPort SOAP service.

Download the RisPort.wsdl from UCM via browser: https://<UCM701-IP>/realtimeservice/services/RisPort?wsdl
Generate the java stubs with WSDL2Java:

java -cp /usr/share/java/axis.jar:/usr/share/java/commons-logging.jar:\
/usr/share/java/commons-discovery.jar:/usr/share/java/jaxrpc.jar:/usr/share/java/wsdl4j.jar \
org.apache.axis.wsdl.WSDL2Java <path/to/RisPort.wsdl>

The output (ignore any warnings) will be a package folder tree 'com' in the current directory - i.e. ./com/cisco/schemas/ast/soap/

We are now ready to create the Netbeans project.

Create a new web/web application project, for example 'JSPServiceability'. The default settings are fine, just make sure the server is the Tomcat 6.0 set up earlier. If Netbeans and Tomcat are working, you should be able to run the empty project, and see Firefox open to a 'Hello World' index.jsp page.
Place the RisPort package folder tree in the src/java folder of the project: i.e. ~/NetbeansProjects/JSPServiceability/src/java/com/cisco/schemas/ast/soap.
In the Projects panel, add the following Axis libraries from /usr/share/java: axis.jar, jaxrpc.jar, commons-logging.jar, commons-discovery.jar, wsdl4j.jar

Replace the contents of index.jsp with the following code:

Download index.jsp

<%--
    Document   : index
    Created on : Feb 22, 2009, 1:34:02 PM
    Author     : dstaudt
--%>
<%@ page contentType="text/html" pageEncoding="UTF-8" %>
<%@ page import="com.cisco.schemas.ast.soap.*,org.apache.axis.client.*" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Serviceability AXL - RisPort: All Devices</title>
    </head><%
        // CHANGE the following three strings for your UCM environment
        String risURL = "https://<CM701-IP>/realtimeservice/services/RisPort";
        String axlUser = "Administrator";
        String axlPassword = "cisco!123";

        RISService service = new RISServiceLocator(); // Instantiate the Axis Service object
        RisPortType rport = service.getRisPort(new java.net.URL(risURL)); // get the binding for RisPort

        ((Stub) rport)._setProperty(Call.USERNAME_PROPERTY, axlUser); // If we cast rport as an Axis Stub class
        ((Stub) rport)._setProperty(Call.PASSWORD_PROPERTY, axlPassword); // we can set the HTTP basic auth credentials

        //The following single element array of SelectItem '*' matches all devices
        //To search for specific devices, fill this array with device names
        //Note selectCmDevice will only return max 200 devices.  In a real deployment
        //an app might use Admin AXL to get a list of device names
        //then execute selectCmDevice multiple times querying up to 200 devices at a time.
        //Additional note, unique devicenames can be returned more than once if they have registered
        //to more than one node in the past
        SelectItem[] items = {new SelectItem("*")};

        //The general selection criteria goes in a CmSelectionCriteria object
        CmSelectionCriteria cmSelectionCriteria = new CmSelectionCriteria(
                new org.apache.axis.types.UnsignedInt(200), //Max returned devices
                "Any", //Class of device e.g. "Phone"
                new org.apache.axis.types.UnsignedInt(255), //Model 255=Unknown, see typemodel in the AXL DataDict
                "Any", //Status, e.g. "Registered"
                "", //UCM node server name
                "Name", //CmSelectionCriteria items are device names
                items);
        SelectCmDeviceResult cmselectresult = null;
        try {
            // Make the AXL request
            cmselectresult = rport.selectCmDevice(new javax.xml.rpc.holders.StringHolder(""), cmSelectionCriteria);
        } catch (Exception e) {
            out.println("Error: " + e.getMessage());
        }
        if (cmselectresult != null) {
            int devicesFound = cmselectresult.getTotalDevicesFound().intValue(); //Find out how many devices found
%>
    <body>
        Total Devices Found:  <%= devicesFound%>
        <table border="1" align="left" cellspacing="1" cellpadding="1">
            <tr>
                <td>Name</td>
                <td>IP Address</td>
                <td>Model</td>
                <td>E/M User</td>
                <td>Status</td>
            </tr><%
        if (devicesFound > 0) {
            //If some devices are found, output them in an HTML table
            CmNode[] nodes = cmselectresult.getCmNodes(); // Get the array of UCM nodes
            for (int i = 0; i < nodes.length; i++) {
                CmDevice[] devices = nodes[i].getCmDevices(); //Get the array of devices for this node
                for (int j = 0; j < devices.length; j++) {%>
            <tr>
                <td><%= devices[j].getName()%></td>
                <td><%= devices[j].getIpAddress()%></td>
                <td><%= devices[j].getModel()%></td>
                <td><%= devices[j].getLoginUserId()%></td>
                <td><%= devices[j].getStatus()%></td>
            </tr><%
                }
            }
        }%>
        </table>
    </body><% }%>
</html>

Be sure to update the strings at the beginning of index.jsp with your actual UCM URL and user credentials. The credentials should be a UCM application user, with role 'Standard AXL API Access'

At this point you should be able to successfully run the project. Netbeans will automatically package the project .war file, deploy it to Tomcat, and open a Firefox instance with the project URL.

Download the full Netbeans project files: JSPServiceability.zip

How-to Articles 2.2

Matthew J Denapoli — 2012-09-28T21:32:28Z

== How-to Articles ==

Sample Apps 2.1

Matthew J Denapoli — 2012-09-28T21:32:17Z

== Sample Apps ==

Wiki Home 2.4

Matthew J Denapoli — 2012-09-27T22:54:48Z

=== UC Manager Serviceability APIs Wiki ===