Relational Grid Widget

General Tab

The following table describes the fields on the General tab of the Property Editor for this widget.

Field	Description
Name	Type the name by which the widget is uniquely identified. No other widget or control on this form can have the same name.
Caption	Type the text to appear in the title bar above the widget. If you leave this field blank, the widget will not have a title bar.
Report	Displays the name of the configured report. If none has been configured, click Configure Report, and complete the dialog box that opens as described in Relational Grid Configuration Dialog Box. Click Clear to remove the configuration and start over.
Options	Border: Select this check box to draw a thin line around the widget. Scroll bars: Select this check box to include scroll bars in the widget. This provides more content than the allotted space. Check box selection: Select this option to place check boxes next to each row in the report. If the check box is cleared, users select multiple items by using the CTRL key. This option is only available for widgets based on Multi-Relational fields. Radio button selection: Select this option to use a radio button to make the selection. If this check box is cleared, users select the item by clicking on it (which is not as visually obvious as the radio button). This option is only available for widgets based on Single Relational fields. Title: Select this option to show the title ("Report for field relational field") in the relational grid header. Details: Select this option to show item count and applied filters in the relational grid header. Requery: Select this check box to show the Requery link in the relational grid footer. Select/Unselect all: Select this option to show the Select All and Unselect All links in the relational grid footer. This option is only available on transition or edit forms, and for widgets based on Multi-Relational fields. Clear: Select this option to show the Clear link in the relational grid footer. This option is only available on transition or edit forms. Show only selected item: Select yes to show only the items the user has currently selected in the relational grid or no to show all items. For transition forms, the additional option if read only limits the relational grid to show the selected read-only items as well as editable items. Display 'Show only selected items' checkbox: Select an option to show or hide the Show only selected items checkbox in the relational grid footer. For transition forms, the additional options if editable and if read only enable you to show the checkbox depending on if the items in the relational grid are editable or read only.
Description	Type an optional description of the widget.

Query Tab

Field	Description	Applicable To
Report Project	You can select one of the following options: Current project specifies the project into which the item was submitted. Base project specifies the header project at the top of the project hierarchy. Top level project specifies the project immediately below the base project in the hierarchy. Named project specifies any other project in the hierarchy. This should be the internal name of the project as shown in SBM Application Administrator.	SBM Composer report definitions based on a primary table
FIELD_NAME	Set values for the query-at-runtime parameters for the report. You can use static values or be bound to other field or control values. See Using the String Builder Tool for information about binding values. Important: When you bind certain types of fields, two binding values are presented: `fieldname` and `fieldname`[ID]. When you bind to a field that has been configured with the Query at Runtime search feature, you should use `fieldname`[ID] if it is available.	SBM Composer report definitions
Searchable	Enables users to filter the contents of the relational grid by entering a value for a specific field. To be searchable, the field must be defined as a column and as a query-at-runtime search filter in the report definition. The following fields and field types are searchable: Item Id, Text, Project, Company, User, Multi-User, Multi-Group, Single Selection, Multi-Selection, Folder, and Numeric (exact value, not "contains"). These field types are not searchable: Single Relational, Multi-Relational, and Sub-Relational.	SBM Composer report definitions

Field

Description

Applicable To

Report Project

You can select one of the following options:

Current project specifies the project into which the item was submitted.
Base project specifies the header project at the top of the project hierarchy.
Top level project specifies the project immediately below the base project in the hierarchy.
Named project specifies any other project in the hierarchy. This should be the internal name of the project as shown in SBM Application Administrator.

SBM Composer report definitions based on a primary table

FIELD_NAME

Set values for the query-at-runtime parameters for the report. You can use static values or be bound to other field or control values. See Using the String Builder Tool for information about binding values.

Important: When you bind certain types of fields, two binding values are presented: fieldname and fieldname[ID]. When you bind to a field that has been configured with the Query at Runtime search feature, you should use fieldname[ID] if it is available.

SBM Composer report definitions

Searchable

Enables users to filter the contents of the relational grid by entering a value for a specific field. To be searchable, the field must be defined as a column and as a query-at-runtime search filter in the report definition.

The following fields and field types are searchable: Item Id, Text, Project, Company, User, Multi-User, Multi-Group, Single Selection, Multi-Selection, Folder, and Numeric (exact value, not "contains").

These field types are not searchable: Single Relational, Multi-Relational, and Sub-Relational.

SBM Composer report definitions

Refresh Tab

See Widget Refresh Tab.