Enabling Service Request Reports

This chapter describes how you can set up the printing of service requests and cases via an integration with Oracle XML Publisher.

This chapter covers the following topics:

• Overview of Service Request Reports
• Enabling the Printing of Service Request Reports
• Specifying the Data Definition for User Reports
• Seeded Data Definition Contents

Overview of Service Request Reports

Users of all Oracle TeleService application modules can print the contents of service requests and cases, and generate a profit margin report for each service request, in HTML, PDF, RTF, and XSL formats via an integration with Oracle XML Publisher.

Your application comes with three data definitions ready for use for a service request: a detail report, a summary report, and a profit margin report. Each data definition comes with its own template for an English-language report as listed in the table below:

Data Definition	Corresponding Template	Template Description
Service Request Detail Definition (CS_SR_DETAIL_DEF)	Service Request Detail Report Template (CS_SR_DETAIL_TMP_en)	Includes all of the available service request attributes including charges, the two descriptive flex fields, and extensible attributes.
Service Request Summary Definition (CS_SR_SUMMARY_DEF)	Service Request Summary Report Template (CS_SR_SUMMARY_ TMP_en)	Includes a subset of the detailed report attributes including the same charges information as the detailed report.
Profit Margin Data Definition (CS_COST_DEF)	Profit Margin Report Template (CS_COST_TMP_en)	Includes all the cost and charges details for a particular service request.

You can modify the seeded templates to change the existing data definitions using the Oracle XML Publisher Template Builder, a Microsoft Word macro.

You cannot modify the original seeded templates but you can modify copies and end-date the originals in Oracle XML Publisher's Template Manager.

Using personalization, you can set up the application to enable users to print based on templates created based on either the detailed data definition or the summary data definition. (By default, the application enables the detailed data definition).

To create a custom template:

1. Under the XML Publisher Administrator responsibility, navigate to Templates and the Templates page appears.

2. Search for the required template.

3. Click on Duplicate icon. The Copy Template page appears. Click Apply.

4. From the View Template page, click Download to download the RTF template and save it to your local machine. Modify the RTF template as required.

5. Click the Update icon and the Update File page appears. Click Browse to select the updated RTF file from your local machine. Click Apply to update the template definition with the new RTF file.

Setting Up the Profit Margin Report

1. By default the Profit Margin Report is enabled from the Service Request Form and Update Service Request page (HTML).

2. Add the function Access Profit Margin Report Special Menu Item to the responsibility menu.

   Note: This step is optional. It is required only if the user has a new menu.

3. Ensure that the action item for the Profit Margin Report is enabled in the lookup CSZ_GLOBAL_ACTIONS to access the report from the Update Service Request Page (HTML). This setup is done by default.

Enabling the Printing of Service Request Reports

Use this general procedure to enable printing.

Prerequisites:

You must have Oracle XML Publisher implemented.

To enable printing of service request reports

1. Copy and modify the template documents, using Microsoft Word and XML Publisher Template Wizard, following the procedures described in the Oracle XML Publisher Report Designer's Guide.

   If you are using Case Management, you must change all references to “service request” to “case”.

   You must also modify the templates if you are using the two descriptive flexfields provided with the application: you must enter the prompts for the additional fields you have added. The templates list them only as Prompt 1, Prompt 2, and so on.

   You can view the fields available in the three data definitions and their seeded reports in Seeded Data Definition Contents.

2. Upload and register the templates you have created into Oracle XML Publisher according to the procedures in the Oracle XML Publisher Report Designer's Guide.

3. Optionally, personalize the XML Publisher page where users select the report they wish to see. By default, the page permits users to select a report based on the detailed data definition. You can personalize the page to show reports based on the summary template by following the steps outlined in Specifying Which Data Definition Reports are Available for Users.

Specifying the Data Definition for User Reports

The list of reports users have available for printing service requests is based on the data definition you specify for the XML Publisher page where users make their selection. By default, this page is set to the detailed data definition (CS_SR_DETAIL_DEF), so users can choose reports based on that definition. Use this procedure to specify the summary data definition.

To specify a different data definition

1. Display any service request in the application you are using.

2. Navigate to the page where you select the report template. In HTML applications (Case Management, Customer Support, and Service Desk) this means selecting Generate Report from the Action drop-down list and clicking Go. In Oracle TeleService's Service Request window, choose Print Request from the Tools1 menu.

   The template selection page appears.

   

3. Select the Personalize Page link at the top of the page.

4. Edit the Message Choice: Datasource field by clicking Personalize.

   

5. Enter the data definition you want to use in the Initial Value field at the desired personalization level. For example, CS_SR_SUMMARY_DEF for the seeded summary data definition.

6. Click Apply.

Seeded Data Definition Contents

This section lists the service request information included in the three seeded data definitions. Each table specifies whether an attribute is available in the detailed data definition (CS_SR_DETAIL_DEF), summary data definition (CS_SR_SUMMARY_DEF), or the profit margin data definition (CS_COST_DEF).

The seeded templates for Service Request Detail and Service Request Summary reports include most of the attributes in their respective data definitions. The detailed template includes all. The summary template includes all but the following:

• Extensible Attributes

• Internal Flexfield

• External flexfield

Customer Information

The following table lists the customer-related parameters:

Attribute	Detailed Definition	Summary Definition
Account	Yes	Yes (hidden)
Account ID (Application-generated ID included but not displayed by default)	Yes	Yes
Customer ID (Application-generated ID included but not displayed by default)	Yes	Yes (hidden)
Customer Number	Yes	Yes
Name	Yes	Yes
Type	Yes	Yes

Contact Information

The following table lists the contact-related parameters:

Attribute	Detailed Definition	Summary Definition
E-mail	Yes	Yes
Name	Yes	Yes
Phone	Yes	Yes
Type	Yes	Yes

Service Request Subject

This is the information relating to the subject of the service request.

Attribute	Detailed Definition	Summary Definition
Category	Yes	Yes
Component	Yes	No
Component Revision	Yes	No
Incident Address	Yes	Yes
Item	Yes	Yes
Item Desc	Yes	Yes
Item Instance	Yes	Yes
Item Revision	Yes	No
Problem Code	Yes	No
Problem Summary	Yes	No
Resolution Code	Yes	No
Resolution Summary	Yes	No
Serial Number	Yes	Yes
Sub-Component	Yes	No
Sub-Component Revision	Yes	No
System Number	Yes	No
Tag Number	Yes	No

Service Request Information

The following table lists the service request-related parameters:

Attribute	Detailed Definition	Summary Definition
Created By	Yes	Yes (hidden)
Group	Yes	Yes
Incident Date	Yes	Yes
Owner	Yes	Yes
Owner Type	Yes	Yes
Reported Date	Yes	Yes
Resolve By Date	Yes	Yes
Resolved On Date	Yes	Yes
Respond By Date	Yes	Yes
Responded On Date	Yes	Yes
Severity	Yes	Yes
Status	Yes	Yes
Type	Yes	Yes

Contract

This is information about the contract selected for the service request.

Attribute	Detailed Definition	Summary Definition
Coverage	Yes	Yes
Number	Yes	Yes
Service	Yes	Yes

Associated Parties

Associated parties are used only in Case Management. If a service request includes multiple contacts and contact points they will show up in this section.

Attribute	Detailed Definition	Summary Definition
Contact	Yes	No
Contact By	Yes	No
Party Name	Yes	No
Party Role	Yes	No
Party Type	Yes	No

Service Request Tasks

The following table lists the tasks-related attributes:

Attribute	Detailed Definition	Summary Definition
Date	Yes	No
Description	Yes	No
Number	Yes	No
Owner	Yes	No
Priority	Yes	No
Status	Yes	No
Subject	Yes	No
Type	Yes	No

Linked Solutions

The following table lists the knowledge management-related attributes:

Attribute	Detailed Definition	Summary Definition
Solution Number	Yes	No
Title	Yes	No
Updated Date	Yes	No

Notes

The following table lists the notes-related attributes:

Attribute	Detailed Definition	Summary Definition
Created By	Yes	No
Date Entered	Yes	No
Description	Yes	No
Detail	Yes	No
Type	Yes	No
Visibility	Yes	No

Audit Information

Your application automatically records changes to important fields, including the original and changed value, who made the change, and the date the change was made. The data definition includes audit information on the following fields:

• Group Owner

• Owner

• Resolution Date

• Resource Type (Owner Type)

• Severity

• Status

• Type

• Urgency

The information listed in the following table appears in the report for each of the audit fields:

Attribute	Detailed Definition	Summary Definition
Audit Field	Yes	No
Name	Yes	No
New Value	Yes	No
Old Value	Yes	No
Update Date	Yes	No
User Name	Yes	No

Interaction History

The application automatically tracks the agent interactions with the customer in interaction history. The following interaction attributes are available for the report.

Attribute	Detailed Definition	Summary Definition
Agent	Yes	No
Interaction ID	Yes	No
Outcome	Yes	No
Reason	Yes	No
Result	Yes	No
Start Date	Yes	No

Related Service Requests

Agents can add links to related service requests and specify the relationship. The following information is available for the reports:

Attribute	Detailed Definition	Summary Definition
Number	Yes	No
Owner	Yes	No
Relationship	Yes	No
Severity	Yes	No
Status	Yes	No
Summary	Yes	No

Related Objects

Agents can link a service request to another Oracle E-Business Suite object. The following information is available in the reports:

Attribute	Detailed Definition	Summary Definition
Description	Yes	No
Number	Yes	No
Object	Yes	No

Internal Descriptive Flexfield

The detailed data definition includes information from the descriptive flexfield located on the Workbench tab of the Service Request window. The seeded template based on this definition omits it. If you have implemented the capture of additional service request information using this flexfield, you must add this information to your template and modify the prompts to correspond to the prompts in the flexfield.

