Displays a grid linked to a SQL table and the contents of the table are shown in the grid. Settings in the object determine whether the grid allows changes to the table data.
Formatting and Action
See Component Formatting and Action Properties.
SQL Table Editor
Database Location
Select a database location. You can choose from the following options:
-
Application: Select if the table to be displayed is located in the application database.
-
Framework: Select if the table to be displayed is located in the framework database.
-
External: Select if the table to be displayed is located in an external database.
External Database Connection
Connection information to enable connecting to an external database. This property is enabled if the Database location is set to External.
Table Name
The name of the table being displayed in the control.
Table Column Names
A comma-separated list of database table column names you can use in the SQL Select statement. Only the entered columns are displayed in the control. This property is optional.
NOTE: If editing existing data or adding new rows is enabled, any columns that exist in the underlying database table are excluded from the list. This property must have default constraints set in the database table.
Where Clause
The SQL string where clause used to pull data from the table.
Order By Clause
The SQL string to order the results of the table.
NOTE: The Order By Clause property does not allow SQL Functions like YEAR(effectiveDate). When run inside a dashboard, the Table Editor's columns allow clicks to change the order to ascending, descending, or no sort. SQL functions cannot be allowed in the ordering.
Filter Mode
The SQL Table Editor lets you filter results using Filter Mode. This filtering mode is built into the header cell of each filterable column. It is simpler to use than Popup mode (an alternative filtering mode) and uses only one field editor to filter. All filters start as empty until a value is entered into the editor.
Default for Columns Are Visible
When set to True, all columns are hidden unless overridden on an individual column.
Show Title Header
This property enables you to show or hide the entire bar including the items within the bar. If this property is set to False, the Show Title and Show Deselect All Button properties are disabled.
Default For Allow Column Updates
When set to True, the data in the existing table can be modified. When set to False, it cannot be modified.
Show Title
Show or Hide the text in the Title Header.
Show Column Settings Button
When set to True, this shows the Column Settings button which enables users to reorder and set visibility of columns. When set to False, the Column Settings button is hidden.
Show Deselect All Button
Shows or Hides Deselect All Button, which enables the user to deselect all selected rows.
Process Selection Changed For Inserts
When both this property and the Allow Inserts property are set to True, they enable the Insert button to process the selection changed event, which is often configured to refresh a portion of the dashboard. When set to False, it will not allow the Insert button to process the selection changed event.
Allow Inserts
When set to True, new rows of data can be added to existing data in the table. When set to False, new rows cannot be added.
Allow Deletes
When set to True, rows of data can be deleted from the existing data in the table. When set to False, rows cannot be deleted.
Retain Table Column Order
When set to True, the column order can be changed through the SQL Table Editor Column Format section. When set to False, the order cannot be changed.
Read Only Text Color
This field sets the default color to standard black text. The setting can be changed to any color including a system color, for example, XFReadOnlyText.
Column Name for Bound Parameter
Specify the name of the database column to use to change the value of the Bound Parameter when a database row is selected. This is used when a SQL Table Editor is being used to affect the display of other Dashboard Components, for example, when showing detailed information for the selected row.
Allow Multiselect
When set to True, the multiple selection of records is enabled by item selection or by using a selection checkbox. The active selected items are passed to the defined Bound Parameter field as a comma delimited list. The Bound Parameter format will be as: item1, Item2, Item3. If the 3 values A, B, C,D are selected (where C,D is one value) the resulting bound parameter string is A, B, "C,D". When set to False, only a single Bound Parameter can be passed at a time and the selection boxes are deactivated from the user interface.
Rows Per Page
Specify how many rows to display before a page break. This is a numeric value between 1 and 3000. By default, this property is set to -1, which turns off the property and uses the defined user preference property Grid Rows Per Page. Any value greater than 3000 results in a maximum value of 3000.
Save State
When set to True, user settings on the Component are retained. User preferences for Columns saved are for: Order, Visibility, Filtering, Freeze Bar, Sorting, and Widths.
NOTE: To reset Save State back to default, right-click on the Dashboard to enable the Reset State to return back to its Component Properties settings.
Vary Save State By
Use this property to apply Vary Save State By to workflow profile settings and scenario. The current Save State elements will have the control state tied to the current Workflow Profile and Workflow Scenario settings. If you select False or Use Default, Vary Save State By will not apply. When Vary Save State By is enabled, the related Dashboard Component has the additional reset option of Reset All States, which can be used to clear the user's Save States across all the Vary Save State By parameters.
Show Data Manipulation Buttons
Use this property to hide or show the following buttons: Insert Rows, Delete Rows, Cancel All Changes Since Last Save, and Save.
Show Add Row Button
Hide or show the Add Row Button.
Show Remove Row Button
Hide or show Remove Row Button.
Show Cancel Button
Hide or show the Cancel Button.
Show Save Button
Hide or show the Save Button.
Create Table If Necessary
The option to create the table if it does not already exist.
Table Creation Script
The SQL script to create the new table.
Save Data Server Task
You can choose from the following Server Task options:
-
No Task: There is not a performed task for a SQL table save data event.
-
Execute Dashboard Extender Business Rule: This will use a Dashboard Extender Business Rule to perform a save data event.
Save Data Server Task Arguments
Enter the arguments required by the server task. For example, {Business Rule Name}{Function Name}{Optional Name-Value Pairs}.
TIP: The data will wrap on string spacing. If there are no blank spaces, the column data will not wrap. Additionally, keyed fields cannot be wrapped.
DataFormatString
Specify a number/date format to the data in the column. For example, mm/dd/yyyy will return the current Month/Day/Year using a slash. MM-dd-yyyy will return the Month-Day-Year using a dash. N0 will return a number without a decimal point, and #,###,0 will return a number without a decimal and a comma depicting the thousandth place. See Application Properties for more examples of number formats.
Width
This specifies the default column width to be displayed.
