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. This Component is not compatible with Mobile Dashboards.
Action
See Button
SQL Table Editor
Database Location
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 is only needed if the Database location is set to External.
Table Name
The name of the table being displayed in the control.
Where Clause
The SQL string where clause used to pull data from the table.
Table Column Names
Optional. 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.
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.
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 can not 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
If set to True, all columns will be hidden unless overridden on an individual column. Settings are True or False.
Default for Allow Column Updates
If set to True, the data in the existing table can be modified, if set to False, it cannot be modified.
Show Title Header
Show or Hide entire bar including the items within the bar. If you set it to False, the Default For Allow Column Updates, Process Selection Changed For Inserts, Allow Inserts, and Allow Deletes remain enabled.
Show Title
Show or Hide the text in the Title Header.
Show Column Settings Button
Shows (if set to True) or Hides (if set to False) the Column Setting Button which allows user to reorder and set visibility of columns.
Show Deselect All Button
Shows or Hides Deselect All Button which allows the user to deselect all selected rows.
Process Selection Changed For Inserts
If set to True, (and the “Allow Inserts” property is also set to True), it will allow the Insert button to process the selection changed event which is often configured to refresh a portion of the Dashboard. If set to False, it will not allow the Insert button to process the selection changed event.
Allow Inserts
If set to True, new rows of data can be added to existing data in the table. If set to False, new rows cannot be added.
Allow Deletes
If set to True, rows of data can be deleted from the existing data in the table. If set to False, rows cannot be deleted.
Retain Table Column Order
If set to True, the column order can be changed via the SQL Table Editor Column Format section. If 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 (e.g., 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 (e.g., when showing detailed information for the selected row.)
Allow Multiselect
If set to True, the multiple selection of records will be enabled by item selection or using a selection check box. The active selected items will be 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". If set to False, only a single Bound Parameter can be passed at a time and the selection boxes will be 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 your defined user preference property Grid Rows Per Page. Any value greater than 3000 results in a maximum value of 3000.
Save State
If set to True, user settings on the Component are retained. User preferences for Columns saved will be for: Order, Visibility, Filtering, Freeze Bar, Sorting and Widths.
NOTE: 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
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 Falseor Use Default, Vary By Save State will not apply.
When Vary Save State By is enabled, the related Dashboard Component will have 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.
Display Format
Sets the SQL Table Editor formatting options such as row color. Set row BackgroundColor property to a color, and set AlternateRowBackgroundColor to a different color.
Data Manipulation Buttons
Show Data Manipulation Buttons
Hide or Show Insert Row(s), Delete Row(s), Cancel All Changes Since Last Save and Save. Settings are True or False.
Show Insert Row(s) Button
Hide or Show Add Row Button. Settings are True or False.
Show Delete Row(s) Button
Hide or Show Remove Row Button. Settings are True or False.
Show Cancel All Changes Since Last Save Button
Hide or Show Cancel Button. Settings are True or False.
Show Save Button
Hide or Show Save Button. Settings are True or False.
Server Task
Create Table if Necessary
The option to create the table if it does not already exist. Settings are True or False.
Table Creation Script
The SQL script to create the new table.
Save Data Server Task
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.
Dashboard Extender Business Rule Example (each enclosed in curly braces)
{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 in Application Tools for more examples of number formats.
Width
This specifies the default column width to be displayed.
