Using ASAP Reports

7 Using ASAP Reports

This chapter provides an overview of Oracle Communications ASAP Reports that are implemented with Oracle Analytics Server. The chapter also provides information on how to install, upload, and view ASAP reports.

You can install Oracle Analytics Server report templates as part of the ASAP client installation. You can view reports in Oracle Analytics Server using a web based URL. For more information on ASAP client installation, see the ASAP Installation Guide.

About Standard ASAP Reports

Table 7-1 lists the reports that are standard to ASAP and the necessary information to view them.

Table 7-1 Standard ASAP Reports

Report Name	Source Type	Table Name	Required Information	Information Included	Sorting Order
Aborted Work Orders Report	SARM	tbl_wo_audit	Start and End dates and times of the report Name of the Work Group(s) from which to retrieve a specific Work Group detail	Work Group name ID of the user who aborted the work order Order type Work Order ID number Due date	Ascending order by: Work Group User ID Date and time Work order ID
Activity Report	ADMIN	tbl_perf_order	The Report Type to be generated based on the selected option. Select P to generate a report for polling records Select S to generate a report for summary records Start and End dates and times of the report Name of the Work Group(s) from which to retrieve a specific Work Group detail	Work Group name Date Number of work orders received Number of work orders that are future dated Number of completed work orders Number of failed work orders Number of cancelled work orders Percentage of work orders failed	Ascending order by: Work Group Date and time of each record
ASDL Details on ASDL Command(s) Report	ADMIN	tbl_perf_asdl	Start and End dates and times of the report Name of the ASDL(s) from which to retrieve a specific ASDL detail	ASDL Name Date received Number of ASDL(s) received Number of ASDL(s) completed Number of ASDL(s) failed Average time for the ASDL to complete Maximum time for the ASDL to complete Minimum time for the ASDL to complete	Ascending order by: ASDL name Date and time of each record
ASDL Detail on Network Element(s) Report	ADMIN	tbl_perf_ne	Start and End dates and times of the report Name of the NE(s) from which to retrieve statistical ASDL detail	Network Element name Date received Number of ASDL received for the NE Number of completed ASDLs for the NE Number of failed ASDLs for the NE Average time to complete ASDLs for the NE Maximum time to complete ASDLs for the NE Minimum time to complete ASDLs for the NE	Ascending order by: Network Elements ASDL names Date and time of each record
CSDL(s) Detail Report	ADMIN	tbl_perf_csdl	Start and End dates and times of the report Name of the CSDL(s) from which to retrieve statistical CSDL detail	CSDL name Date received Number of CSDLs received Number of CSDL completed Number of CSDL failed Average time to complete CSDL Maximum time to complete CSDLs Minimum time to complete CSDLs	Ascending order by: CSDL name Date and time of each record
Last Activity Report	ADMIN	tbl_perf_order	The Report Type to be generated based on the selected option. Select P to generate a report for polling records Select S to generate a report for summary records Name of the Work Group(s) from which to retrieve a specific Work Group detail	Work Group name Number of work orders received Number of work orders that are future-dated Number of completed work orders Number of failed work orders Number of cancelled work orders Percentage of work orders that failed	Ascending order by Work Group.
Last ASDL Detail on ASDL Command(s) Report	ADMIN	tbl_perf_asdl	Name of the ASDL(s) from which to retrieve a specific ASDL statistical information	ASDL name Number of ASDLs received Number of ASDLs completed Average time (in seconds) for the ASDL to complete Maximum time (in seconds) for the ASDL to complete Minimum time (in seconds) for the ASDL to complete	Ascending order by ASDL name.
Last ASDL Detail on Network Element(s) Report	ADMIN	tbl_perf_ne	Name of the NE(s) from which to retrieve statistical ASDL detail	Network Element name Number of ASDLs received for the NE Number of completed ASDLs for the NE Number of failed ASDLs for the NE Average time to complete ASDLs for the NE Maximum time to complete ASDLs for the NE Minimum time to complete ASDLs for the NE	Ascending order by Network Elements.
Last CSDL(s) Detail Report	ADMIN	tbl_perf_csdl	Name of the CSDL(s) from which to retrieve statistical CSDL detail	CSDL name Number of CSDLs received Number of completed CSDLs Number of failed CSDLs Average time to complete CSDLs Maximum time to complete CSDLs Minimum time to complete CSDLs	Ascending order by CSDL name.
Last Soft Error Report	ADMIN	tbl_perf_ne_asdl	Name of the NE(s) from which to retrieve soft error detail	Network Element name ASDL name User Error description Number of soft errors	Ascending order by: Network Element ASDL User error
Last Switch Error History Report	ADMIN	tbl_perf_ne_asdl	Name of the NE(s) from which to retrieve switch history detail	Base Error type Network Element name ASDL Command User Error description Number of errors Number of NE errors Total number of base errors	Ascending order by: Base type Network Element ASDL name User error
Soft Error Report	ADMIN	tbl_perf_ne_asdl	Start and end date of the report Name of the NE(s) from which to retrieve soft error detail	Network Element name ASDL name Date Received User Error description Number of soft errors	Ascending order by: Network Elements ASDL User error Date and time of each record
Switch Error History Report	ADMIN	tbl_perf_ne_asdl	Start and end date of the report Name of the NE(s) from which to retrieve switch error history detail	Base error type Network Element name ASDL Command Date received User error description Number of errors	Ascending order by: Base type Network Element ASDL name User error Date and time of each record
Work Order Status Report	SARM	tbl_srq tbl_wrk_ord	Start and End dates and times of the report The name of the NE(s) from which to retrieve work order status detail Work Order Status	NE name Work order ID Work order due date Work order status (All, Pending, Completed, Cancelled, Failed, Stopped, or Other) Description of due date (Past Due, Due Today, or Future Dated)	Ascending order by: Network Element Status of the work order Provisioning date of the order
Work Order Summary Report	SARM	tbl_wrk_ord tbl_wo_event_queue	Start and End dates	Number of completed WO's Number of completed WO's with soft fail	Ascending order by: Status of the Work Order Provisioning date of order
Work Order Summary by NE Report	SARM	tbl_wrk_ord tbl_wo_event_queue tbl_srq	Start and End dates Name of NE (optional)	Number of completed WO's Number of completed WO's with soft fail Number of failed WO's Number of timed out	Ascending order by: Network Element Status of the Work Order Provisioning date of order
Work Order Summary by Source Report	SARM	tbl_wrk_ord tbl_wo_event_queue	Start and end dates Source is an external system ID that is passed with the work order (optional)	Number of completed WO's Number of completed WO's with soft fail Number of failed WO's Number of timed out	Ascending order by: Source Status of the Work Order Provisioning date of order
Work Order Processing Time Report	SARM	tbl_wrk_ord	Start and end dates	Average WO processing time for WOs with a status of WO_COMPLETE (104) or WO_FAILED (253)	Ascending order by: Status of the Work Order
Work Order Processing Time by NE Report	SARM	tbl_wrk_ord tbl_srq	Start and end dates NE (optional)	Average WO processing time for WOs with a status of WO_COMPLETE (104) or WO_FAILED (253) for the given NE	Ascending order by: Status of the Work Order
Work Order Processing Time by Source Report	SARM	tbl_wrk_ord	Start and end dates Source is an external system ID that is passed with the work order (optional)	Average WO processing time for WOs with a status of WO_COMPLETE (104) or WO_FAILED (253) for the given Source	Ascending order by: Status of the Work Order

