sdidetailmaint Element

 

Content

sdidetailmaint Element

Description

Example

Properties

Description

The sdidetailmaint Element adds and edits SDI details.

Example

See Sample Maintenance Page → Sample Details.

sdidetailmaint Element Properties

Property Name Description
Detail Type This determines the type of SDC detail maintained by this Element. The Detail Type is the same as the name of the table that handles the details, e.g., the SDIAddress table holds data used by the SDIAddress detail. The following details are available:

SDIAddress, SDIAlias, SDIApproval, SDIData, SDIDataItem, SDIDocument, SDIFormRule, SDISecurityDepartment, SDISecuritySet, SDISpec, SDIWorkflow, SDIWorkflowRule, SDIWorkItem, and SDIWorksheet Rule.

Mode Whether data are editable (Edit) or readonly (View).
Selector Type Whether checkboxes or radiobuttons are rendered to select detail items.
Appearance Appearance of the Element (defaults to Standard).
Tab Tab properties:
Property Name Description
ShowYes (default) displays the Element.
TextText displayed in the tab header.
WidthWidth of the tab in pixels (defaults to the size of the tab).
body WidthWidth of the content body (text area beneath the tab). The default is 100%.
body HeightFixed height of the content body. A scrollbar is added as required.
ExpandableYes (default) allows the tab to be expanded and collapsed. No disables this feature and the tab is always expanded.
ExpandedYes (default) initially expands the tab if Expandable property is set to Yes.
HighlightYes (default) highlights the tab on a mouseover event. The CSS defines this.
TipHelp text to appear on mouseover.
IdIdentifier of the Element (defaults to the Element name).
GroupDefines a tab group. See Tab Groups and Field Groups in the maint Element.
Button Placement Position of the button within the tab. If you leave this blank, buttons will not be displayed.
Buttons Button properties:
Property NameDescription
IdentifierUnique identifier for this item, rendered as an ID attribute in the HTML tag.
ShowYes (default) shows the button.
TextText displayed on the button.
WidthWidth of the button in pixels (defaults to the width of the text on the button).
FunctionJavaScript to execute for an onclick mouse event.
TipHelp text to display for an onmouseover button event.
ImageURL of the image displayed on the button.
AppearanceOptions to select the appearance of the button. If you leave this blank, it defaults to standard.
MarginMargin of the button in pixels.
styleChoose a style, or specify a CSS if you need to define button style using a stylesheet.
HighlightYes (default) highlights the button on mouseover. The CSS defines this.
Columns Column properties:
Property NameDescription
IdentifierUnique identifier for this item, rendered as an ID attribute in the HTML tag.
ColumnIdentifier of the column in the Primary SDC.
titletitle displayed as the column header. Clicking the header of a column selects all fields in that column.
WidthWidth of the column in pixels.
AlignAlignment of the column (the default is left).
ModeDisplay format of the column (defaults to readonly).
Validation Client-side validation rules for text entered into input fields:
ValueInput Required
Mandatory Any string. If you specify Date, Length, Number, Integer, or Decimal (below), the input must conform to those requirements.
Date A LabVantage-defined "date" data type.
LengthA LabVantage-defined "string" data type of specified length. Specify the length within a range. Range values are inclusive. For example, a range of 6 to 12 means that the string length must be 6, 12, or any integer between.
Number
Integer
Decimal
A LabVantage-defined "number" data type of the specified kind (number, integer, or decimal) and length. Specify the length within a range as you would when specifying a Length (above).
NOTE: The maint Element has built-in client-side validation. The following varchar fields are rejected:
Columns Containing
SDI KeyId
All Other
Columns
' (single quote); (semicolon)
" (double quote)
\ (backslash)
| (pipe)
; (semicolon)
[] (square brackets)
Link URL Specifies attributes of a hyperlinked column:
Property NameDescription
HRefURL specifying the destination of the hyperlink (page to open when clicked).
Target Name of the window in which the child page opens in response to an onclick (default is _self):
ValueOpens in...
_selfSame window
_parentCaller window
_blankNew window
_topBrowser window
TipHelp text displayed on mouseover.
PseudoThis is a "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, a Variable, or an Expression (see Variables). 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 Id 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.
Display ValueValues 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).
Link Reftype IDSpecify either a Reference Type identifier, or a semicolon-delimited list of Reference Values to display in as a dropdownlist or dropdowncombo.
Lookup URLURL of the page to open as a lookup. This works only if the Mode property of the column is "lookup".
Disable on SaveYes disables the column when the page initially loads. Any added row will have this column enabled for editing. By default, the column is editable.
Date FormatFormat 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.

