Please login or register to access secure site features.

Note: By continuing to use DevConnect Program Services you agree to our latest Registered Member Terms.

Sign in using DevConnect ID

Forgot password?

Trouble logging in?

Submit a ticket for Registration Support.

I have an SSO ID

?
sign in

Don't have a DevConnect or SSO ID ?

Create a DevConnect account or join the program.

register now
^

FAQ: Avaya IQ

This document contains the Frequently Asked Questions on Avaya IQ

What is included in the Avaya IQ Data Export SDK?

The Avaya IQ Data Export SDK contains the Java classes for the web service and Ant build files to compile and run a sample java client that is also included. It also contains a sample Perl client that uses the Avaya IQ Data Export web service.

How to configure Avaya IQ Data Export web service?

The following steps can be used to configure Avaya IQ Data Export web service:

  1. On the Report Management server, verify that the following file is present, $JBOSS_HOME/server/ccr3/deploy/dataexport.war. If the file is not present, the Avaya IQ installation has not completed successfully.
  2. On the Report Management server, verify that the following directory is present, $JBOSS_HOME/server/ccr3/tmp/deploy/tmp*dataexport.war. If the directory is not present, the ReportingJBoss container needs to be started up.
  3. On the Report Management server, make sure the ReportingJBoss container is running. Open a web browser, and try to access the Data Export web service using the URL like this, http://localhost:10080/dataexport/dataexportservice

How to turn on the debug trace for Avaya IQ Data Export services?

Edit the log4j.xml file under $JBOSS_HOME/server/ccr3/conf on the Reporting Host. For example,

<category name="dataExportLogger" additivity="false">
   <priority value="INFO" />
   <appender-ref ref="dataExportLogger"/>
  </category>

Change 'INFO' to 'DEBUG.' The data export services log messages can be found in /var/log/Avaya/CCR/RPT_<report container's uuid>/dataexport.log.

How to run the Avaya IQ Data Export client sample code included in the SDK?

The Java sample client requires Sun JDK-1.5.0_07 or above and Apache Ant.

  • Extract the dataexportsdk.zip under the working directory. (unzip ./dataexportsdk.zip)
  • Change the working directory to dataexport/java.
  • Edit the build_client.xml.
  • Replace 'localhost:10080' with the Report Management server full host name and the ReportingJBoss container port number (usually, 10080).
  • To export a report other than the sample one, change the argument values of 'report name path' and 'report parameter settings' in the 'run-client' Ant target.
  • Set the right output format value of 'The output format in CSV or XML' argument in 'run-*-client' Ant targets. The XML schema of XML format output data is dataexport/dataexportxmldata.xsd.
  • Set the output data page size in 'The page size in bytes for the output data' argument if the default size is not used.
  • Set the correct IQ user and the password in 'IQ user name' and 'IQ user password' arguments.
  • Run the Java sample client using this command: ant -f build_client.xml all
  • There is a preconfigured Eclipse project included. This client sample can be inputted as a Java project in the Eclipse IDE by pointing the workspace to the working directory.

The Perl SOAP::Lite sample code requires Perl SOAP::Lite 0.65 or above.
  • Change the working directory to dataexport/perl.
  • Edit dataExport.pl. Change the web service URL from localhost:10080 to the Report Management server name and the ReportingJBoss container port number, (e.g myserver.fun.com:10080)
  • Run the sample code using this command: perl dataExport.pl

What is the intended usage of the Avaya IQ Data Export SDK?

The data export feature gives users the ability to implement custom data integrations between Avaya IQ and other enterprise resources and applications.

Extracted data can be used in external applications for purposes such as:

  • Displaying real-time key performance indicators (KPI) in wallboard and dashboard systems.
  • Providing workforce management data to agent scheduling and adherence algorithms.
  • Using contact center metrics as input to call routing algorithms.
  • Providing detailed data to analytics applications.

What data is available for export in Avaya IQ?

All real-time and historical data that can be specified by the Avaya IQ reporting model is available for export. Because export data is derived through the reporting model, all calculated data and KPI data is consistent with Avaya IQ data that users can obtain from standard and custom reports that are executed from the product reporting interface.

To specify the reporting information to export, users develop custom reports from data export report templates that are provided for that purpose.

How to create custom export reports?

  1. Open a data export template in Report Designer, add measures and other report items of interest. In addition, items in the template that are not needed for the custom export report can be deleted.
  2. Save the custom export report to the Data Export Reports folder or a subfolder that was previously created under that folder.
  3. Open the saved report in the editor, and copy the information from the ID field. This information must be passed through the API to execute the report.
  4. Identify the parameter reports that have the report input information needed for the custom export report. This information must also be passed through the API when the report is executed.
  5. Add the information required by the data export API to your export script or program.
Do not move the report after saving the custom report to the Data Export Reports or a subfolder therein. If the custom report is moved after it is saved, the report might not execute when commands are sent through the API.

How to activate the debug trace in the IQ Data Export SDK?

  1. On the Reporting Host, locate the log4j.xml file under the following path:
    $JBOSS_HOME/server/ccr3/conf
  2. Find the following lines:
    <category name="dataExportLogger" additivity="false">
    <priority value="INFO" />
    <appender-ref ref="dataExportLogger"/>
    </category>
  3. Change 'INFO' to 'DEBUG.'
  4. After this revision is made, the trace information is written to the data export services log. The log is located under the following path:
    /var/log/Avaya/CCR/RPT_<your report container uuid>/dataexport.log