Installation Overview

To set up your system to run ASAP reports, perform the following tasks:

Installing and Configuring Oracle Analytics Server

To set up Oracle Analytics Server, you need the following:

Administrator privileges on the computer where you install Oracle Analytics Server. The administrators can assign user rights. Depending on the rights administrators give to themselves and to others, users can customize reports based on the available parameters or schedule reports to run.
Oracle Analytics Server license

Installing Oracle Analytics Server

To install Oracle Analytics Server, download the software for the version specified in ASAP Compatibility Matrix and follow the instructions in Installing and Configuring Oracle Analytics Server, located here:

https://docs.oracle.com/en/middleware/bi/analytics-server/install-config-oas/installing-product-software.html

Setting Up Users for SARM and ADMIN Databases

Before you can access Oracle Analytics Server, you must create user IDs and passwords for the Service Activation Request Manager (SARM) and ADM databases. You must provide users with select access to the tables in these databases. For more information on setting up user IDs and passwords for SARM and ADM databases, see the ASAP Installation Guide.

You must ensure that the following servers are running:

ADM
SARM

To set up database user IDs and passwords:

You can give users the environment user IDs to access the databases. However, in most cases, set up separate reporting user IDs with only select access.
You must set up separate user IDs for different ASAP environments because you cannot use the same one across different environments.
You should limit the number of users with select access on SARM tables to avoid degrading ASAP performance.

Configuring JDBC Data Sources

For the ASAP report to run in Oracle Analytics Server, you need to configure data sources for the Admin and SARM databases.

To configure JDBC data sources for Admin and SARM databases:

Note:

Repeat the following steps for each database. For example, configure a JDBC data source for the ADMIN database, then repeat for the SARM database.

