User Guide for Cisco Unified Operations Manager 8.5
Using Batch Tests
Downloads: This chapterpdf (PDF - 208.0KB) The complete bookPDF (PDF - 14.64MB) | Feedback

Using Batch Tests

Table Of Contents

Using Batch Tests

Working with Batch Tests

Creating Batch Tests

Formatting Batch Test Import Files

Editing Batch Tests

Deleting a Batch Test

Viewing Batch Test Details

Verifying the Status of a Test

Suspending/Resuming a Batch Test

Scheduling a Batch Test to Run

Running a Batch Test on Demand

Viewing Batch Test Results

Printing Batch Test Results

Exporting Batch Test Results

Storing Batch Test Data

Understanding Phone Tests

Creating and Running a Phone Test on Demand

Viewing On-Demand Phone Test Results


Using Batch Tests


Batch tests enable you to test the health and connectivity of a branch office. There are two types of batch tests:

Synthetics tests—A set of tests (see Using Synthetic Tests, page 8-1) that are run on voice applications (for example, Cisco Unified Communications Manager Express or Cisco Unity Express) that are deployed in a branch office.

Phone tests—A set of tests (see Understanding Phone Tests) that are run on real phones in the branch office.

Batch tests can be run once a day to verify the health of the voice network in the branch office.

The following topics are covered:

Working with Batch Tests

Viewing Batch Test Results

Understanding Phone Tests

Creating and Running a Phone Test on Demand

Viewing On-Demand Phone Test Results

Working with Batch Tests

This section describes how to create, edit, remove, and analyze batch tests in Operations Manager, as well as how to stop or start batch test operations.

This section includes the following topics:

Creating Batch Tests

Editing Batch Tests

Deleting a Batch Test

Viewing Batch Test Details

Verifying the Status of a Test

Suspending/Resuming a Batch Test

Scheduling a Batch Test to Run

Creating Batch Tests

You create batch tests by importing an XML file. Each individual batch test consists of multiple synthetic tests and phone tests.

Before You Begin

Verify that your seed file is formatted correctly. For details, see Formatting Batch Test Import Files.

Place the seed file on the server, in the NMSROOT\ImportFiles directory. If you do not have access to the directory, contact a local administrator for the server where Operations Manager is installed.

NMSROOT is the directory where Operations Manager is installed on your system. If you selected the default directory during installation, it can be entered as "C:\Program Files\CSCOpx" or C:\PROGRA~1\CSCOpx.


Step 1 Select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears.

If you do not have the required software license, you will not be able to use batch tests. The Diagnostic tab will not appear in Operations Manager.

Step 2 Click Create.

The Create Batch Test page appears.

Step 3 Enter the name of the seed file in the Filename field and click OK.


Formatting Batch Test Import Files

The batch test import file is an XML file. You can find an example of an import file in the NMSROOT\Importfiles folder.

NMSROOT is the directory where Operations Manager is installed on your system. If you selected the default directory during installation, it can be entered as "C:\Program Files\CSCOpx" or C:\PROGRA~1\CSCOpx.

A batch test import file contains information for one batch test. Each batch test import file contains all the information required to configure the synthetic tests and phone tests for that particular batch test.

For specific details on what information is required to configure synthetic tests, see Configuring Synthetic Tests, page 8-3.

For specific details on what information is required to configure phone tests, see Understanding Phone Tests.

When creating a batch test import file, observe the following guidelines for the listed fields:

TestSchedule—Can have multiple schedule entries.

Each ScheduleEntry—Must have the following five fields:

Month—Not supported.

DayOfMonth—Not supported.

DayOfWeek—Must be 0 through 6 or asterisk to indicate all days.

Hour—Must be between 0 and 23.

Minute—Must be between 0 and 59.

CallAgent—Can be a Cisco Unified Communications Manager or a Cisco Unified Communications Manager Express.

PhoneMACAddress—The MAC address of a synthetic phone. It must be in the range of 00059A3B7700 to 00059A3B8AFF.

PhoneProtocol—The protocol of the synthetic phone, either SCCP or SIP.

PhoneURIorExtension—The extension or URI of a SIP phone. This is ignored for SCCP phones.

