clinicalevtsmptypdtl Element

 

Content

clinicalevtsmptypdtl Element

Description

Example

Properties

Description

The Clinical Event Sample Type Detail Element displays Protocol Event details, it also provides the ability to define additional columns.

Example

See BioBanking Protocol Studies → Events. Also see Event Plans for additional information regarding Events.

clinicalevtsmptypdtl Element Properties

Property Name Description
View Only Whether or not this page is editable or view only.
Tab Properties of the tab that contains the detail:
Property Name Description
ShowYes (default) displays theElement.
TextText displayed in the tab header. Optionally check the box to Translate.
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. Optionally check the box to Translate.
IdIdentifier of the Element (defaults to the Element name).
GroupTab Group in which this Element should be a member. Optionally check the box to Translate.
Specimen Type Columns Manage Specimen Types. Add the col

Property NameDescription
IdentifierUnique 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 working with a Project List page. 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 list 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.

titleText displayed on the column header of the SDI list.
WidthWidth of the column in pixels.
AlignHorizontal position within the SDI list column (left, center, or right).
ModeSpecifies how the input form control (generated HTML input tag) works. This tool automatically determines if you have chosen an appropriate mode to display the data (defined in the third column below). If not, it selects an appropriate mode. "Mode" supports Expression-Based Properties. Possible values:
ValueDescriptionDesigned for use with . . .
inputEquivalent to type=text attribute of HTML input tag. As an example, this lets you use the page to add SDIs.Inputs such as the "description" column of SDCs.
readonlyEquivalent to readonly attribute of HTML input tag.All data.
dropdownlist Equivalent to HTML select tag that inserts a select form control.

You can also use this property in conjunction with theproperty (below). This lets you retrieve data resulting from execution of a SQL script specified by the DropdownSQL property.

SDC data and Reference Type data.
lookupText field with capability to open "Lookup Page" and find a value of "string" data type.SDC data (such as finding SDI Ids or SDC links).
LookupversionedLookup for versioned items.Currently used in this Element for Label Methods.
checkboxEquivalent to type=checkbox attribute of HTML input tag.Reference Type data. This works the same as it does in HTML, i.e., you need two values. Therefore, use a Reference Type having two Reference Values. The first Reference Value you specify is the "checked" value, the second is the "unchecked".
datelookupDate field with capability to open a search window and find a value of "date" data type.LabVantage "date" data type.

Also see the Date Format property (below).

hiddenEquivalent to type=hidden attribute of HTML input tag.All data.
Version Column IDColumn Id for the Version.
ValidationClient-side validation rules for text entered into input fields. These default JavaScript functions are in WEB-CORE/elements/scripts/maint.js:
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).

If you want to define your own JavaScript validation function, specify it using the Customjs function (below).

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 If you are using this page as an SDI List Page and want items in the column to be hyperlinks, specify these values:
Property NameDescription
HRefDestination 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.
TipPopup text displayed on mouseover.
Translation ContextChoose a specific context in which to translate this column display.
PseudoA "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/2014 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 dispalyed as JD. This works only if you replace the entire retrieved string (it does not work on partial strings).
Link Reftype IDGive RefType id or ";" separated values of list to display in dropdown list or dropdown combo.
Lookup URLDefine the Lookup page. This works only if the Mode property of the column is "lookup".
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.

DropdownSQLSQL 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 to insert if no value found while inserting a new row.
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.
Translation Context, choose a specific context in which to translate this column display.
Readonly after saveMakes the fields read-only following a Save. 
Assay Type Columns Configure additional columns in order to capture additional data when defining a timepoint for a Protocol.
Property NameDescription
IdentifierUnique 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 working with a Project List page. 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 list 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.

titleText displayed on the column header of the SDI list.
WidthWidth of the column in pixels.
AlignHorizontal position within the SDI list column (left, center, or right).
ModeSpecifies how the input form control (generated HTML input tag) works. This tool automatically determines if you have chosen an appropriate mode to display the data (defined in the third column below). If not, it selects an appropriate mode. "Mode" supports Expression-Based Properties. Possible values:
ValueDescriptionDesigned for use with . . .
inputEquivalent to type=text attribute of HTML input tag. As an example, this lets you use the page to add SDIs.Inputs such as the "description" column of SDCs.
readonlyEquivalent to readonly attribute of HTML input tag.All data.
dropdownlist Equivalent to HTML select tag that inserts a select form control.

You can also use this property in conjunction with the Dropdown SQL property (below). This lets you retrieve data resulting from execution of a SQL script specified by the DropdownSQL property.

SDC data and Reference Type data.
lookupText field with capability to open "Lookup Page" and find a value of "string" data type.SDC data (such as finding SDI Ids or SDC links).
LookupversionedLookup for versioned items. 
checkboxEquivalent to type=checkbox attribute of HTML input tag.Reference Type data. This works the same as it does in HTML, i.e., you need two values. Therefore, use a Reference Type having two Reference Values. The first Reference Value you specify is the "checked" value, the second is the "unchecked".
datelookupDate field with capability to open a search window and find a value of "date" data type.LabVantage "date" data type.

Also see the Date Format property (below).

hiddenEquivalent to type=hidden attribute of HTML input tag.All data.
ValidationClient-side validation rules for text entered into input fields. These default JavaScript functions are in WEB-CORE/elements/scripts/maint.js:
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).

If you want to define your own JavaScript validation function, specify it using the Customjs function (below).

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 If you are using this page as an SDI List Page and want items in the column to be hyperlinks, specify these values:
Property NameDescription
HRefDestination 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.
TipPopup text displayed on mouseover.
Translation ContextChoose a specific context in which to translate this column display.
PseudoA "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/2014 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 dispalyed as JD. This works only if you replace the entire retrieved string (it does not work on partial strings).
Link Reftype IDGive RefType id or ";" separated values of list to display in dropdown list or dropdown combo.
Lookup URLDefine the Lookup page. This works only if the Mode property of the column is "lookup".
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.

DropdownSQLSQL 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 to insert if no value found while inserting a new row.
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.
Translation Context, choose a specific context in which to translate this column display.
Readonly after saveMakes the fields read-only following a Save.
Show Progress Dialog When Yes a progress dialog shows when you add, remove or move an item(s).