The planitemmanager Element renders Plan Item details for the Scheduler.
For definitions of terminology used in this Element, see these topics:
planitemmanager
Element Properties
|
| Property Name |
Description |
Schedule Plan SDC Id
|
SDC used in the Schedule Plan. |
| Schedule Plan Item |
Defines the Schedule Plan Items.
| Property Name | Description | | Filter | Defines how Schedule Plan Items are related to the page that hosts
this Element.
| Option | Use When: | | Plan | Adding this Element to a page in which the primary SDC is
Schedule Plan. | | Node | Adding this Element to a page in which the primary SDC acts
as a parent of the Source SDC (such as the Location SDC is a
parent of the SamplePoint SDC). | | Source | Adding this Element to a page that acts as a source for Schedule
Plan Items (such as SamplePoint or Instrument). | | Scheduled Template | Adding this Element to a page that acts as a template for
a Schedule Task (such as the Sample SDC is usually a template
for Tasks that create Samples). | | Linked Scheduled Template | Adding this Element to a page that is linked to a Schedule
Plan Item through a template. For example, the Product SDC has
no relationship to a Schedule Plan Item, but it does have a
relationship to a Sample Template. In this case, this link can
be used to get Schedule Plan Items that are related to the Product. | | SQL | None of the above options can link Schedule Plan Items to
your page. This is a SQL query that supports the tokens [sdcid],
[keyid1], [keyid2], and [keyid3]. |
| | Linked Schedule Template | If "Linked Scheduled Template" is selected as "Filter"
option (above), these properties define details of the relationship
between the primary SDC and template SDC (such as the relationship
between Product and Sample SDCs).
| Property Name | Description | | SDC | Primary SDC that is defined by the Schedule Template. | | Linked Schedule Template | Rules that determine how the primary SDC (above) is linked
to the defined SDC by the foreign key columns specified below.
| Property Name | Description | | Column | Column of defined SDC. | | Value | Column value. This supports static values and the tokens
[sdcid], [keyid1], [keyid2], [keyid3]. |
|
| | SQL | If "SQL" is selected as "Filter" option (above),
this property further defines the query used to retrieve the Schedule
Plan Items.
| Property Name | Description | | Query Where | Where clause for the query. This supports the tokens [sdcid],
[keyid1], [keyid2], and [keyid3]. |
| | Node | The "Node" is a parent of the Source SDC (such as Location
is parent of SamplePoint). This option can be used to show only parents
(such as Location) that directly own Schedule Plan Items.
| Property Name | Description | | Show Own | "Yes" shows only parents that directly own Schedule
Plan Items (such as Location). "No" shows both own
and child SDC (such as both Location and SamplePoint) Schedule
Plan Items. |
| | Source | If "Source" is selected as "Filter" option
(above), this option can be used to hide or show randomized Schedule
Plan Items.
| Property Name | Description | | Show Randomized | The choices are "Yes", "No", or "Only
Randomized". |
|
|
| View Only |
Determines if the Element is rendered in read-only mode. |
| Tab |
Properties of the tab that contains the detail:
| Property Name | Description | | Show | Yes (default) displays the Element. | | Text | Text displayed in the tab header. Optionally Translatable. | | Width | Width of the tab in pixels (defaults to the size of the tab). | | body Width | Width of the content body (text area beneath the tab). | | body Height | Fixed height of the content body. A scrollbar is added as required. | | Expandable | Yes (default) allows the tab to be expanded and collapsed. No disables
this feature and the tab is always expanded. | | Expanded | Yes (default) initially expands the tab if Expandable property is
set to Yes. | | Highlight | Yes (default) highlights the tab on a mouseover event. The CSS defines
this. | | Tip | Help text to appear on mouseover. Optionally check the box to Translate. | | Id | Identifier of the Element (defaults to the Element name). | | Function | JavaScript function to execute onClick. | | Group | Tab Group in which this Element should be a member. Optionally Translatable. |
|
| Foreign Key Collection |
Foreign Key collection properties:
| Property Name | Description | Identifier | Unique Identifier for this item. | Column Name | Column Name | Mapping Column Name | The mapped Column name in the primary. This will be searched in
both request and primary. |
|
| style |
Rendering style. Grid displays only a tabular grid. GridWithCheckBox adds
selection capability through the use of checkboxes. |
| Button Placement |
The position of the Button Panel. Choose Top or Bottom. |
| Buttons |
Button Property details.
| Property Name | Description | | Identifier | Identifies the Button. | | Show | Yes (default) displays the button. | | Text | Button text. Optionally check the box to Translate. | | Width | Width of the button in pixels. | | Function | JavaScript function to execute in response to an onClick event.
If you want to use your own custom functions, they must be in the
file specified by the include property in the page. | | Tip | Tooltip displayed onMouseOver. | | Image | Image displayed in the button. | | Appearance | Offers a choice of the button's overall appearance:
| Function | Description | | standard | Default button. | | standard_highlight | Default button with highlighting on mouseover. | | blue | Default button with blue background. | | blue_highlight | Default button with blue background and highlighting on mouseover. |
| | Margin | In the CSS, class name that defines the button borders. | | style | Additional attributes you have defined in the CSS used to render
the page. This is the "style" attribute of the button tag <sapphire:button>.
For guidelines concerning use, see button
tag in the LabVantage Custom Tag Reference. | | Highlight | A value of "true" (default) enables button highlighting (color change
in response to mouseover). A value of "false" does not provide highlighting.
This is the "highlight" attribute of the button tag <sapphire:button>.
For guidelines concerning use, see button
tag in the LabVantage Custom Tag Reference. |
|
Plan Item Data Classification
|
Determines whether to show definitional Plan Item columns or all Plan
Item columns. |
| Schedule Plan Column Properties |
Customize the colors used to display each node.
| Property Name | Description | Display Type | Choose lookup, hidden or dropdown. | Dropdown SQL | The dropdown planids to be shown if the Display Type is dropdown. | Lookup URL | The URL to display upon Lookup. | Default Plan | The Default Plan to use if nothing is selected. |
|
| Columns |
Defines primary columns on the Element:
| Property Name | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute in
the HTML tag. | | Column Id | Identifier of the SDI column to be displayed. | | title | Text displayed to identify the Column Id. | | Mode |
Specifies how the input form control (generated HTML input tag)
works.
| Value | Description | Designed for use with . . . | | input | Equivalent 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. | | readonly | Equivalent to readonly attribute of HTML input tag. | All data. | | hidden | Equivalent to type=hidden attribute of HTML input tag. | All data. | | lookup | Text 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). | | dropdowncombo | This is a dropdownlist (equivalent to HTML select tag that
inserts a select form control), but the field is an editable
"input" field. | Typically used for Reference Type 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. | | checkbox | Equivalent 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". | | radiobutton/vertical | Equivalent to type=radio attribute of HTML input tag. This
arranges the radios vertically within the column. | Reference Type data, generally best for choosing
from more than two values. | | radiobutton/horizontal | Equivalent to type=radio attribute of HTML input tag. This
arranges the radios horizontally within the column. | | datelookup | Date 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). | | password | Entry field that displays asterisks for each character you
enter. | Entering passwords. | | retrievedata | Retrieves the value in the column but does not render it on
the page. | Use this when you want to replace the value of another column's
property with the value of this column.
For example, if you setup a samplestatus column in retrievedata
mode, then setup a pseudocolumn with the value samplestatus:
[samplestatus], you will see the actual sample status (value
represented by the [samplestatus] variable) in the pseudocolumn.
Without using retrievedata mode, the [samplestatus] variable
would not be replaced with the actual column value. This differs from the hidden property
above... the hidden property renders the value on the page. | | inputarea | Equivalent to type=radio attribute of HTML input tag. | Use this for large text areas. | | default | Same as not choosing any of these Mode properties.
If you do not choose a Mode property (that is, leave it blank),
nodes that inherit this property will never actually be blank...
they will inherit the previous node's Mode. So, rather than
not choosing any Mode at all, choose "default". |
| | Validation | Client-side validation rules for text entered into input fields.
These options are similar to those used in the maint Element (see
maint Element →
Columns → Validation). | | Tip | Tooltip for the column value (supports value substitution). | | Custom JS | If you do not want to use the default validation scripts above,
specify your custom validation JavaScript function. If you want to
use your own custom functions, they must be in the file specified
by the include property in the page. | | Link URL | Specifies attributes of a hyperlinked title, activated by clicking
the text displayed by the title property:
| Property Name | Description | | HRef | Destination of the link, specified as a call to the Request
Controller. | | 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. |
| | CSS Class | Class in the CSS to apply. | | Lookup URL | Defines the Lookup page. This works only if the Mode
property of the column is "lookup".
See Lookup Page Examples for examples
of how to use these properties. | Property Name | Description | | HRef | URL to which the Lookup icon is linked. | | Tip | Help text displayed on mouseover. | | SDC Id | SDC to use for a custom Lookup page.
If you have specified a Lookup Page, this is ignored. If you have not specified a Lookup Page, the SDC is obtained
from the HRef attributes. | | Selector Type | Checkboxes or radio buttons.
You need an Accept button to return these. If you do not specify a value, the Lookup page uses either
the provided List page's set value, or the new List page's
defaults. Multiple items are returned semicolon-delimited. | | Restrictive Where | Optional restrictive where clause that either combines with
the provided List page's restrictive where clause, or is used
as the primary restrictive where clause on the default Lookup
page. | | Lookup Columns | Columns that are either merged with the List page specified
by the HRef property, or (if not specified by the HRef property)
used to define a new List page:
| Property Name | Description | | Identifier | If you are overriding/merging with an existing List
page, specify the same identifier as the column on the
List page. Otherwise, this creates a new column. | | Column Id | If merging with an existing List page, if no match can
be found for the identifier, this tries to match on a
column id. If a match is still not found, a new column
is created. | | title | title of the column. | | Mode | Specifies how the column is populated:
| Display Only | Show the value, but do not populate
the column. | | Return Only | Populate the column, but do not show the value. | | Display and Return | Show the value and populate the column. | | Hidden Only | Hidden fields. |
| | Display Value | Value displayed in place of the corresponding retrieved
value (see Display Value below
for example). | | Pseudo Column | See Pseudo Column below
for example. | | Map to Column | If you return more than one column, use this to specify
the destination of the returned values. | | Width | Column width in pixels. | | Searchable | Determines if the value in the Dynamic Lookup is searchable.
See Dynamic Lookups. |
| | Dialog Type | LabVantage modal dialog or the
browser's default dialog. | | Dynamic Lookup | Enables the field for Dynamic Lookup. See Dynamic
Lookups. |
| | 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). | | 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
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. |
| | Column Span | Number of columns over which the current column spans (must be less
than or equal to the total number of columns). | | Size in Grid | Size of the input field when using the Maint Grid format. | | Events | JavaScript function to execute in response to an event occurring
on the form control:
| Property Name | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute
in the HTML tag. | | Event | DHTML event that executes the JavaScript function. If you
specify an onChange event, see Behavior
of onChange Events in maint Elements below.
This also supports an OnKeyUp event. | | JavaScript | JavaScript function to execute in response to the event. Your
function can be in a *.js file referenced from the page, or
in the page itself. |
| | 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.
| | Dropdown SQL | SQL 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. | | Dropdown RefType | If the Column Mode property is dropdownlist, this is the identifier
of the Reference Type defining the selectable values. | | Dropdown Value | If the Column Mode property is dropdownlist or dropdowncombo, these
are the selectable values. | | Dropdown Definition | If the Mode is dropdownlist, this retrieves
data based on an SDC definition:
| Property Name | Description | | SDC Id | The SDC for which data is retrieved. | | Query From | Value of the From clause for the query. | | Query Where | Value of the Where clause for the query. | | Query Order By | Value of the Order By clause for the query. | | Value Column | Actual column value. | | Display Column | Column value displayed to users. |
| | Translate Value | See Translating Properties
in section 2 Properties Overview for details
regarding property translation. In general:
| • | "Yes" translates all values in the column regardless of context. | | • | "No" does not translate any values. | | • | "No (Allow Edit Translations)" adds an icon to to
the field which (onClick) opens a Translation Maintenance page.
This is supported only for column modes input, readonly, lookup,
dropdownlist, dropdowncombo, and radiobutton. |
| | Default Value | Default value to use when creating new SDIs.
If creating the new SDIs from an SDI Template, the Default Value
overrides the value in the Template. For columns accepting text input, you can specify variables such
as [currentuser] (the current user). For columns accepting the date,
you can specify relative date format such as [today] or (N+3),
the latter meaning "now plus 3 days". When the Element style is set to render as a Maint Grid, the Default
Values are applied to each SDI as you add rows to the grid. | | Disable on Save | Sets the field to read-only after a Save has occurred. | | Disable | Disables the field while preserving the original mode. | | Group | Column where you want to insert a tab or field break. These options
are similar to those used in the maint Element (see maint
Element → Columns → Group). |
|
| Schedule Task Properties |
Schedule Task Properties:
| Property Name | Description | Default Lookup Task | Task appearing the Lookup by default. | | Schedule Template SDCs |
Defines Schedule Templates.
| Property Name | Description | | SDC | SDC for the Schedule Template. | | Lookup Page | Defines a custom Lookup page to be used for the Schedule
Template.
| Property Name | Description | | HRef | Destination URL for the Lookup page. | | Tip | Tooltip displayed onMouseOver. | | SDC Id | Identifier of the SDC for the custom Lookup page. If
you have provided a lookup page above, this is ignored.
If not specified, the SDC is obtained from the link properties. | | Selector Type | Specify checkbox to show check boxes or radio bittons
to show radio buttons. You will require an accept button
to return these. If not specified, it will use either
the provided List page's set value, or the new List page's
defaults. Mutliple items are returned delimited by semicolon. | | Restrictive Where | If provided, this either combines with the provided
List page's restrictive where, or it will be used as the
primary restrictive where on the default Lookup page. | | Lookup Columns | If specified by the HRef property, these are merged
with that List page. If not, they are used to define a
new List page.
| Property Name | Description | | Identifier | If you are overriding/merging with an existing
List page, specify the same identifier as the column
on the List page; otherwise, a new column will be
created. | | Column Id | If merging with an existing List page and no match
on identifier can be found, it will try to match
on column. If no match is still found, a new column
will be created. | | title | title of the column. | | Mode | See Mode. | | Display Value | See Display Value. | | Pseudocolumn | See Pseudocolumn. | | Map to Column | If you are returning more than one column, you
can use this to specify where you want the values
to be returned. | | Width | Column width in pixels. | | Searchable | Determines if search capability is added to the
Lookup. |
| | Dialog Type | Browser Popup opens in a browser popup window. Sapphire
Dialog opens in a modal LabVantage dialog. | | Dynamic Lookup | Yes/No enables/disables Dynamic
Lookup. Yes(hide lookup icon) enables but hides the
icon. |
| | Add Page | Page used for adding new Schedule Templates. | | Edit Page | Page used for editing existing Schedule Templates. | | Max Copies | Maximum number of Schedule Template copies. If set to 1, the
"Copies" dropdown is hidden. |
| | Source SDCs |
Defines the Source SDCs.
| Property Name | Description | | SDC | SDC for the Source SDC. | | Allow Node Source | This can be the Source of the Plan Node (applies only to UnManaged
Schedule Plans). | | Schedule Tasks |
Defines the Schedule Tasks executed.
| Property Name | Description | | title | title displayed for the Task. | | Visible | Determines whether to show or hide the Task. | | Schedule Task | Property Tree for the Schedule Task. | | Schedule Task Node | Property Tree Node for the Schedule Task. | | Hide JavaScript | Additional JavaScript to determine if the Task should
be hidden. This must be empty or evaluate to "true"
in order to show the Task. You can use the variable rowId
to get the current row in the Element. |
| | Lookup Page |
Defines the Lookup page for the Schedule Task.
| Property Name | Description | | HRef | Destination URL when the Lookup icon is clicked. | | Tip | Tooltip displayed onMouseOver. | | SDC Id | SDC for the Lookup. If you have provided a Lookup page
above, this is ignored. If not, the SDC is obtained from
the link properties. | | Selector Type | Specify checkbox to show check boxes or radiobutton
to show radio buttons. You need an Accept button to return
these. If not specified, it will use either the provided
List page's set value or the new List page's defaults.
Mutliple items are returned delimited by semicolon.
| | Restrictive Where | If provided, this either combines with the provided
List page's restrictive where, or it will be used as the
primary restrictive where on the default Lookup page. | | Lookup Columns | If specified by the HRef property, these are merged
with that List page. If not, they are used to define a
new List page.
| Property Name | Description | | Identifier | If you are overriding/merging with an existing
List page, specify the same identifier as the column
on the List page; otherwise, a new column will be
created. | | Column Id | If merging with an existing List page and no match
on identifier can be found, it will try to match
on column. If no match is still found, a new column
will be created. | | title | title of the column. | | Mode | See Mode. | | Display Value | See Display Value. | | Pseudocolumn |
See Pseudocolumn.
| | Map to Column | If you are returning more than one column, you
can use this to specify where you want the values
to be returned. | | Width | Column width in pixels. | | Searchable | Determines if search capability is added to the
Lookup. |
| | Dialog Type | Browser Popup opens in a browser popup window. Sapphire
Dialog opens in a modal LabVantage dialog. | | Dynamic Lookup | Yes/No enables/disables Dynamic
Lookup. Yes(hide lookup icon) enables but hides the
icon. |
| | Edit Page | Page used for editing existing Schedule Plan Items. |
|
|
| Schedule Plan Node |
Defines the Schedule Plan Node.
| Property Name | Description | | Visible | Determines if the Schedule Plan Node Tree is shown. | | Expanded | Determines if the Nodes are initially expanded. | | Schedule Plan title Column | Column to show as the title for the Schedule Plan Root Nodes. This
can contain a SQL subquery. | | Schedule Plan Node title Column | Column to show as the title for the Schedule Plan Nodes. This can
contain a SQL subquery. | | Default Node | Default Node to select in the Node Tree. If noe are selected, no
Plan Items are retrieved when the page loads. |
|
| Order By |
Comma-delimited list of columns in the desired sort order. For example,
createdt,scheduleplanid,scheduleplanitemid will sort in ascending order
beginning with createdt. |