OnsiteAlertNumber—Required only when IsOSANEnabled is set to true.

DialingNumber—Optional. PhoneNumber is used if no input is present. This field is valid for intercluster call only. It must provide the complete number that has to be dialed from source phone to reach destination phone on a different cluster.

For example, just the phone number or the dial pattern/access digits plus the phone number.

Example Batch Test Import FIle

<BatchTest name="batch-test1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="BatchTest.xsd">
- <!-- 
 
		TestSchedule can have multiple ScheduleEntry's
		Each ScheduleEntry must have the following five fields
			
			month : Not supported
			dayOfMonth : Not supported 
			dayOfWeek : should be 0-6 or * to indicate all days
			hour : hour should be between 0-23
			minute : minute should be between 0-59
	

  --> 
- <TestSchedule>
- <ScheduleEntry>
  <month>*</month> 
  <dayOfMonth>*</dayOfMonth> 
  <dayOfWeek>*</dayOfWeek> 
  <hour>10</hour> 
  <minute>10</minute> 
  </ScheduleEntry>
- <ScheduleEntry>
  <month>*</month> 
  <dayOfMonth>*</dayOfMonth> 
  <dayOfWeek>*</dayOfWeek> 
  <hour>20</hour> 
  <minute>20</minute> 
  </ScheduleEntry>
  </TestSchedule>
  <CiscoCallManager name="CM1" address="ipif-ccm1.cisco.com" jtapiUsername="jtuser" 
jtapiPassword="cisco" /> 
  <CiscoCallManager name="CM2" address="ipif-skate.cisco.com" jtapiUsername="jtuser" 
jtapiPassword="cisco" /> 
- <!-- 
 
		CallAgent           : A CallAgent can be a Cisco CallManager or Cisco CallManager 
Express
		PhoneMACAddress     : The MAC address of synthetic phone. This should be in the 
range 
						      00059A3B7700 - 00059A3B8AFF
		PhoneProtocol       : The protocol of synthetic phone. This values can be SCCP or 
SIP
		PhoneURIorExtension : The extension of URI of a SIP phone. This is ignored for 
SCCP phones
	

  --> 
- <PhoneRegistrationTest name="skinny-reg">
- <Phone>
  <CallAgent>10.76.93.118</CallAgent> 
  <PhoneMACAddress>00059A3B7700</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Phone>
  <SuccessCriteria>RegistrationFailure</SuccessCriteria> 
  </PhoneRegistrationTest>
- <PhoneRegistrationTest name="sip-reg">
- <Phone>
  <CallAgent>ipcom-sd1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7800</PhoneMACAddress> 
  <PhoneProtocol>SIP</PhoneProtocol> 
  <PhoneURIorExtension>sip:7800@ipcom-sd1.cisco.com</PhoneURIorExtension> 
  </Phone>
  <SuccessCriteria>RegistrationSuccess</SuccessCriteria> 
  </PhoneRegistrationTest>
- <DialToneTest name="dial-tone">
- <Phone>
  <CallAgent>ipcom-sd1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7701</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Phone>
  </DialToneTest>
- <TftpTest name="tftp-download">
  <TftpServer>ipif-skate.cisco.com</TftpServer> 
  </TftpTest>
- <EndToEndTest name="e2e-skinny2real">
- <Caller>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7704</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Caller>
  <IsDestRealPhone>true</IsDestRealPhone> 
  <ReceiverURIorExtension>5555</ReceiverURIorExtension> 
  <WaitForAnswer>true</WaitForAnswer> 
  <EnableRTPTransmission>false</EnableRTPTransmission> 
  <SuccessCriteria>CallSuccess</SuccessCriteria> 
  </EndToEndTest>
- <EndToEndTest name="e2e-sip2real">
- <Caller>
  <CallAgent>ipcom-sd1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7801</PhoneMACAddress> 
  <PhoneProtocol>SIP</PhoneProtocol> 
  <PhoneURIorExtension>sip:7801@ipcom-sd1.cisco.com</PhoneURIorExtension> 
  </Caller>
  <IsDestRealPhone>true</IsDestRealPhone> 
  <ReceiverURIorExtension>5555</ReceiverURIorExtension> 
  <WaitForAnswer>true</WaitForAnswer> 
  <EnableRTPTransmission>false</EnableRTPTransmission> 
  <SuccessCriteria>CallFailure</SuccessCriteria> 
  </EndToEndTest>
