Summary

Table of Contents

• Basic Setup
  • Report Id
  • Name
  • Description
• Report Access
  • Role
  • View
• Field
  • Field Expression
  • Type
  • Data Type
  • Field Name
• Aggregator
  • Function
  • Iteration
  • Label
  • Condition
• Sort
  • Order
  • Sequence
• Writer
  • Class Name
• Writer Param
  • Param Name
  • Param Value
• Report Parameter
  • Parameter Name
  • Text
  • Display Type
  • Default Value
• Parameter Choice
  • Data Value
  • Display Value
• Filter
  • Filter Expression

This worksheet allows for the building of permanent reports in the Ad-Hoc Reports Manager. A report created here will not be editable in the application.

Basic Setup

Report Id

This is the unique variable identifier for the report; e.g., demographicsReport, adverseEvents.

Name

This is the name of the report as it will appear to end users.

Description

This is the optional description for the report, which will only appear in the XML file.

Report Access

Role

A list of Role Names to be granted access to this report. A single role is specified per cell.

View

The ability to define which roles can view the report. The options are ‘true’ for the report to be viewable to that specified role, or ‘false’ to hide the report from view. The default option is ‘false.’

Note: If no roles or views are specified, the report becomes viewable by all roles.

Field

Field Expression

This is the definition of the expression for each field in the report. The expression will either reference a question using the reference notation, or it will be a resolvable value using the expression language (formula field). If the expression is a formula, the Data Type and Name fields should be filled out, as well.

Type

This defines the type of Field Expression – an existing question (data) or calculated field (expression).

Data Type

This will be the data type for the defined field when the Field Expression is a formula and not a direct reference to a data field.

Field Name

This is the name of the variable as it will appear to the end user in the report.

Note: In order to improve the performance of the reports, fields are limited to 150. Reports with greater than 150 fields will be required to be modified prior to their execution.

Aggregator

Function

This defines the intended function of a report. Here is where you specify the function name when a function needs to be applied to this field; i.e., COUNT, MAX, MEAN, MEDIAN, MIN, STDDEV, SUM, and VARIANCE.

Iteration

This allows for a choice of how aggregation should occur. This is where to define the iteration to which the Function should be applied – report or site.

Label

The variable name applied to this column or field (equivalent to the “AS” in SQL).

Condition

An optional filter to be applied to the results used in the calculation.

Sort

Order

This defines how data is sorted within a column; i.e., Ascending or Descending.

Sequence

This is an integer that optionally defines the order in which the columns should be sorted. The field with a value of “1″ will be sorted first; “2″ will be sorted second; etc.

Writer

Class Name

This defines the writer to be used for various export files; i.e., Text, Excel, SAS, PDF, etc. The writer class names entered in the Reports tab as follows:

• Browser Report: com.clickfind.dataCollector.report.writer.SimpleReportWriter
• Excel Report: com.clickfind.dataCollector.report.writer.ExcelReportWriter
• SAS Report: com.clickfind.dataCollector.report.writer.SasReportWriter
• Text Report: com.clickfind.dataCollector.report.writer.TextReportWriter

Writer Param

Param Name

This is where to enter the name of the appropriate parameter for the selected Output Type.

Param Value

This is where to enter the value for the named parameter.

Report Parameter

Parameter Name

Enter the variable name that represents the parameter.

Text

Enter the text that the user will see in the interface when providing a value for this parameter.

Display Type

This determines how parameters are displayed to the user – how data should appear on the screen – when the report is run; i.e., Text (a one-line text area), Select, Radio.

Default Value

This is where you may optionally enter a default value to assist the user in running the report.

Parameter Choice

Data Value

Format in which data is stored in the system.

Display Value

Format in which options are displayed.

Filter

Filter Expression

This is where to enter the expression for the filter output.

Need more help?

Please visit the Fountayn Contact Information page.