Dropdown SQLSQL script that retrieves data when the column Mode property (above) is set to dropdownlist. If two columns are selected, the first column is used as the actual data, and the second column is used as the Display Value.

For example, if you setup a sampledesc column in dropdownlist mode, then specify the DropdownSQL script

select s_productid, productdesc from s_product

the maint Element should render a dropdown list of productdesc for the sampledesc field. If the query is

select s_productid from s_product

the Element should render a list of Product SDIs.

Translate Value"Yes" translates all values in the column (see Translating Properties in section 2 Properties Overview).
Default ValueValue displayed when a new row is added. The default column mode for this property is "input".
Dropdown DefinitionIf the Mode is dropdownlist, this retrieves data based on an SDC definition:
Property NameDescription
SDC IdThe SDC for which data is retrieved.
Query FromValue of the From clause for the query.
Query WhereValue of the Where clause for the query.
Query Order ByValue of the Order By clause for the query.
Value ColumnActual column value.
Display ColumnColumn value displayed to users.
Dynamic Lookup If the Mode is lookup, this defines a Dynamic Lookup:
Property NameDescription
EnableEnables Dynamic Lookup.
SDCSDC for the Dyanamic Lookup.
Query WhereQUery where clause for the Dynamic Lookup.
Columns Defines columns rendered in the Dynamic Lookup.
Property NameDescription
IdentifierUnique identifier for this item, rendered as an ID attribute in the HTML tag.
Column IdIdentifier of the column.
Display ValueColumn value displayed to users.
Pseudo ColumnSee Pseudo above for examples.
Map to ColumnIf you return more than one column, use this to specify the destination of the returned values.
WidthColumn width in pixels.
SearchableDetermines if the value in the Dynamic Lookup is searchable.
Allow Create New in Dynamic LookupDetermines if the field supports Quick Create SDI functionality.
Create New Options If "Allow Create New on Dynamic Lookup" is "Yes", this defines QuickCreateSDI page.
Property Name Description
Create New Texttitle displayed on the page header.
QuickCreateSDI Page QuickCreateSDI Page
TemplateOptional Template to use for the page.
Display Reference Type If the "Columns → Mode" is displayicon, this is the Reference Type that defines the icon displayed. "Display Reference Type" overrides the Display Value configuration. Display Value takes effect only if the icon is not found in the Reference Type.
Legend The Legend is displayed when you add a new item.
Property Name Description
Symbol for Added ItemsSymbols displayed when adding items (such as <sup>1</sup>).
Symbol for Apply WorkitemSymbols displayed when applying workitems. This works only when the Detail Type is SDIWorkItem.
Text on LegendText displayed in the Legend. For example, <sup>1</sup>New DataSet is displayed as 1New DataSet.
Page for Adding Detail Page to open when adding new detail items.
Page for Editing Detail Page to open when editing a selected Data Set. This is used only when the Detail Type is SDIData.
Restrictive Where This is an additional where clause that specifies additional search criteria for all queries executed from the Element.
JavaScript Includes JavaScript file to include in the Element. When specified here, the script does not have to be included in each Page that uses this Element.
Property Name Description
Javascript Source FileURL of the JavaScript (*.js) file to include in the Element.
Disable Record on Data Entry If the vlaue of the Detail Type property is SDIDataItem, this determines whether or not the record is disabled if Data Entry was conducted on the Data Item. The default value is Yes.
Save Spec Version as Current When set to "Yes", the Version of a Specification copied-down to a source SDI is set to Current (C) when the "Select Current" button is clicked while adding the Specification. The default is "No". In the OOB configuration, this is set to "Yes" for these pages:
LocationMaint ProductMaintP
LV_FormulationMaint SamplePointMaint
LV_FormulationStageMaint SDISpecMaintProduct
ProductMaint   
NOTE:In LabVantage versions prior to 8.2.0, the "Select Current" button was resolved into the actual "Current" Version of the selected Specification. This was less than desirable. If the Current Version of the Specification was changed at a later time, it was not applied to the Sample because the source SDI (such as Product or SamplePoint) did not have the capability of storing the "Current" Version. This feature enables creation of Samples while applying the Specification of the source SDI, which is "Current" at the time of Sample creation.
Enable Dynamic Audit Determines if "Dynamic Auditing" is enabled for the Page Type. See Dynamic Auditing for a complete description of this feature with examples.

Alternatively, this property can be left blank, in which case the "Enable Dynamic Audit" property setting in the maint Element or MaintenanceForm Page Type is used.

Auto Add New Row "Yes" automatically adds a new row when the page is opened and when the last row is modified.