- <EndToEndTest name="e2e-skinny2skinny">
- <Caller>
  <CallAgent>10.76.93.118</CallAgent> 
  <PhoneMACAddress>00059A3B7702</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Caller>
  <IsDestRealPhone>false</IsDestRealPhone> 
- <Receiver>
  <CallAgent>10.76.93.118</CallAgent> 
  <PhoneMACAddress>00059A3B7703</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Receiver>
  <ReceiverURIorExtension>7703</ReceiverURIorExtension> 
  <SuccessCriteria>CallSuccess</SuccessCriteria> 
  </EndToEndTest>
- <EndToEndTest name="e2e-sip2sip">
- <Caller>
  <CallAgent>ipcom-sd1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7800</PhoneMACAddress> 
  <PhoneProtocol>SIP</PhoneProtocol> 
  <PhoneURIorExtension>sip:7800@ipcom-sd1.cisco.com</PhoneURIorExtension> 
  </Caller>
  <IsDestRealPhone>false</IsDestRealPhone> 
- <Receiver>
  <CallAgent>ipcom-sd1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7801</PhoneMACAddress> 
  <PhoneProtocol>SIP</PhoneProtocol> 
  <PhoneURIorExtension>sip:7801@ipcom-sd1.cisco.com</PhoneURIorExtension> 
  </Receiver>
  <ReceiverURIorExtension>sip:7801@ipif-ccm1.cisco.com</ReceiverURIorExtension> 
  <SuccessCriteria>CallSuccess</SuccessCriteria> 
  </EndToEndTest>
- <EndToEndTest name="e2e-skinny2sip">
- <Caller>
  <CallAgent>10.76.93.118</CallAgent> 
  <PhoneMACAddress>00059A3B7705</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Caller>
  <IsDestRealPhone>false</IsDestRealPhone> 
- <Receiver>
  <CallAgent>10.76.93.118</CallAgent> 
  <PhoneMACAddress>00059A3B7802</PhoneMACAddress> 
  <PhoneProtocol>SIP</PhoneProtocol> 
  <PhoneURIorExtension>sip:7802@ipcom-sd1.cisco.com</PhoneURIorExtension> 
  </Receiver>
  <ReceiverURIorExtension>6666</ReceiverURIorExtension> 
  <SuccessCriteria>CallSuccess</SuccessCriteria> 
  </EndToEndTest>
- <EndToEndTest name="e2e-sip2skinny">
- <Caller>
  <CallAgent>10.76.93.118</CallAgent> 
  <PhoneMACAddress>00059A3B7803</PhoneMACAddress> 
  <PhoneProtocol>SIP</PhoneProtocol> 
  <PhoneURIorExtension>sip:7803@ipcom-sd1.cisco.com</PhoneURIorExtension> 
  </Caller>
  <IsDestRealPhone>false</IsDestRealPhone> 
- <Receiver>
  <CallAgent>10.76.93.118</CallAgent> 
  <PhoneMACAddress>00059A3B7706</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Receiver>
  <ReceiverURIorExtension>6666</ReceiverURIorExtension> 
  <SuccessCriteria>CallSuccess</SuccessCriteria> 
  </EndToEndTest>
- <MWITest name="unity-mwi">
  <VoiceMailSystem>10.76.91.175</VoiceMailSystem> 
- <Caller>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7707</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Caller>
- <Receiver>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7708</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Receiver>
  <ReceiverExtension>4000</ReceiverExtension> 
  <VoiceMailPassword>123456</VoiceMailPassword> 
  </MWITest>
- <ConferenceTest name="ccc">
  <ConferenceServer>10.76.91.151</ConferenceServer> 
- <FirstParticipant>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7709</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </FirstParticipant>
- <SecondParticipant>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7710</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </SecondParticipant>
  <UserName>cccUser</UserName> 
  <Password>cisco</Password> 
  <MeetingId>444444</MeetingId> 
  <ConferenceDialIn>1234</ConferenceDialIn> 
  </ConferenceTest>