Log in to Oracle Analytics Server with administrator's privileges using the following URL:
```
http://ip_address:port/xmlpserver
```
Where ip_address and port are the IP address and port of the Oracle Analytics Server.

The Home screen appears.
Click Administration.

The Administration screen appears.
Under Data Sources, click JDBC Connection.

The Data Sources screen appears.
In the JDBC tab, click Add Data Source.
Enter the following fields for the new connection:
1. In the Data Source Name field, enter a name to represent the data source. Oracle recommends entering ADM_DS and SARM_DM for the Admin and SARM databases respectively.
2. From the Driver-Type list, select the database type.
  
  When you select a driver type, Oracle Analytics Server will automatically display the appropriate database driver class as well as provide the appropriate connection string format for your selected database.
3. You can update the Database Driver Class field if required.
4. In the Connection String field, enter the database host, port, and SID details.
5. In the Username field, enter the username to access the data source on the Admin or SARM database.
6. In the Password field, enter the password for the associated database user.
7. Select Use Proxy Authentication, to enable Proxy Authentication.
  
  Note:
  
  This is available only for Oracle 11g.
8. Click Test Connection to verify that the information was entered correctly.
9. Click Apply, if the connection is successful.

For more information, see "Set Up Data Sources" in the Administering Oracle Analytics Publisher in Oracle Analytics Server located here:

https://docs.oracle.com/en/middleware/bi/analytics-server/administer-publisher-oas/set-data-sources.html

Installing ASAP Report Templates

You must install the ASAP report templates before uploading on Oracle Analytics Server. For more information on installing the report templates, see the ASAP Installation Guide.

Note:

If you select the OCA thick client installation type as Custom, ensure that you select Report.

The reports templates are installed in the following directory:

ASAP_client_destination\BIReports

For example:

C:\Program Files (x86)\Oracle Communications\ASAP\BIReports

Uploading and Configuring ASAP Reports

To upload and configure ASAP reports on Oracle Analytics Server:

Log in to Oracle Analytics Server with administrator's privileges using the following URL:
```
http://ip_address:port/xmlpserver
```
Where ip_address and port are the IP address and port of the Oracle Analytics Server.

The Home screen appears.
Click the Catalog tab.
Click the My Folders folder in which you want to upload the report.
On the left-hand side of the window, under Tasks, click Upload.
Click Browse.

The Choose file dialog box appears.
From the list, select the .xdoz file for the specific report which you want to upload.

For example, if you are uploading the Activity Report, choose the Activity_Report.xdoz file from the ASAP_client_destination\BIReports\Activity Report directory.
Click Open, then click Upload.
Repeat steps 4 to step 7 for the .xdmz data model file for the specific report which you want to upload.

For example, if you are uploading the Activity Report, choose the Activity_Report.xdmz file from the ASAP_client_destination\BIReports\Activity Report directory.
Click Edit, for the newly uploaded .xdmz data model file.
Verify that the Default Data Source is pointing to the appropriate data source for the report.

The current report must point to the Admin data source or SARM data source. For more information on appropriate data sources for each report, see "About Standard ASAP Reports."
Click the Save icon.
Click Catalog.
Click Edit for the newly uploaded .xdoz report.
Click the Choose existing Data Model search icon below the report heading.
Select the corresponding .xdmz data model for the .xdoz report.
Click the Save icon.

Viewing ASAP Reports

You can generate the reports after uploading them on Oracle Analytics Server. For this, you can click Open on the specific report. You can view the generated reports using Oracle Analytics Server.

You can customize (filter) the reports based on the available parameters like Start Date, End Date, and so on. The availability of the parameters depends on the report.

Exporting Reports

You can choose a directory where you wish to save a report. The report can be saved in different formats namely, HTML, PDF, RTF, CSV, DATA (which is saved as a .xml file), and so on. The availability of formats depends on the report template.

To export a report:

Upload a specific report and its corresponding report template. For information on uploading reports, see "Uploading and Configuring ASAP Reports."
Click the Catalog tab.
From MyFolders, open the folder containing the uploaded ASAP reports.
Click Open on the report you want to view.
Specify the parameters for the report like Start Date, End Date, and so on. See Table 7-1 for more information on the parameters.
Click View to view the generated report.
Click Export.
Save the report on your local machine.

Printing Reports

To print a report to a printer:

On the generated report window, select the required report format like HTML, PDF, RTF, and so on.
Click Export to save the report onto your local machine. For more information on exporting reports, see "Exporting Reports."
Use the print option, to print the report, as available by the report format.

For information on scheduling and analyzing, see Report Designer's Guide in the Oracle Analytics Server documentation. For information on sending documents by e-mail, see Administrator's and Developer's Guide in the Oracle Analytics Server documentation.