ATTRIBUTE1	Detailed Definition	Summary Definition
ATTRIBUTE2	Yes	No
ATTRIBUTE3	Yes	No
ATTRIBUTE4	Yes	No
ATTRIBUTE5	Yes	No
ATTRIBUTE6	Yes	No
ATTRIBUTE7	Yes	No
ATTRIBUTE8	Yes	No
ATTRIBUTE9	Yes	No
ATTRIBUTE10	Yes	No
ATTRIBUTE11	Yes	No
ATTRIBUTE12	Yes	No
ATTRIBUTE13	Yes	No
ATTRIBUTE14	Yes	No
ATTRIBUTE15	Yes	No
INCIDENT_CONTEXT	Yes	No

External Descriptive Flexfield

The detailed data definition includes information from the descriptive flexfield located on the header of the Service Request window. The seeded template based on this definition omits it. If you have implemented the capture of additional information using this flexfield, you must add this information to your template and modify the prompts to correspond to the prompts in the flexfield.

Attribute	Detailed Definition	Summary Definition
EXT_ATTRIBUTE1	Yes	No
EXT_ATTRIBUTE2	Yes	No
EXT_ATTRIBUTE3	Yes	No
EXT_ATTRIBUTE4	Yes	No
EXT_ATTRIBUTE5	Yes	No
EXT_ATTRIBUTE6	Yes	No
EXT_ATTRIBUTE7	Yes	No
EXT_ATTRIBUTE8	Yes	No
EXT_ATTRIBUTE9	Yes	No
EXT_ATTRIBUTE10	Yes	No
EXT_ATTRIBUTE11	Yes	No
EXT_ATTRIBUTE12	Yes	No
EXT_ATTRIBUTE13	Yes	No
EXT_ATTRIBUTE14	Yes	No
EXT_ATTRIBUTE15	Yes	No
EXT_CONTEXT	Yes	No

Service Request Extensible Attributes

Service request extensible attributes are included in the detailed data definition but not in the seeded template as described in the table below:

Attribute	Detailed Definition	Summary Definition
ATTR_GROUP_DISP_NAME	Yes	No
ATTR_UNIT_OF_MEASURE	Yes	No
ATTR_VALUE_DISPLAY	Yes	No
GROUP	Yes	No

Charges Information

The following charges information appears in both the summary and detailed data definitions and reports:

Estimated Charges

The estimated charges in the following table are included:

Attribute	Detailed Definition	Summary Definition
Currency Code	Yes	Yes
Extended Price	Yes	Yes
Item	Yes	Yes
Item Description	Yes	Yes
Net Price	Yes	Yes
Quantity	Yes	Yes
Service Activity	Yes	Yes
Unit Price	Yes	Yes
UOM	Yes	Yes

Submitted Charges

The submitted charges listed in the table below are included:

Attribute	Detailed Definition	Summary Definition
Currency Code	Yes	Yes
Extended Price	Yes	Yes
Item	Yes	Yes
Item Description	Yes	Yes
Net Price	Yes	Yes
Quantity	Yes	Yes
Service Activity	Yes	Yes
Unit Price	Yes	Yes
UOM	Yes	Yes

Unsubmitted Charges

The unsubmitted charges in the following table are included:

Attribute	Detailed Definition	Summary Definition
Currency Code	Yes	Yes
Extended Price	Yes	Yes
Item	Yes	Yes
Item Description	Yes	Yes
Net Price	Yes	Yes
Quantity	Yes	Yes
Service Activity	Yes	Yes
Unit Price	Yes	Yes
UOM	Yes	Yes

Profit Margin Information

The Profit Margin Report displays the following regions: Customer Information, Service Request Information, Summary Information, and Transaction Details.

Customer Information

This is the customer related information.

• Customer Type

• Customer Name

• Customer Number

• Account Number

• Contact Type

• Contact Name

• Contact Phone Number

• Contact Email

Service Request Information

This is the service request related information.

• Incident Number

• Incident ID

• Problem Summary

• Problem Code

• Resolution Code

• Resolution Summary

• Reported Date

• Resolve By

• Incident Occurred Date

• Request Type

• Request Status

• Request Urgency

• Request Severity

• Request Importance Level

• Service Request Group

• Service Request Owner

• Product

• Product Description

• Serial Number

• Operating Unit

Summary Information

This section displays the summary of the revenues, cost and profit by billing type.

• Material Revenue

• Labor Revenue

• Expense Revenue

• Total Revenue

• Material Cost

• Labor Cost

• Expense Cost

• Total Costs

• Material Profit

• Labor Profit

• Expense Profit

• Total Profit

• Material Profit%

• Labor Profit%

• Expense Profit%

• Total Profit%

Transaction Details

This section lists all the transactions (costs, debrief, repair orders, charges) for a service request.

• Billing Type

• Currency Code

• Operating Unit

• Estimate Detail ID

• Line Number

• Charge Creation Date

• Cost ID

• Transaction Type ID

• Service Activity Code

• Business Process Name

• Business Process ID

• Item

• Item Description

• Quantity

• UOM

• List Price

• Override Unit Price

• Extended Price

• Contract Discount Amount

• Net Charges

Repair Order Information

• Item

• Serial Number

• Repair Order Number

• Repair Type

Debrief Information

• Quantity

• Item

Cost

• Unit Cost

• Extended Cost

Profit

• Profit Margin

• Profit Margin%