- <EmergencyCallTest name="cer">
  <EmergencyCallRouter>10.76.91.149</EmergencyCallRouter> 
- <Caller>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7711</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Caller>
- <PublicSafetyAnsweringPoint>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7712</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </PublicSafetyAnsweringPoint>
  <EmergencyNumber>911</EmergencyNumber> 
  <IsOSANEnabled>false</IsOSANEnabled> 
  </EmergencyCallTest>
- <EmergencyCallTest name="cer-with-osan">
  <EmergencyCallRouter>10.76.91.149</EmergencyCallRouter> 
- <Caller>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7711</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </Caller>
- <PublicSafetyAnsweringPoint>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7712</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </PublicSafetyAnsweringPoint>
  <EmergencyNumber>911</EmergencyNumber> 
- <!--  OnsiteAlertNumber is required only when IsOSANEnabled is 'true' 
  --> 
  <IsOSANEnabled>true</IsOSANEnabled> 
- <OnSiteAlertNumber>
  <CallAgent>ipif-ccm1.cisco.com</CallAgent> 
  <PhoneMACAddress>00059A3B7713</PhoneMACAddress> 
  <PhoneProtocol>SCCP</PhoneProtocol> 
  <PhoneURIorExtension /> 
  </OnSiteAlertNumber>
  </EmergencyCallTest>
- <PhoneTest name="pt1" primaryCallManager="CM1">
  <TestPhones>3333,4444,5555,6666</TestPhones> 
  <TestProbes>1111,1112,1113,1114</TestProbes> 
- <Action name="IntraClusterCall" type="Call">
  <Destination>5555</Destination> 
  </Action>
- <Action name="CallToPSTN" type="Call">
  <Destination>918041036116</Destination> 
  </Action>
- <Action name="Call to PSTN Negative" type="Call">
  <Destination>918041036116</Destination> 
  <SuccessCriteria>CallFailure</SuccessCriteria> 
  </Action>
- <Action name="Inter Cluster Call" type="Call">
  <Destination>9999</Destination> 
  <DestinationCallManager>CM2</DestinationCallManager> 
  </Action>
  <Action name="Call Hold test" type="CallHold" /> 
  <Action name="Call Forward test" type="CallForward" /> 
  <Action name="Call Park test" type="CallPark" /> 
  <Action name="Conference test" type="Conference" /> 
  </PhoneTest>
+ <PhoneTest name="pt2" primaryCallManager="CM2">
  <TestPhones>3333,4444,5555,6666</TestPhones> 
  <TestProbes>1111,1112,1113,1114</TestProbes> 
- <Action name="Call to PSTN Negative" type="Call">
  <Destination>918041036116</Destination> 
  <SuccessCriteria>CallSuccess</SuccessCriteria> 
  </Action>
- <Action name="Inter Cluster Call" type="Call">
  <Destination>8888</Destination> 
  <DialingNumber>8888</DialingNumber> 
  <DestinationCallManager>CM1</DestinationCallManager> 
  <SuccessCriteria>CallFailure</SuccessCriteria> 
  </Action>
  <Action name="Call Hold test" type="CallHold" /> 
  <Action name="Call Forward test" type="CallForward" /> 
  <Action name="Call Transfer test" type="CallTransfer" /> 
  </PhoneTest>
  </BatchTest>

Editing Batch Tests

You can change an existing batch test by importing a new batch test import file. The previous batch test information is overwritten by the new import file. To change the import file, you must manually edit the file (see Formatting Batch Test Import Files).

To edit batch tests:


Step 1 Select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears.

Step 2 Select the batch test that you want to change.

Step 3 Click Edit.

The Edit Batch Test page appears.

Step 4 Enter the name of the seed file in the Filename field and click OK.


Deleting a Batch Test

You can use this function to delete one or more tests. You can delete tests in any state. See Table 9-1 for a description of possible states.

To delete a batch test:


Step 1 Select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears.

Step 2 Select the tests you want to delete, and then click Delete.

A confirmation dialog box appears.

Step 3 Click Yes.

Operations Manager deletes the tests you selected.


Viewing Batch Test Details

You can see all details about a particular batch test on the Test Details page.

