Content

Overview Description Configuration Properties

 

Overview	Top

The "SDI Viewer" Control inserts a subset of an SDI List page into an ELN/LES Worksheet. This Control provides OOB Global Control Templates that support Samples, Batches, Instruments, Products, QC Batch Params, QC Batch Instruments, QC Batch Consumables, QC Batch Sample Types, and Workorders (depending on the configuration properties).

 

Description	Top

The OOB Configuration provides Global Templates for viewing several SDCs. The example below shows an SDI Viewer Control from the "Sample Viewer" Global Template (because the SDIs to be listed are Samples). Typically, the Worksheet Template can be setup as shown in the example below.

Samples will be added by the User in the Worksheet that is created from this Template.

In the Worksheet created from the Template, SDIs in the Worksheet can be dragged and dropped into the SDI Viewer Control. In this example, we drag and drop each Sample into the Control. Note that at this time, the Control toolbar contains only a "Login" operation. This launches the LoginSample Workflow Task Definition.

After dropping all Samples into the SDI Viewer, note that the "LIMS Data" panel shows the Samples grouped by Control. The LIMS Data panel is covered in ELN Worksheet Manager. The Control toolbar contains an "Add" operation. Clicking "Add" lets you add Samples using a Sample Lookup page.

 

Configuration Properties	Top

These properties are available for configuring overall behavior.

Property	Description
Name	Name of the Control that is displayed in the ELN interface. Leaving this blank defaults to the Control name provided in the OOB configuration.
Layout Style	Determines how SDIs are rendered. Option Description Form Renders SDIs in an HTML form. If there are multiple SDIs, the form is repeated. Table Renders SDIs in an HTML table. Adaptive If there is only one SDI, it is rendered in an HTML form; otherwise, it is rendered in an HTML table.
Data Source	Determines the source of the SDIs associated with the Control. Option Description Worksheet SDIs are retrieved from the WorksheetSDI table, which persists SDIs associated with the Worksheet. Control SDIs are retrieved from the WorksheetItemSDI table, which persists SDIs associated with the Control. Query SDIs are retrieved by a Query defined in the Control. This displays the "Query" property.
Data Source SDC	SDC for the SDIs that are in the Control or Worksheet.
Query	These properties are available if the "Data Source" is "Query". Property Description Query Query SDI. Query Parameters Parameters to use in the Query SDI. Query From Query Where If you are doing a generic SQL query rather than defining a Query SDI, these define the From and Where Clauses.
Form Columns	If rendered as an HTML form (as determined by the "Layout Style" property above), this is the number of SDC columns displayed across each row of the form.
Columns	Defines columns rendered for the SDI List. Option Filters by: Title Title rendered on the column header. Column Column Id to be retrieved for the selected SDC. Tip Text displayed on the tooltip. Col Span Number of columns to span (similar to HTML colspan tag). Show Determines if the column is rendered. 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). Date Format Format in which date/time is displayed, as determined by the user's Locale and the Date Format Policy. For information about how LabVantage handles Locale, see Internationalization and Localization → Locale and Time Zone and Date Format Policy. Translate Value Determines if the retrieved value is translated (see Translations). Link to Operation Allows a primary column to be "linked" to an operation. The dropdown list is populated with the defined Operations (below). When a link to an operation is defined here, linked column values render with a hyperlink. Clicking the hyperlink executes the operation for that single SDI. NOTE:   If Filter properties have been applied to an operation, any rows that do not match the filter criteria will render without the hyperlink. For example, you may choose to only render hyperlinks for those SDIs whose status is InProgress. See Operations → Filter Items for more information about the Filter Items property.
Hide Empty Columns	Determines if empty columns (all null) are hidden.
Group Column Values	If rendered as an HTML table (as determined by the "Layout Style" property above), this creates a group separate from the table to contain values shared by all SDIs.
No Data Available Message	Specify text to show when there are no SDIs to display.
Sort By	Allows the SDIs in the Control to be sorted by a column value. If no property collection is specified here, the default is to use the key column(s) of the SDIs. Property Description Column Column by which to sort. This column must be one of the columns that is being retrieved by the Control for display. It is not possible to sort by a column that is not being retrieved. Direction Determines if the column value is sorted in "Ascending" or "Descending" order.
Group by	Allows the SDIs in the Control to be grouped by one or more columns when rendered as a table. Property Description Column Column by which to group SDIs. This column must be present in the master column collection. An Alias can also be used for a column in the master column collection. Title Title for the group.
Operations	Defines operations available on the Control Toolbar. See Common Control Operations for details.
Includes	Allows complex/extended JavaScript to be added to an Operation of Type "Custom".