The listgizmo renders a column-formatted list of SDIs. In terms of property
definitions, this looks the same as any page with a List Element. The only additional
property is "SQL", which lets you query non-SDC tables and perform complex statements.
| Property Name |
Description |
| Gizmo Properties |
Defines high-level characteristics of the gizmo:
| Property Name | Description | | title | title of the gizmo. | | Help Text | Tooltip displayed onMouseOver. | | Tab Id | If using tabs, specify an identifier for the tab. If not using tabs,
leave this blank. If you leave this blank and you are using tabs,
the gizmo will not be displayed. | | Show Gizmo | Yes/No shows/hides the gizmo. | | Width | Width of the gizmo in pixels. | | Height | Height of the gizmo in pixels. | | Enable Resize | Yes/No allows/prevents resizing of the gizmo. | | Refresh on Timer Every (secs) | Time (in seconds) between window refreshes. | | Options | Details concerning properties that appear on options dialogs:
| Property Name | Description | | Property Id | Identifier of the property that appears on an options dialog.
If this is in a collection or property list, include the full
path using the dot character (.) as a separator. | | Editable | No disables editing of the property, but it will still be
visible. |
|
|
| SDC |
Identifier of the primary SDC, i.e., the SDC for SDIs listed by this Element. |
SQL
|
Deprecated. The SDI Processor is used to retrieve Data. The SQL properties
remain for backward compatability.
If you choose not to retrieve the SDIs by specifying a primary SDC and
Query SDI, use this to specify a SQL statement that retrieves the SDIs. |
Selector Type
|
Deprecated. The SDI Processor is used to retrieve Data. The SQL Properties
remain for backward compatability.
HTML input attribute used for selecting SDIs in the list: | Value | Description | | checkbox | Equivalent to type=checkbox attribute of HTML input tag (allows
selection of multiple SDIs). | | radiobutton | Equivalent to type=radio attribute of HTML input tag (permits selection
of only one SDI). |
|
| Initial Select All |
If the Selector Type (above) is a checkbox, Yes selects all SDIs when
the page loads. |
| Initial Expand All |
If you set the Group By property (below), Yes opens the page with each
SDI grouped by the column you have selected using the Group By property. |
| Initial Grouped |
Determines if items are grouped in the initial state. |
| Max
Rows/Page |
Deprecated. If you want the retrieved SDIs to be distributed over multiple
pages with each page displaying a specified number of SDIs, enter the number
of SDIs to be displayed in each page. For example, enter 60 if you want
each page to display no more than 60 Samples. If your query retrieves 180
Samples, 60 Samples will be displayed on each of 3 pages. A page index follows
each list, e.g.,
1 23 Next If you want all SDIs displayed on a single page, leave this blank. |
| Max Rows/Retrieve |
Maximum number of rows (records) that will be retrieved. If the maximum
is exceeded, the count of qualified rows is displayed.
| NOTE: | This is an Element-level setting. You can also set a Global value
for the maximum number of rows that will be retrieved. See the RSet
and SQL Control options. |
|
| Query |
Query to execute when the page loads. This can be either a Query SDI
or a SQL statement. In order to provide Full SDI level Security and consider
the ActiveFlag, queries go through the SDI Processor to retrieve data.
Properties for specifying a Query SDI: | Property Name | Description | | Query | Query SDIs relevant to the SDC this page will list. For example,
if this page lists Samples, only Query SDIs retrieving column values
from the Sample table will be displayed.
Note: If Query ID is not provided use the Query From and Where
Clauses. | | Params | Parameters (if any) defined by the Query SDI. Only applicable with
with Query ID property, this are the parameters for the Query.
| Property Id | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute
in the HTML tag. | | Value | Value of the parameter. |
| | From Clause | Optional FROM Clause if no query is specified. | | Where Clause | Optional WHERE Clause if no query is specified. | | Restrictive Where | Optional additional Restrictive Where Clause which can be merged
with the query. Can use [] parameters.
For example, on the list gizmo you can enter a normal restrictive
where such as "samplestatus = 'Initial'" or combine it
with a parameter defined on the parameter
gizmo "samplestatus = '[samplestatus]'". |
|
| Columns |
Behavior and appearance of columns in the list:
| Property Name | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute in
the HTML tag. | | Column | Identifier of the SDI column containing values displayed in the
list.
| NOTE: | About foreign key links between SDCs:
Assume you are listing Projects. The Project SDC (s_project
table) has a "managerid" column that is linked by foreign
key to the User SDC (sysuser table). The description of each
user (in sysuser.sysuserdesc) contains the user's full name.
If you want to display the full name for the manager associated
with a project, you would setup one column (on the List page)
to retrieve managerid.sysuserdesc. The listgizmo Element permits
this single foreign key link between SDCs. However, trouble brews if the Project SDC has two foreign
key links to the User SDC. Suppose you add another column
(u_directorid) to the Project SDC and link it to the User
SDC as well. In this case, the same sysuserdesc would be retrieved
for both managerid.sysuserdesc and u_directorid.sysuserdesc. |
| | title | Text displayed on the column header of the SDI list. | | Mode | Display attributes of retrieved values in the column:
| Mode | Description | | Display Text | Shows retrieved values. | | Hidden Value | Hides retrieved values. |
| | Width | Width of the column in pixels. | | Alignment | Horizontal position within the SDI list column (left, middle, or
right). | | Return Value | A value of Yes returns the key value of the selected column. For
example, when you choose a Sample, this would return the keyid1 (sampleid). | | Link | If you want items in the column to be hyperlinks, specify these
values:
| Property Name | Description | | HRef | Destination of the link, specified as a call to the Request
Controller. For syntax rules and guidelines, see Request
Controller and Variables. | | Target | Name of the window in which the linked page opens. You can
enter any name here, and the new window (browser instance) will
automatically assume that name. If you do not specify a target,
the linked page opens in the current window. | | Tip | Popup text displayed on mouseover. |
| | Display Value | Values displayed in place of the corresponding retrieved values.
Separate each with a semicolon. For example, if you retrieve values
from the createby column, you could specify JDrake=JD. All values
retrieved as JDrake would then be dispalyed as JD. This works only
if you replace the entire retrieved string (it does not work on partial
strings). | | Pseudocolumn | A "pseudocolumn" is a column that is rendered on the page, but does
not exist in the SDC. Do not choose a database columnid when specifying
a pseudocolumn. If you want to access this pseudocolumn using a JavaScript
function or another pseudocolumn, specify an identifier of your own
choice.
This value you enter can be HTML or a Variable.
For example: | • | If you enter an HTML image tag, then specify a link (using
the Link URL property above), the image becomes a hyperlink. | | • | If you use a variable, the variable must point to one of the
columns defined by the Column
property. In this case, you can hide the actual column so that
only the pseudocolumn is displayed. For example, you could specify
Date: [moddt] to display the date and time a Sample was
last modified (such as Date: 8/1/2003 15:36:24), but
only if you have previously chosen moddt as one of the
columns to be rendered. |
| | Date Format | Format in which date/time
is displayed, as determined by the user's Locale. For information
about how LabVantage handles Locale, see
Locale and Time Zone in
the topic Internationalization and Localization.
The popup calendar and all date validation routines recognize and
function with the chosen format. If you choose a format that specifies only date (without time),
the time defaults to midnight in your time zone. Be advised that
this could be a day earlier for a user in a different time zone.
| | Translate Value | "Yes" translates all values in the column (see Translating
Properties in section 2 (Properties Overview). |
|
| Sort By |
Specifies how columns are sorted:
| Property Name | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute in
the HTML tag. | | Column | Identifier of the SDI column by which to sort all other columns. | | Direction | Specify "a" to sort the column in ascending order, or "d" to sort
in descending order. If you do not choose a direction, this sorts
in ascending order. | | Dynamic | Yes sorts all columns when the current column is clicked, then
refreshes the list to show the new sort order. |
|
| Group By |
Groups by the SDI column you select, creating expandable-collapsible
lists to group the SDIs by this column.
This works for any column, even linked columns. If there is an SDC (foreign
key) link from a column of one or more SDIs in the list to the primary
key of another SDC, this property creates expandable-collapsible lists
to group SDIs by the SDC to which they are linked. For example, if this
is a Sample list, and the "batch" column of the Sample SDC is linked by
foreign key to the Batch SDC, each expandable-collapsible list represents
a Batch, with items below this list being the Samples linked to the Batch.
| Property Name | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute in
the HTML tag. | | Column | Identifier of the column by which you want to group the SDIs. For
foreign keys, this is the SDC column that is linked by foreign key
to another SDC. | | title | Text that precedes the identifier of a group in each collapsible-expandable
list. For example, assume each collapsible-expandable list represents
a Batch with items below it being Samples with columns linked to the
Batch SDC. Each Batch SDIId is the number of the Batch (such as B001).
If you enter a title of "Batch", the collapsible-expandable list of
Samples for B001 would be labeled "Batch B001". | | Display Value | See the description of Display
Value for the Columns Property. | | Link | Hyperlink for items in the column. For syntax rules and guidelines,
see Request Controller and Variables. | | Translate Value | "Yes" translates all values in the column (see Translating
Properties in section 2 (Properties Overview). | | Addtional Columns | Lets you display additonal columns.
| Property Name | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute
in the HTML tag. | | Column | Identifier of the column you want to display. | | title | Text that identifies each column in the header. | | Display Value | Values displayed in place of the corresponding retrieved values.
Separate each with a semicolon. For example, if you retrieve
values from the createby column, you could specify JDrake=JD.
All values retrieved as JDrake would then be displayed as JD.
This works only if you replace the entire retrieved string (it
does not work on partial strings). | | Translate Value | "Yes" translates all values in the column (see Translating
Properties in section 2 (Properties
Overview). |
|
|
| Texts |
Substitues your text in place of the default text rendered on the page:| Property Name | Description | | page | Text generated by the Max
Rows/Page property. | | Prev | | Next | | of | | No Rows Found | String returned when the Element has not found any data to retrieve. | | Group By | If you want to replace the default text at the left,
specify the new text here. | | Select All | | Deselect All | | Collapse All | | Expand All |
|
| List Page |
List page to open from this Gizmo. |
| Selection |
Used only with the "Classic" Dashboard. This allows listgizmos
to drive other Gizmos on the Dashboard. When an item is selected, the specified
Parameter will be inserted and the registered Gizmos will load again with
that Parameter.Currently for development use only.
| Property Name | Description | | Parameter Id | Parameter to be inserted. | | Refresh Gizmos | Gizmos to be refreshed. |
|
| List Mode |
Used with the Map Interface, this
property can be used if the SDC for the list "Allows Coordinates",
or the list contains the coordinate columns defined in the columns collection
(latitude, longitude, and projection). This determines how the list is rendered:
List or Map. If set to "Map", use the "Map Configuration"
property (below) to define the map properties. |
| Map Configuration |
Defines Map properties when "List Mode" (above) is set to "Map".
| Property Name | Description | | Pin styles | Pin styles to use when marking coordinate locations.
| Property Name | Description | | style Id | Pin style to use when displaying the map. Pin styles are configured
in the Map Policy. | | Active | Determines if this pin style is active. |
| | Fetch Extra Columns from Group Id | Extra column(s) to be represented in map pin tooltip or by a pin
style. Extra columns are configured in the Map
Policy. |
|