As with any of the reports in Operations Manager, you can print the report or export it to a file (see Printing Batch Test Results and Exporting Batch Test Results).

The Test Details page lists all the synthetic tests and phone tests that are part of the batch test.

To view a batch test:


Step 1 Select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears.

Step 2 Select the test you want to view, and click View.

The Test Details page opens.

You can go to any of the tests listed in the Test Details page by selecting the test from the Go to Test menu at the top of the page.

This page contains the following information:

Test summary:

Test name—Name of the batch test.

Test details—Number of synthetic and phone tests configured.

Test schedule.

Synthetic tests:

Test name—Name of the synthetic test.

Test type—Type of synthetic test (see Using Synthetic Tests, page 8-1).

Phone details—Call Agent, MAC Address, Protocol, and URI/Extension. The phone information is provided for all phones, whether it is the calling or receiving phone.

Phone tests:

Test name—Name of the phone test.

Primary Cisco Unified Communications Manager.

Test phones.

Test probes.

Phone action details—Lists the actions that the phone tests performed.


Note For descriptions of the phone tests, see Understanding Phone Tests.



Verifying the Status of a Test

You can verify whether a test ran and completed correctly. You can also troubleshoot the test if necessary.

To verify the status of a test,select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears. All current batch tests appear on the page. The last column in the table shows the status of each test.

Table 9-1 Test Status Definitions

Test Status
Description

Running

The test is active and collecting data.

Suspended

The test is suspended from data collecting or polling. This occurs because the device was suspended.

Scheduled

Appears after you create or update a test. The status will change to Running at the first polling cycle.



Suspending/Resuming a Batch Test

When you suspend a batch test it no longer runs at its scheduled time. The test is not removed from the system. If you want to remove the test, it must be deleted (see Deleting a Batch Test).

To suspend and resume a batch test, select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears.

If the batch test is active and you want to stop it from running, click Suspend.

If the batch test is suspended and you want it to run it at its scheduled time, click Resume.

Scheduling a Batch Test to Run

The scheduled time and day that a batch test is to run is configured in the import file (see Formatting Batch Test Import Files). But if you want to run a batch test on demand, you can use the Run Now button.

Running a Batch Test on Demand

To run a batch test on demand:


Step 1 Select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears.

Step 2 Select the batch test that you want to run.

Step 3 Click Run Now.

The batch test runs.


Viewing Batch Test Results

No events are generated when a component of a batch test fails. You must use the Batch Test Results report to see the results of a batch test. A new Batch Test Results report is generated every 24 hours for each batch test.

As with any of the reports in Operations Manager, you can print the report or export it to a file (see Verifying the Status of a Test and Exporting Batch Test Results).

This section contains:

Printing Batch Test Results

Exporting Batch Test Results

Storing Batch Test Data

The Batch Test Results report provides the following information for the overall batch test:

Test status.

Date and time that the test started and finished.

The Batch Test Results report provides the following information for the individual tests that are a part of the batch test:

Test type.

Whether or not it is a negative test.

Test status (passed or failed).

Date and time that the test finished.

Any error messages.

To view the results of a batch test:


Step 1 Select Administration > Diagnostic Tests > Batch Tests.

The Batch Tests page appears.

Step 2 Select the batch test that you want to see the results for.

Step 3 Click Results.

The Batch Test Results report appears.


Printing Batch Test Results

To print the results of a batch test:


Step 1 In a batch test report, click the printer icon in the upper-right corner of the window.

The records are reformatted into a print-friendly format and displayed in a new browser window.

Step 2 Use the Print function on your browser to print the display.


Exporting Batch Test Results

To export the results of a batch test:


Step 1 In a batch test report, click the export icon in the upper-right corner of the window.

Step 2 Select either CSV or PDF format for export and click OK.

If you chose CSV in Step 1, do the following:

a. When the File Download dialog box appears, click Save.

b. In the Windows folder window, enter the filename and the location where you want to save the file.

c. Click Save.

d. In the Download Complete dialog box, click Close.

If you chose PDF in Step 1, do the following:

a. Click Yes in the security information dialog box.

The records appear in PDF format.

b. Use the PDF Save function to save the file to your system.


Storing Batch Test Data

