Specifying Report Parameters

This topic applies to the following Report tools:

Report Email

Report Export File

Report HTML Export

Report Print

Determining Which Parameters are Used in a Report

The input values from the Report tool must correspond to the Parameter Data associated with the report. Follow these steps to determine which parameters are used in a report.

1. Open the Reports container in Interaction Administrator. Here you will find a list of all the reports that are defined for CIC.

2. Double-click on one of the reports to open the Report Configuration notebook for that report.

3. In the notebook, click the Tables/Parameter page. You will see a window that contains parameter data. This parameter data is the information needed by the report.

4. Select one of the Parameter Data entries, and then click Edit.  The Parameter Definition dialog box appears, listing the name and value type for the selected entry.

5. If the value type is string, you need to include that name in the List of String value for the tool's String Parameter Name parameter. If the value type is Date or Time, you should include that name in the List of String value for the tool's DateTime Parameter Name parameter. If the value is Number, you should include that name in the List of String value for the tool's Number Parameter Name parameter.

Notes: The DateTime and Number parameters were used for CIC reports in IC version 2.2 and previous. In newer reports, datetime and numeric values are specified as string parameters.

When you use a report toolstep to export a historical report, use only user-supplied parameters. You can set values of other types of parameters (such as fixed to default and system-supplied) in Interaction Administrator rather than through a handler. For more information about parameter types, see "Parameter Definition for Reports" in the Interaction Administrator Help.

Examples of Boolean Parameter Names and Values

The following list provides examples of Boolean parameter names and values:

Examples of String Parameter Names and Values

The reports expect parameter names and values to appear in a specific format. For example, a DateTime range parameter value needs to be entered as a string in the format "YYYY/MM/DD HH:DD:SS-YYYY/MM/DD HH:DD:SS."

For user reports, the string list should contain the user name.

The following list provides examples of various types of string parameter names and values in the appropriate formats:

Examples of DateTime Parameter Names and Values

Note: The DateTime parameters were used primarily for reports created prior to IC version 2.3. Newer reports use string parameters to specify dates, times, and ranges and lists of dates and times.

The following is an example of using the DateTime parameter name and value:

For more information about the MakeDateTime format, see Creating Datetime Values.

Examples of Number Parameter Names and Values

Note: The Number parameters were used primarily for reports created prior to IC version 2.3. Newer reports use string parameters to specify numbers, and lists and ranges of numbers.