Report Definition

Overview

This activity enables you to define the report details for a report task available in the user interfaces under an activity in a component. You can define the report files, addition report fields, associate business terms for report fields, define report-field mapping and associate main report – sub report mappings for a selected user interface.

Click the checkbox next to a component in the multiline and click the “Specify User Interface Layout” link from the “Specify Screens and Reports – Select Component” page.
Click the “Report Definition” link from the “Generate Service” tab in the “Specify User Interface Layout” page.

The “Report Definition” page appears.

The following details are displayed in the header:

Business Process	The description of the selected business process is displayed from the main page.
Component	The description of the selected component under the specified business process is displayed from the main page.
Activity	The description of the activity under the specified component is displayed from the main page.
User Interface	The description of the user interface under the specified activity is displayed from the main page.

Select the following fields in the header:

Report Task	Use the drop-down list box to select the available report task.
Report Type	Use the drop-down list box to select the type of report for which you want to define the details. The list of available report types such as “Crystal Reports” ,”DecisionWorks”, “PDF” etc. is displayed as options.
Launch Report Directly	Click the checkbox to indicate whether the report should be launched directly on clicking the activity (without launching the user interface). The input for the report can provided using the fetch task. Note: This option is applicable only once for an activity.
Service Required	Use the drop-down list box to select “Yes” or “No” to indicate whether services is required for the report or not. If service required is chosen as “Yes”, then the report is generated based on RVW services output. If service required is chosen as “No”, the report engine directly connects to the database and fetches the report details. This facility can be used when the volume of data is huge. At runtime the report connectivity details are obtained from the connection xml.

There are five tabs displayed namely “Define Report Files”, “Define Additional Report Fields”, “Associate Business Terms for Report Fields”, “Define Report – Field Mapping” and “Associate Main Report – Sub Report Mapping”.

Define Report Files

Click the “Define Report Files” tab from the “Report Definition” page.

This tab is displayed by default on launch of the page.

Enter the following details in the multiline:

Report File Name

The name of the report file along with file extension.

Main Report

Click the checkbox if you want to set the report file as the main report.

Note: Only one report should be set as main report.

Click “Save”.

The report files details are saved for the specified user interface.

Define Additional Report Fields

This tab enables you to define the additional header controls and the grid names. The added control information will be used only in the report definition.

Click the “Additional Report Fields” tab from the “Report Definition” page.

The “Additional Report Fields” tab is displayed.

Enter the following details in the multiline:

Note: The additional report fields definition is applicable only if Service Required is chosen as “Yes” in the header.

Report Field Name	The name of the report field.
Report Detail Section	Click the checkbox to indicate that the added control is a grid control. If the checkbox is unselected it indicates that the added control is a header control.

Click “Save”.

The additional report field details are saved for the specified user interface.

Note: Additional Report fields are used only when the user interface does not have the control information to design the reports. Through this tab you can provide the necessary additional fields for the report.

Associate Business Terms for Report Fields

Click the “Associate Business Terms for Report Fields” tab from the “Report Definition” page.

The “Associate Business Terms for Report Fields” tab is displayed.

Note: The business terms - report field association details are applicable only if “Service Required” is chosen as “Yes” in the header.

Select the following fields:

Report Section Type

Use the drop-down list box to select the report section type for which you want to associates the business terms. The options listed are “Header” and “Detail”.

Report Detail Field Name

If the report section type is chosen as “Detail”, then select the report detail field name for which you can add the columns and associate the business terms. The list of the report fields that have been defined is displayed as options.

If the report section type is “Header” then all the header control names are available in the grid. You can associate the business terms to it.

Note: The controls defined here appear as output parameters in the Stored Procedure that is generated for the report task. New header controls cannot be added in the grid it can be added only in “Define Additional Report Fields” tab.

Enter the following details in the multiline:

Report Field Name	The name of the report field. For e.g. you can define the names of the headers and the columns in the grid as report fields.
BT Name	The business term that you want to map to the report field. If you know the business term, enter the business term and press <Enter> or click to select a business term from the “Help on Business Terms” page. The last saved details of the specified business term are retrieved and displayed in the subsequent fields. You can also define a new business term here.
Data Type	From the drop-down list box select an option to indicate the data type to which the business term belongs. The data types listed are “Character – Ascii Fixed”, “Character – Ascii Variable”, “Character – Unicode Fixed”, “Character – Unicode Variable”, “Date”, “Date – Time”, “Integer”, “Numeric” and “Time”. Note: If the business term is specified the data type is automatically fetched and displayed when you press <Enter>.
Size	The length of the business term.
Precision	If the data type of the business term is chosen as “Numeric” select the precision type that you want to map to the business term drop-down list box. The list of precision types defined through the “Define Precision Types” tab in “Specify User Interface Preferences” page is displayed as options.

Click “Save”.

The business term association details are saved for the specified user interface.

Define Report - Field Mapping

Click the “Define Report – Field Mapping” tab from the “Report Definition” page.

The “Define Report – Field Mapping” tab is displayed.

Select the following fields:

Report File Name	Use the drop-down list box to select the report file for which you want to map the fields. The reports that have been defined through the “Define Report Files” tab are listed as options.
Page	Use the drop-down list box to select the page for which you want to map the fields. The system displays the pages defined for the selected report as options.
Section	Use the drop-down list box to select the section in the selected page for which you want to map the fields. The list of sections defined for the selected page is displayed as options.
Fetch Additional Report Field	Use the drop-down list box to select “Yes” or “No” to indicate whether you want to fetch the additional report fields that have been defined through the “Define Additional Report Fields” tab.

The system displays the following details in the multiline for the selected report filed, page and section:

Report Details Field Name	The name of the report details field.
Report Field Name	The name of the report field.
Report Hidden View Name	If there are hidden views defined for the field, the name of the hidden view is displayed.
Page	The name of the page for which the control is available is displayed.
Section	The name of the section for which the control is available is displayed.

Select the following field in the multiline:

Report Field Mapping

Use the drop-down list box to select “Map” to map the report field name for the report.

Click “Save”.

The report – field mapping details are saved for a selected report page and section in the specified user interface.

Note: When Fetch Additional Report Field is selected as “Yes” then the additional fields are available for all the selected Pages and Sections. If it is selected as “No” then the additional fields will not be available.

The hidden controls defined in the Hidden controls definition will also be available for all the selected Page and Sections.

Associate Main Report – Sub Report Mapping

Click the “Define Report – Field Mapping” tab from the “Report Definition” page.

The “Define Report – Field Mapping” tab is displayed.

The following field is displayed:

Main Report Name

The name of the main report is displayed.

Select the following field:

Report File Name

Use the drop-down list box to select the report file for which you want to map the fields. The reports that have defined through the “Define Report Files” tab other than main report are listed as options.

The following details are displayed in the multiline for the specified main report:

Main Report Detail Field Name	The name of the detail field in the main report.
Main Report Field Name	The name of the field in the main report.
Main Report Hidden View Name	The name of the hidden view in the main report.

Enter the following fields in the multiline:

Sub Report Detail Field Name

The name of the sub report detail field that you want to map to main report detail field.

Click to select a sub report detail field from the “Help on Sub Report Fields" page.

Sub Report Field Name

The name of the field is displayed for the specified sub report detail field name.

Sub Report Hidden View Name

The name of the hidden view is displayed for the specified sub report detail field name.

Click “Save”.

The main report – sub report field mapping details are saved for the specified user interface.

To proceed carry out the following:

Click the “Generate Connection XML” link to generate XML for the report data for a specified user interface.

The system launches the “Connection XML Definition” page that enables you to define the details for generating the XML for report data for a specified user interface.

Note: Generate connection XML is required only when “Service Required” in the header is selected as “No”.

Getting familiar with the pages inside

Go to page…	For…
Connection XML Definition	Specifying the connection XML definition details.

Prerequisites:

4 Business processes, components, activities and user interfaces should have been defined through the “Define Process” activity.

4 Control types, precision types, report task and business terms should have defined in the Specify User Interface Layout page for the components.