Operations Manager saves the data collected by the batch tests to disk. Batch test data is stored on the Operations Manager server in the NMSROOT\data\bt folder.

NMSROOT is the directory where Operations Manager is installed on your system. If you selected the default directory during installation, it can be entered as "C:\Program Files\CSCOpx" or C:\PROGRA~1\CSCOpx.

Understanding Phone Tests

The phone tests that are run as part of batch testing and on-demand testing take control of a real phone in the network and make a call from that phone to another phone. Phone tests use JTAPI credentials. For batch testing, these credentials must be included in the batch test import file.

While running a phone test on demand, the JTAPI credentials must be provided in the phone test creation UI. For the phone test feature in Operations Manager to work properly, the JTAPI credentials need to be configured in Communications Manager as well.

While creating a phone test as part of batch testing, observe these definitions, guidelines, and instructions:

TestPhones—Phones being tested.

TestProbes—Phones being used to run the tests.

The test phones and test probes must belong to the same Cisco Unified Communications Manager because Operations Manager takes control of these phones and probes through the Communications Manager using JTAPI. If the test phones and test probes belong to a different Cisco Unified Communications Manager, the tests will fail.

Only when the call test type is an intercluster call can the destination phone belong to a different Cisco Unified Communications Manager. In this instance, the user needs to provide the credentials of the destination Communications Manager in the batch test XML file.

An example of an import XML file for batch phone testing is provided in
C:\Program Files\CSCOpx\ImportFiles\batchPhoneTests.xml.

See Creating Batch Tests and Formatting Batch Test Import Files.

Before running the phone tests, verify that the configurations are correct in Communications Manager and that the various phone operations are working using the real phones.

Table 9-2 describes the different phone tests that are used in batch testing and on-demand testing.


Note Do not confuse these phone tests with other Operations Manager phone tests (synthetic tests or phone status tests). These phone tests are created as part of batch testing and can also be launched on-demand, from IP Phone reports. These tests take control of real phones to conduct the tests.


Table 9-2 Phone Test Descriptions—Batch and On-Demand Tests 

Test
Description

Call Hold

Takes control of two phones and performs the following:

1. Places a call from phone A to phone B.

2. Has phone B put the call on hold.

3. Disconnects the call.

Call Forward

Takes control of three phones and performs the following:

1. Places a call from phone A to phone B.

2. Forwards the call to phone C from phone B.

3. Verifies that the call is received by phone C.

4. Disconnects the call.

Call Park

Takes control of three phones and performs the following:

1. Places a call from phone A to phone B.

2. Has phone B park the call.

The call is removed from phone B and a message is displayed to tell you where the call is parked (for example, Call Park at 80503).

3. Has phone C dial the number where the call is parked.

The parked call is transferred to the phone that you made the call from.

4. Disconnects the call.

Call Conference

Takes control of three phones and performs the following:

1. Places a call from phone A to phone B.

2. Places a conference call from phone A to phone C.

3. Disconnects the call.

Call Transfer

Takes control of three phones and performs the following:

1. Places a call from phone A to phone B.

2. Has phone B transfer the call to phone C.

3. Has phone C accept the call.

4. Disconnects the call.

Call Test

Takes control of a phone and places a call to a given number. The call can be from a real phone to a number, in which case the test is controlling the caller only.

Alternatively, the call can be from a real phone to a real phone, in which case the test is controlling both the caller and the receiver.


Creating and Running a Phone Test on Demand

You can select one or more phones from an IP Phones/Lines report display and run a phone test on demand. The selected phones must belong to the same Cisco Unified Communications Manager. Phone tests use the JTAPI credential. The JTAPI credential must be configured in Communications Manager.

For information on how phone counts are displayed in Operations Manager windows, see How Are Phone Counts Displayed in Fault Monitor, Diagnostics Views, and Reports?, page 1-22.

To create and run a phone test on demand:


Step 1 Select Administration > Diagnostic Tests > Phone Tests.

The On-Demand Phone Test window appears.

Step 2 Select the items you want included in the on-demand phone test. See Table 9-3 for descriptions.

Step 3 Click Run.

The On-Demand Phone test runs.


Table 9-3 On-Demand Phone Test 

