Adding and Editing Report Items

Specialized Administration > Analyzing System and Business Information > Reports and Queries > Query Builder > Select or Constrain (Query Builder) > Adding and Editing Report Items

The following properties appear on the Add and Edit windows for report items on the Select or Constrain and Criteria tabs. The particular properties displayed depend on the report item. These property settings determine the initial display of the item in Report Builder, and its behavior.

Property

Report Item

Description

Table Alias

Column

Object

(Read-only) The alias of the table from which the report item was selected, as specified on the Tables and Joins tab, followed by the internal type name of the table in brackets. For example: Report Template [wt.query.template.ReportTemplate]. This property is read-only.

Property Name

Column

Object

(Read-only) The property name of the report item, followed by the internal name of the report item in brackets. For example: Name [name].

Data Type

Column

Keyword

Database Function

(Read-only) The data type of the report item. The data type of the report item determines the properties that can be set for the item.

For keyword report items, Data Type displays only if the keyword is Row Number.

For database function report items, the data type displayed updates based on the Function selected.

Data Type

Constant

Parameter

Select the data type of the constant from the drop-down list:

• String (java.lang.String)

• Date (java.sql.Timestamp)

• Number (java.math.BigDecimal)

• Boolean (java.lang.Boolean)

The data type displayed above the drop-down list corresponds with the selected value.

Display Name

Column

Object

Keyword

Constant

Parameter

Database Function

Java Method

Parameter

The display name of the item. This editable value is displayed as the label for the item in the Report Builder criteria pane, and as the column heading in the report results table, if the item is included in the report results.

Display Name appears only on Add and Edit windows launched from the Select or Constrain tab, or when launched from the Add Parameter Value to Select or Constrain action on the Criteria tab.

Operator

Column

Keyword

Database Function

Select an operator for the report item. The available operators are based on the data type of the report item. For a list of all available operators, see Operators (Select or Constrain). The operator selected here is the default operator displayed for the report item in the Report Builder.

For keyword report items, this property displays only if the keyword selected is Row Number. For reportable items that are attributes on report template views, this property only displays if the attribute is not a derived attribute.

Value

Column

Keyword

Constant

Parameter

Database Function

(String, number, enumeration, or boolean data types) Define the value for the report item. The input box for the Value property is determined by the data type of the report item, and the options selected for this property.

• Default value—The specified value is automatically populated for the report item in the Report Builder. The user can edit the value when running the report.

• Constant value—The specified value is a constant value, and cannot be edited by the user running the report.

• Use a macro—When this checkbox is selected, the value input field becomes a drop-down list. Select the desire macro from the list. This checkbox displays only if a macro is available for the data type of the report item. For more information, see Macros.

• Enter or select the value:

◦ For number and string data types, enter the value in the input field. If Use a macro is selected, select a macro from the drop-down list.

◦ For enumeration data types, select the value from the enumerated list.

◦ For boolean data types, select value from the boolean list.

• Preserve Spaces—For constant report items with a string data type, select this checkbox to preserve any spaces entered in the value input field.

For reportable items that are attributes on report template views, this property only displays if the attribute is not a derived attribute.

Start Date

End Date

Column

Database Function (if the selected function is System Date or To Date)

(Date data type items) Specify the date range appropriate for the report item, based on the Operator selected. For example, for a between operator, specify both the Start Date and End Date. For a < operator, specify the End Date. Only the properties applicable for the selected operator are enabled.

Select whether the value is a Default value or a Constant value, and click the calendar icon

to select the date. If the Add Time to Date Fields property is selected for this report template, a time entry component appears next to the date component.

If Use a macro is selected, the value entry field is replaced with a drop-down list of available macros for the data type.

Date

Constant

Parameter

(Date data type items) Click the calendar icon

to select the date for the constant.

If Use a macro is selected, the value entry field is replaced with a drop-down list of available macros for the data type of the report item.

If the Add Time to Date Fields property is selected for this report template, a time entry component appears next to the date component.

Keyword

Select the keyword from the drop-down list. For more information, see Keywords.

Database Function

