Exporting data from Avaya IQ
Release 5.0
June 2009
©
2009 Avaya Inc.
All Rights Reserved.
Notice
While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya
Inc. can assume no liability for any errors. Changes and corrections to the information in this document might be incorporated in future releases.
Documentation disclaimer
Avaya Inc. is not responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya.
Customer and/or End User agree to indemnify and hold harmless
Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation to the extent made by the Customer or End User.
Link disclaimer
Avaya Inc. is not responsible for the contents or reliability of any linked
Web sites referenced elsewhere within this documentation, and Avaya does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all the time and we have no control over the availability of the linked pages.
Warranty
Avaya Inc. provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya’s standard warranty language, as well as information regarding support for this product, while under warranty, is available through the Avaya Support Web site: http://www.avaya.com/support
Licenses
USE OR INSTALLATION OF THE PRODUCT INDICATES THE END
USER'S ACCEPTANCE OF THE TERMS SET FORTH HEREIN AND
THE GENERAL LICENSE TERMS AVAILABLE ON THE AVAYA WEB
SITE http://support.avaya.com/LicenseInfo/ ("GENERAL LICENSE
TERMS"). IF YOU DO NOT WISH TO BE BOUND BY THESE TERMS,
YOU MUST RETURN THE PRODUCT(S) TO THE POINT OF
PURCHASE WITHIN TEN (10) DAYS OF DELIVERY FOR A REFUND
OR CREDIT.
Avaya grants End User a license within the scope of the license types described below. The applicable number of licenses and units of capacity for which the license is granted will be one (1), unless a different number of licenses or units of capacity is specified in the
Documentation or other materials available to End User. "Designated
Processor" means a single stand-alone computing device. "Server" means a Designated Processor that hosts a software application to be accessed by multiple users. "Software" means the computer programs in object code, originally licensed by Avaya and ultimately utilized by
End User, whether as stand-alone Products or pre-installed on
Hardware. "Hardware" means the standard hardware Products, originally sold by Avaya and ultimately utilized by End User.
License types
Designated System(s) License (DS). End User may install and use each copy of the Software on only one Designated Processor, unless a different number of Designated Processors is indicated in the
Documentation or other materials available to End User. Avaya may require the Designated Processor(s) to be identified by type, serial number, feature key, location or other specific designation, or to be provided by End User to Avaya through electronic means established by Avaya specifically for this purpose.
Concurrent User License (CU). End User may install and use the
Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the Software at any given time. A "Unit" means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an e-mail or voice mail account in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Software.
Units may be linked to a specific, identified Server.
Database License (DL). Customer may install and use each copy of the
Software on one Server or on multiple Servers provided that each of the Servers on which the Software is installed communicate with no more than a single instance of the same database.
CPU License (CP). End User may install and use each copy of the
Software on a number of Servers up to the number indicated by Avaya provided that the performance capacity of the Server(s) does not exceed the performance capacity specified for the Software. End User may not re-install or operate the Software on Server(s) with a larger performance capacity without Avaya's prior consent and payment of an upgrade fee.
Named User License (NU). Customer may: (i) install and use the
Software on a single Designated Processor or Server per authorized
Named User (defined below); or (ii) install and use the Software on a
Server so long as only authorized Named Users access and use the
Software. "Named User," means a user or device that has been expressly authorized by Avaya to access and use the Software. At
Avaya's sole discretion, a "Named User" may be, without limitation, designated by name, corporate function (e.g., webmaster or helpdesk), an e-mail or voice mail account in the name of a person or corporate function, or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Product.
Named User License (NU). Customer may: (i) install and use the
Software on a single Designated Processor or Server per authorized
Named User (defined below); or (ii) install and use the Software on a
Server so long as only authorized Named Users access and use the
Software. "Named User," means a user or device that has been expressly authorized by Avaya to access and use the Software. At
Avaya's sole discretion, a "Named User" may be, without limitation, designated by name, corporate function (e.g., webmaster or helpdesk), an e-mail or voice mail account in the name of a person or corporate function, or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Product.
Shrinkwrap License (SR). With respect to Software that contains elements provided by third party suppliers, End User may install and use the Software in accordance with the terms and conditions of the applicable license agreements, such as "shrinkwrap" or "clickwrap" license accompanying or applicable to the Software ("Shrinkwrap
License"). The text of the Shrinkwrap License will be available from
Avaya upon End User’s request (see “Third-party Components" for more information).
Copyright
Except where expressly stated otherwise, the Product is protected by copyright and other laws respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal, as well as a civil, offense under the applicable law.
Third-party components
Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ("Third
Party Components"), which may contain terms that expand or limit rights to use certain portions of the Product ("Third Party Terms").
Information identifying Third Party Components and the Third Party
Terms that apply to them is available on the Avaya Support Web site: http://support.avaya.com/ThirdPartyLicense/
Preventing toll fraud
"Toll fraud" is the unauthorized use of your telecommunications system by an unauthorized party (for example, a person who is not a corporate employee, agent, subcontractor, or is not working on your company's behalf). Be aware that there can be a risk of toll fraud associated with
2 Exporting data from Avaya IQ June 2009
your system and that, if toll fraud occurs, it can result in substantial additional charges for your telecommunications services.
Avaya fraud intervention
If you suspect that you are being victimized by toll fraud and you need technical assistance or support, call Technical Service Center Toll
Fraud Intervention Hotline at +1-800-643-2353 for the United States and Canada. For additional support telephone numbers, see the Avaya
Support Web site: http://support.avaya.com
Suspected security vulnerabilities with Avaya Products should be reported to Avaya by sending mail to: [email protected].
Trademarks
Avaya is a registered trademark of Avaya Inc.
All non-Avaya trademarks are the property of their respective owners.
Downloading documents
For the most current versions of documentation, see the Avaya Support
Web site: http://www.avaya.com/support
Contact Avaya Support
Avaya Inc. provides a telephone number for you to use to report problems or to ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site: http:// www.avaya.com/support
Exporting data from Avaya IQ June 2009 3
4 Exporting data from Avaya IQ June 2009
Contents
Chapter 1: Data export overview..............................................................................................7
Chapter 2: Integration with Avaya IQ reporting......................................................................9
Chapter 3: Access and license considerations....................................................................11
Chapter 4: Supported data output formats..........................................................................13
Chapter 5: Data export modes..............................................................................................15
Chapter 6: Custom data export reports................................................................................17
Chapter 7: Standard development kit....................................................................................19
Index.........................................................................................................................................21
Exporting data from Avaya IQ June 2009 5
Contents
6 Exporting data from Avaya IQ June 2009
Chapter 1: Data export overview
Avaya IQ includes a read-only data export capability. This feature includes an application programming interface (API) that is implemented as a standard web service. Users can create their own custom client application and use the API to extract data from the database for reuse in various external applications, such as wallboard displays, workforce management programs, and so forth.
All data that resides in the Avaya IQ tablespaces is available for export.
Exporting data from Avaya IQ June 2009 7
Data export overview
8 Exporting data from Avaya IQ June 2009
Chapter 2: Integration with Avaya IQ reporting
The following topics provide information about the integration of the data export feature with the Avaya IQ reporting system and other items that feature users should understand.
Data consistency: Since the data export API is integrated with the Avaya IQ reporting feature, the data export reports share the same parameters and measures used in the standard reports.
For this reason, report data obtained from data export reports is identical to the data that can be obtained from the standard real-time and historical reports.
Report design and execution: Direct specification of SQL commands is not required to use the data export feature. You use Avaya IQ Report Designer to configure your export reports and then use the API to run the export reports and send the report output out of the system.
Export refresh rates for real-time data: Real-time data export reports continue to execute until the script or program that is accessing the API is terminated.
Dedicated export server option: Customers who have extensive data export requirements can dedicate an Avaya IQ report server solely for data export operations.
Exporting data from Avaya IQ June 2009 9
Integration with Avaya IQ reporting
10 Exporting data from Avaya IQ June 2009
Chapter 3: Access and license considerations
Access to the export report subject area is controlled by two authorization systems.
Standard data permissions
To access the appropriate set of report data, the client application or client application user must have a valid Avaya IQ user name and password. The same administration procedures used to create authentication credentials for a regular report user are also used to administer export report users.
License options
Data access for export reports is controlled by Avaya IQ licensing. Business partners who develop customer solutions need to purchase a lab machine license.
Enterprise customers can acquire one or more of the following data export options to obtain access to the report data they want to obtain:
• FEAT_CCR_HIST_DATAEXPORT: Provides access to the export reporting area that specifies all historical data.
• FEAT_CCR_REAL_DATAEXPORT: Provides access to the export reporting area that specifies:
- Same key performance indicator measures that are used in standard realtime dashboard reports.
- All real-time data.
Note:
Enterprise customers can use the Web License Manager tool to obtain information about the export license options that have been acquired.
Exporting data from Avaya IQ June 2009 11
Access and license considerations
12 Exporting data from Avaya IQ June 2009
Chapter 4: Supported data output formats
Data export supports production of export report outputs in either XML format or delimiterseparated text format.
Exporting data from Avaya IQ June 2009 13
Supported data output formats
14 Exporting data from Avaya IQ June 2009
Chapter 5: Data export modes
Synchronous export
The data is returned in a single message after the reporting system receives the data request from the client application. The synchronous export mode is most appropriate for real-time data sets that can be quickly executed and have high refresh rates.
Asynchronous export
The data is sent by the reporting system in one or more messages. This export mode is a three step process:
• The client application submits the data request to the reporting system and disconnects.
• The client periodically reconnects to the system and polls for the status of the request.
• When the export report is ready, the client requests data transmission in one or message segments. The client can specify a maximum size limit for message segments.
The asynchronous export mode is most appropriate for large historical data sets that execute slowly. Because the client does not maintain a continuous connection to the reporting system and data is partitioned into multiple messages, network utilization issues and firewall security issues associated with connection time-out settings can also be minimized or avoided.
Exporting data from Avaya IQ June 2009 15
Data export modes
16 Exporting data from Avaya IQ June 2009
Chapter 6: Custom data export reports
Data Export uses special custom reports that users create to specify the Avaya IQ report information that they want to obtain. Custom reports are developed in the Avaya IQ Report
Designer feature from special templates provided in the Data Export subject area in the reporting interface.
The Data Export subject area also includes various parameter reports. Users need to execute these reports to obtain the parameters they want to use as inputs for their custom export reports.
To get more information about creating custom export reports, refer to the Data Export
Programmer Guide document. This document is included in the zip file for the Data Export standard development kit.
Exporting data from Avaya IQ June 2009 17
Custom data export reports
18 Exporting data from Avaya IQ June 2009
Chapter 7: Standard development kit
The Avaya IQ product installation includes a standard development kit (SDK) for the data export API. The SDK is installed on all Avaya IQ servers. The SDK is available from the Avaya
DevConnect Web site: https://devconnect.avaya.com/public/dyn/d_dyn.jsp?
fn=479
The SDK includes the following items:
• A readme file that describes export API features and functions.
• A Web Services Description Language (WSDL) installation that defines the API.
• For client implementations that use Java and Eclipse, a .classpath file and a.project file that provide information about directory locations and other configuration specifications.
• Two different examples of API implementations, including an example based on Java and an example based on Perl with SOAP::Lite.
Note:
Personnel who use the export API to develop client applications also have the option to use other programming protocols that can interface with the data export web service.
Exporting data from Avaya IQ June 2009 19
Standard development kit
20 Exporting data from Avaya IQ June 2009
Index
A
asynchronous export mode ........................................
15
C
custom data export reports .........................................
17
D
data consistency, with standard reports .......................
9
data export
overview .................................................................
7
data export reports, custom ........................................
17
O
output formats ............................................................
13
overview, data export ...................................................
7
R
using Web License Manager ................................
11
refresh rates, real-time export reports ..........................
9
reports, custom data export ........................................
17
E
execution, export reports ..............................................
9
L
license options
for data export ......................................................
11
S
standard development kit
file location ...........................................................
19
synchronous export mode ..........................................
15
Exporting data from Avaya IQ June 2009 21
Index
22 Exporting data from Avaya IQ June 2009
