- Contents
Interaction Administrator Help
Report Configuration
Use Report Management to create custom parameters and related report metadata. The reports configured in Report Management are run in Interaction Reporter in IC Business Manager. The Report Configuration page allows you to edit and manage metadata related to a report.
Note: Non-master administrators require the View User Queue List access control right to configure reports.
Report Configuration page
The Report Configuration page has two views, the master view and the details view.
Master View
The master view displays a list of report Categories and the Reports associated with them.
You can take actions on the master view. The actions include: Adding, Editing, Copying, Deleting, and Ordering Categories and Reports in the lists.
Note: In order
to edit a report, you must click the lock icon to unlock the report. You
can unlock reports if you have the Interaction
Report Administrator security right. For more information, see
Assign security rights.
If Genesys updates the definition of a standard report, the new version
will overwrite any customizations
that have been made to it. Therefore, if you want to create a custom report,
first copy a standard report. On the General
details tab, change the value in the File
Name field. Then make your customizations and save the report.
Your copied report will not be overwritten by future PureConnect releases.
Details View
The details view displays specific information about the item selected in the master view, grouped by tabs.
Report Management groups the metadata information in the details view in the following tabs:
General Tab
The General details tab contains basic information for the selected report. The detailed information for the fields on this tab is described in the following table.
|
General Tab |
|
|
Field |
Description |
|
Name |
Name of the report |
|
SubTitle |
Subtitle of the report |
|
Description |
Description of the report |
|
Friendly Key |
A unique value that easily identifies the instance in the database |
|
Assembly Name |
The assembly within which the report exists |
|
Class Name |
The class name that identifies the report with the assembly |
|
Orientation |
Identifies if the report is printed in landscape or portrait |
|
IC Data Source |
The CIC data source of the report |
|
File Name |
This is the file name of a Crystal Reports
report. All Crystal Reports reports must have a file name with
an .RPT extension. |
Parameters Tab
The Parameters details tab contains metadata information for report parameters. The parameter list displays parameters for the selected report in the master view. The parameter information is defined in sub-tabs by: General, Data, Custom Data, Miscellaneous, SQL Table Columns, and the sub-tab fields are defined in the following table. You can take actions on the Parameters tab. The actions include: Adding, Editing, Deleting, and Ordering Parameters in the list.
|
Parameters Tab |
||
|
Sub-tab |
Field |
Description |
|
General |
Name |
Name of the parameter |
|
|
Description |
Description of the parameter |
|
|
Friendly Key |
A unique value that easily identifies the instance in the database |
|
|
Assembly Name |
The assembly that houses the parameter |
|
|
Class Name |
The class name of the parameter within the defined assembly |
|
|
Required |
Check box to select if the parameter is required to run the report |
|
Data |
Source |
The source of the parameter, user supplied or fixed |
|
|
Data Type |
The type of data the parameter is expecting, for example, number, date, or string |
|
|
Default Value |
Default value for the parameter |
|
|
Convert Date to GMT |
The check box that enables conversion of datetime data to GMT only works for reports that use stored procedures. This includes new Crystal Reports and all Active reports. |
|
Custom Data |
Custom Data 1 |
A bucket field that can be used for any purpose when building your own parameters |
|
|
Custom Data 2 |
A bucket field that can be used for any purpose when building your own parameters |
|
|
Custom Data 3 |
A bucket field that can be used for any purpose when building your own parameters |
|
Miscellaneous |
Allow Sample |
A check box to indicate if the parameter allows for a search of distinct values from the reports stored procedure that uses the stored procedure sample |
|
|
Allow Or |
A check box to indicate if the parameter supports OR logic |
|
|
Parameter Type |
Drop-down box to select parameter type, Filter, Informational, or Threshold |
|
|
Visible |
A check box to select if the parameter is visible within IC Business Manager |
|
|
User Control Assembly Name |
The assembly that houses the parameter |
|
|
User Control Class Name |
The class name of the parameter within the defined assembly |
|
SQL Table Columns |
Column Name |
The name of the parameter in the Crystal template that maps to the data in the database column. |
|
|
Column Name2 |
An additional column name to use if the parameter references two columns in the stored procedure |
Note: You can configure secure report parameters to limit which data users can report on. For more information, see Configure secure report parameters.
Flexible Columns Tab
The Flexible Columns details tab contains metadata information for the selected report. The detailed information for the fields on this tab is described in the following table. You can take actions on the Flexible Columns tab. The actions include: Adding, Editing, and Deleting Flexible Columns in the list.
|
Flexible Columns Tab |
|
|
Field |
Description |
|
Name |
Name of the flexible column as used by metadata |
|
Description |
Description of the flexible column |
|
Flexible Column Name |
Name of the flexible column as shown on the report |
Sections Tab
The Sections details tab contains metadata information for the selected report. The detailed information for the fields on this tab is described in the following table. You can take actions on the Sections tab. The actions include: Adding, Editing, and Deleting Sections in the list.
|
Sections Tab |
|
|
Field |
Description |
|
Name |
Name of the report section |
|
Section Visible |
Check box that indicates if the report section is visible in the final report |
Tables
The Tables details tab displays the where the data used to build Crystal Reports comes from. For active reports, the fields in the Tables detail tab are unavailable.
|
Custom Data Tab |
|
|
Field |
Description |
|
Table Name |
Name of the database table |
|
IC Data Source |
Name of the CIC data source. |
Custom Data Tab
The Custom Data details tab contains metadata information for the selected report. The detailed information for the fields on this tab is described in the following table. You can take actions on the Custom Data tab. The actions include: Adding, Editing, and Deleting Custom Data elements in the list.
|
Custom Data Tab |
|
|
Field |
Description |
|
Name |
Name of the custom data |
|
Description |
Description of the custom data |
|
Custom Data |
A bucket field that can be used for any purpose when building your own report |
|
Encrypted |
A check box that indicates if the data put in the custom data field should be encrypted when saving to the database |
Advanced Tab
The Advanced details tab contains metadata information for the selected report. The detailed information for the fields on this tab is described in the following table.
Note: Most of the fields on this details tab are for Active reports only. They do not apply to Crystal Reports.
|
Advanced Tab |
|
|
Field |
Description |
|
Report Visible |
Check box that indicates if the report is visible in IC Business Manager |
|
Report Type |
A list that displays the report type: Active Report or Crystal Report. |
|
Stored Procedure |
Stored procedure the report runs to retrieve its data |
|
Stored Procedure Count |
Stored procedure run to indicate the size of the total return of the reports stored procedure |
|
Stored Procedure Samp |
Stored procedure that returns a subset of the report's stored procedure, usually a collection of single distinct values |
|
Linked Report Friendly Key |
This value represents a Friendly Key of another report. The Linked Report Friendly Key is used to link reports, such as when a summary report might have detail links that a user can click to see all the information for a particular detail. |
|
Allow Edit Params |
A check box that indicates if the user can edit the report's parameters within IC Business Manager |
|
Allow Count Button |
A check box that indicates if the report allows for the stored_procedure_count sproc to be run in IC Business Manager |
|
Require ACL |
A check box, selected for true, indicates that the Access Control List is checked to verify that the user has permission to view the report from the report list in Interaction Reporter. |
|
Report Timeout Period |
The period of time, in seconds, before the report times out--default is 1800 |
|
Notes |
User notes field |
Related Topics
Report Management