Select the function from the drop-down list. For more information, see Database Functions. The Data Type property updates based on the function selected.

Java Class

Java Method

Select a Java class from the drop-down list. For information on specifying the list of available Java classes and methods, see Java Methods.

Java Method

Select a Java method from the drop-down list. The Java Method drop-down list is based on the value selected for Java Class.

The Report Builder Options section appears only on Add and Edit windows launched from the Select or Constrain tab. These properties determine how the item appears and behaves in the Report Builder:

Property	Description
Criteria	(Column, keyword, and database function) Determines whether criteria for the item can be added or changed by users in the Report Builder criteria pane: • Allow user to specify criteria—Selecting this checkbox allows users to specify criteria for this item in the Report Builder. For keyword report items, this checkbox appears only if the keyword selected is Row Number. For reportable items that are attributes on report template views, or database functions, this property only displays if the attribute is not a derived attribute. • Show available subtypes for selection—Select this checkbox to display a drop-down list containing subtypes of a parent type on the Report Builder, to let users filter report results to specific subtypes. This checkbox only displays for column report items if the attribute is a type branch identifier (the Property Name or Value for the report item contains the string typeDefinitionReference.key.branchId). If this checkbox is selected and Allow user to specify criteria is not selected, a warning displays. No subtype drop-down list displays if the user cannot select from it.
Results	(Column, constant, keyword, Java method, and database function) Determines whether and how this item is included in the report results. • Allow user to decide—Allows the user to decide whether the item is included in the report results. A checkbox displays in the Report Builder next to the item. The user can select the checkbox to include the item in the results, or clear the checkbox to exclude the item from the results. • Always include—This item is always included in the report results. The user cannot change this when running the report. • Never include—This report item is used only to constrain the report results, but is never included in the report results themselves. Only available for column and keyword report items. For reportable items that are attributes on report template views, Never include only displays if the attribute is not a derived attribute. • Show information page link in results table—Select this checkbox to include links to object information pages in the report results. The information page link is displayed as an information icon . This checkbox only displays if the report item is a branch identifier, object identifier, or e-mail address (the Property Name for the report item contains one of the following strings: branchid, objectid, email). If this checkbox is selected and Never include is selected, a warning displays. An information page link cannot display in the results if the report item is not included in the results.

Property

Description

Criteria

(Column, keyword, and database function) Determines whether criteria for the item can be added or changed by users in the Report Builder criteria pane:

• Allow user to specify criteria—Selecting this checkbox allows users to specify criteria for this item in the Report Builder.

For keyword report items, this checkbox appears only if the keyword selected is Row Number. For reportable items that are attributes on report template views, or database functions, this property only displays if the attribute is not a derived attribute.

• Show available subtypes for selection—Select this checkbox to display a drop-down list containing subtypes of a parent type on the Report Builder, to let users filter report results to specific subtypes. This checkbox only displays for column report items if the attribute is a type branch identifier (the Property Name or Value for the report item contains the string typeDefinitionReference.key.branchId).

If this checkbox is selected and Allow user to specify criteria is not selected, a warning displays. No subtype drop-down list displays if the user cannot select from it.

Results

(Column, constant, keyword, Java method, and database function) Determines whether and how this item is included in the report results.

• Allow user to decide—Allows the user to decide whether the item is included in the report results. A checkbox displays in the Report Builder next to the item. The user can select the checkbox to include the item in the results, or clear the checkbox to exclude the item from the results.

• Always include—This item is always included in the report results. The user cannot change this when running the report.

• Never include—This report item is used only to constrain the report results, but is never included in the report results themselves. Only available for column and keyword report items.

For reportable items that are attributes on report template views, Never include only displays if the attribute is not a derived attribute.

• Show information page link in results table—Select this checkbox to include links to object information pages in the report results. The information page link is displayed as an information icon

. This checkbox only displays if the report item is a branch identifier, object identifier, or e-mail address (the Property Name for the report item contains one of the following strings: branchid, objectid, email).

If this checkbox is selected and Never include is selected, a warning displays. An information page link cannot display in the results if the report item is not included in the results.

Was this helpful?