Item
Description

Cisco Unified Communications Manager

Lists the Communications Manager for the phones selected from the phone report.

You can select a Cisco Unified Communications Manager from the left pane and click the >> button to add it to the Cisco Unified Communications Manager field.

The previous Test Phones and Helper Phones selections are cleared; you will need to specify them again.

JTAPI Username and JTAPI Password

Enter the JTAPI username and password configured on the Communications Manager.

Test Phones

To add more phones to Test Phones:

1. Click Add from Phone Report.

The phone report window appears.

2. Select the additional phones to add and click Select.

The phones added must belong to the same Cisco Unified Communications Manager provided at the beginning for this test.1

Helper Phones

To add more phones to Helper Phones:

1. Click Add from Phone Report.

2. Select the additional phones to add and click Select.

The phones added must belong to the same Cisco Unified Communications Manager provided at the beginning for this test.1

Phone Tests

Select the phone test that you want to see the results for. The following phone tests are available:

Call Hold

Call Forward

Call Park

Call Conference

Call Transfer

Call Test

When Call Test is selected, the following fields are enabled:

Call Type

Success Criterion

Phone Number

Call Type

From the drop-down list, choose the call type.

When Inter Cluster Call is selected, the following fields are enabled:

Cisco Unified Communications Manager

JTAPI Username

JTAPI Password

Success Criterion

From the drop-down list, choose the success criterion.

Phone Number

The destination phone number to be dialed for the call test needs to be specified in this field.

Dialing Number

When Inter Cluster Call is selected for Call Type, enter the complete phone number that the source phone must dial to reach the destination phone on a different cluster.

This may include dial pattern or access digits, for example 94151234567.

This field is not mandatory. If left blank, the Phone Number field is used instead.

Cisco Unified Communications Manager

When Inter Cluster Call is selected for Call Type, enter the Cisco Unified Communications Manager for the phone number specified in the Phone Number field.

JTAPI Username and Password

When Inter Cluster Call is selected for Call Type, enter the JTAPI username and password for the Cisco Unified Communications Manager provided in the previous field.

1 If you select a single phone which shares its extension with other phones in the personalized report, the report generated will have details about all the phones (including the selected phone).


If the phone tests fail and display the message Unable to create provider verify:

The JTAPI username and password is created in Communications Manager and that the phones used in the test are assigned to the same JTAPI user. For the phone test feature in Operations Manager to work properly, the JTAPI credentials need to be configured in Communications Manager as well.

The JTAPI implementation in Communications Manager may have been modified; as a result the JTAPI Java Archive (JAR) files need to be updated in Operations Manager.

To update the JTAPI .JAR files in Operations Manager:


Step 1 Log into Cisco Unified Communications Manager and select Application > Plugins.

Step 2 Click Find to list the available plugins.

Step 3 From the list, select Download Cisco JTAPI for Windows and save the file to your computer.

Step 4 Click the executable file to install the Cisco JTAPI client on your computer.

Step 5 In the directory where Operations Manager is installed on your system, in Install Directory\Unified Communications s\bt\lib, look for the directories listed for each Communications Manager version installed.

Step 6 Click the directory for the Communications Manager version that you are currently using.

For example, go to directory 6.0 if your current version of Communications Manager is 6.0.x. Replace the .JAR files in the directory with the .JAR files from the newly installed Cisco JTAPI client on your computer.

By default, the .JAR files are in C:\WINNT\java\lib on your computer if the default directory was selected during the Cisco JTAPI client installation.


Viewing On-Demand Phone Test Results

When initiated, the On-Demand Phone Test is run immediately and the results are displayed.

Table 9-4 On-Demand Phone Test Results

Item
Description

Action Name

Lists the phone test that was run on the selected phones. The descriptions in Table 9-2 apply to batch tests and on-demand phone tests.

Extension

Phone extension included in on-demand phone test.

Negative Test

Whether or not it is a negative test.

Test Status

Test Status (passed or failed).

Test Start Time

Date and time that the test started.

Test End Time

Date and time that the test finished.

Error Message

Any error messages.


To print an on-demand phone test, see Printing Batch Test Results. To export an on-demand phone test, see Exporting Batch Test Results.