|
|
|
|
Step Definition Property Overview
|
|
|
|
|
|
All Step Definitions define these property collections:
| Property Collection
|
Description
|
| Step Definition Properties |
"Step Definition Properties" are
common to all Step Definitions. They define the fundamental attributes
of a Step. |
| Step Type Properties |
"Step Type Properties" are defined
by the Step Definition. These control the behavior of the Step. |
| Step Properties |
"Step Properties" are additional
properties that you can define to adapt or extend the "Step Type
Properties". For example, FileChooserStep and FileViewerStep are
based on the JSPStep, but extend the behavior of the JSPStep with additional
"Step Properties". Both FileChooserStep and FileViewerStep hide
the JSPStep's fixed set of Step Type properties so only the additional
file viewing or file choosing properties are exposed to the Task Designer. |
|
|
|
|
Common Step Definition Properties
|
|
|
|
|
|
All Step Definitions contain these properties:
| Step Definition Properties |
Defines common Step Definition properties:
| title | Text displayed on the first tab in Step
Details of the Task Definition Maintenance Page to identify
the Step. | | Icon Text | Short title that is displayed in the Step graphic and the "Icon
Text" in the Step
Details of the Task Definition Maintenance Page. | | Execution title | "Execution title" in the Step
Details tab in the Task Definition Maintenance Page. | | Instructions | "Instructions" in the Step
Details tab in the Task Definition Maintenance Page. | | Show in Toolbox | Determines if the Step appears in the Steps
Panel of the Task Definition Maintenance Page. | | Hide Step Type Properties | Shows or hides the Step Type properties in the Step
Configuration tab in the Task Definition Maintenance Page. | | Hide Step Properties | Shows or hides the Step properties in the Step
Configuration tab in the Task Definition Maintenance Page. | | Icon | Icon displayed on the Step in the Task
Design Area of the Task Definition Maintenance Page. | | Background Color | Background color of the Step. As of build DM0810.043.01_00, if
this property is not set, the colors default to those shown below.
| | Button Templates | Defines templates for Buttons that can be added to the Toolbar
tab in the Task Definition Maintenance Page.
| Id | In general, this is predefined or system-generated. However,
it is exposed here to let you reference it in substitutions
within text strings. For example, in the HTMLStep you could
say "Click the [buttons.nextbuttonid.text] button to
proceed". This will substitute the text of the button
with id=nextbuttonid in the generated HTML. | | Text | Text displayed on the Button. | | Tip | Tooltip for the Button. | | Image | Image displayed on the Button. | | Action | JavaScript that will be executed when the Button is clicked.
Typically this will simply be a call to the Task API, such
as sapphire.task.next() or sapphire.task.back(). See Working
with the Task Toolbar for more details. | | Automatically Add | Determines if the Button will automatically be added to
the Toolbar of the Step when the Step is added to the Task. | | Callback Operation | Advanced option that defines a notification token (sent
by the code called in the "Action" JavaScript above)
that is intercepted by the Task Manager and triggers the "Callback
Action" JavaScript (below). | | Callbefore Action | Defines the JavaScript that will be executed before the
"Action" JavaScript (above) is executed. Typically
this would be some sort of validation that can be used to
block the "Action" JavaScript by returning false. | | Callback Action | Defines the JavaScript to be executed when a "Callback"
type of API call is made in the "Action" JavaScript
(above). |
As shown in Workflow
Task Conceptual Reference → Working with the Task Toolbar
→ Button Security, Roles assigned to these Button Templates
in the Step Definition node are copied-down to the Toolbar detail
for the Task (and vice-versa). | | Transitions | This property collection allows Pre-Transition and Transition
Expressions to be defined in the Step properties, as well as cases
for each. When the Step is added to the Task, these expressions
are copied-down to the relevant Step properties in the Task as shown
in Workflow
Task Conceptual Reference → Working with the Task Toolbar
→ Branching.
| Pre-Case On Statement | Groovy that defines the Pre-Transition Expression. | | Case On Statement | Groovy that defines the Transition Expression. | | Cases |
Defines the branching cases.
| Id | Execution title of the Step for which the case id
defined. | | Case | Conditional value of the case. | | Label | Text displayed on the graphic for the branch. |
|
|
|
|
|
|
|
Accession_ExpectedSampleStep
|
|
|
|
|
|
In the AccessionSamples Task,
this renders an "Expected Samples" page to show a list of expected
Samples (based on Events defined in the Study).
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Determines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step Type properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step Type properties
are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type properties.
| title | Text displayed on the first tab in Step Details of the Task Definition
Maintenance Page to identify the Step. | | Subject Display Format | Format in which the Subject is displayed. The OOB configuration
is {|Subject: [subjectdesc] ([s_subjectid])|}. | | Additional Columns | | Identifier | Unique identifier for this item, rendered as an ID attribute
in the HTML tag. | | SDC | Choices are Sample, LV_SampleFamily, TrackItemSDC, CollectionPlan.
| | Column | Column in the SDC specified above. | | Mode | Choices are input, readonly, dropdownlist, dropdowncombo,
lookup, checkbox, datelookup, hidden. | | title | title that is displayed on the Column header. | | Width | Width of the column in pixels. | | Date Format | Format in which the time and date are displayed. | | Link Reftype ID | If the Mode is dropdownlist or dropdowncombo, this can
be either a Reference Type identifier, or a semicolon-delimited
list of Reference Values to display. | | Lookup URL | If the Mode is lookup, this is the URL of the page to open
as a lookup. | | Dropdown SQL | If the Mode is dropdownlist, this is the SQL script that
retrieves data. | | Default Value | Value displayed when a new row is added. | | Dropdown Definition | If the Mode is dropdownlist, this retrieves data based
on an SDC definition:
| SDC | 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. |
| | Lookup URL | If the Mode is lookup, this is the URL of the page to open
as a lookup.
| Lookup HRef | URL of the Lookup page. | | Tip | Tooltip to display onMouseOver. | | 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. | | Dynamic Lookup | Enables the field for Dynamic Lookup. | | SDC | SDC on which the Lookup is based. | | Default Query | Default query to apply. | | Query From | From clause for the Lookup page. | | Query Where | Where clause for the Lookup page. |
|
| | Sample Alias | Allows the User to enter a Sample Alias for the Sample being
Accessioned.
| Show | Determines if the Sample Alias is displayed. | | Sample Alias Type | If configured, the Accessioned Sample Alias will have this
Alias Type and the User will not select the Alias Type. If
blank, the User will have the ability to select the Sample
Alias Type. |
| | Accession Mode | This is used internally by the Task Definition and is not configurable. | | Study | This is used internally by the Task Definition and is not configurable. | | Site | This is used internally by the Task Definition and is not configurable. | | Cohort | This is used internally by the Task Definition and is not configurable. | | Study Display Column | Column in the s_study table that shows the Study Id. This is provided
if you want a different column in s_study to indicate a Study. |
|
|
|
|
|
Accession_ParticipantStep
|
|
|
|
|
|
In the AccessionSamples Task,
this renders a "Search Subjects" page where you can associate the
Samples with Subjects already in LabVantage, or add a new Subject as necessary.
You can also search and add the Subject in an external system.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Determines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step
Type properties are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step
Type properties are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type properties.
| Subject Selection Mode | Determines whether Single or Multiple Subjects are selected.
| | Form Columns | Number of fields for each row in the form. | | Search Columns | | Column | Configured to show columns from s_subject and s_participant
tables, and has the two additional entries subject.alias (for
Subject Alias) and participant.alias (for Participant Alias). | | Alias Type | Alias Type (Reference Type) to use when the column is an
alias. | | Alias Reference Type | Reference Type used for showing Alias Type selection while
searching the Subject. | | Mode | Choices are input, dropdownlist, lookup, checkbox, datelookup,
hidden. | | title | title that is displayed on the Column header. | | Width | Width of the column in pixels. | | Column Span | Columns to span using an HTML span tag. | | Date Format | Format in which the time and date are displayed. | | Default Value | Value displayed when a new row is added. | | Dropdown RefType | If the Mode is dropdownlist, this is the Reference Type
to use. | | Dropdown SQL | If the Mode is dropdownlist, this is the SQL script that
retrieves data. | | Dropdown Definition | If the Mode is dropdownlist, this retrieves data based
on an SDC definition:
| SDC | 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. |
| | Lookup Link | If the Mode is lookup, this is the URL of the page to open
as a lookup.
| Lookup HRef | URL of the Lookup page. | | Tip | Tooltip to display onMouseOver. | | 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. | | Dynamic Lookup | Enables the field for Dynamic Lookup. | | SDC | SDC on which the Lookup is based. | | Default Query | Default query to apply. | | Query From | From clause for the Lookup page. | | Query Where | Where clause for the Lookup page. |
| | Match Exact | "Match Exact" indicates that the data must match
the entire entered value. A value of "No" results
in a "like" search. | | Case Independent | Determines the case sensitivity of the value entered in
the search column. |
| | Validation Columns | | Column | Column in the Participant SDC. | | Mode | Choices are input, dropdownlist, lookup, checkbox, datelookup,
hidden. | | title | title that is displayed on the Column header. | | Width | Width of the column in pixels. | | Column Span | Columns to span using an HTML span tag. | | Date Format | Format in which the time and date are displayed. | | Default Value | Value displayed when a new row is added. | | Dropdown RefType | If the Mode is dropdownlist, this is the Reference Type
to use. | | Dropdown SQL | If the Mode is dropdownlist, this is the SQL script that
retrieves data. | | Dropdown Definition | If the Mode is dropdownlist, this retrieves data based
on an SDC definition:
| SDC | 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. |
| | Lookup Link | If the Mode is lookup, this is the URL of the page to open
as a lookup.
| Lookup HRef | URL of the Lookup page. | | Tip | Tooltip to display onMouseOver. | | 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. | | Dynamic Lookup | Enables the field for Dynamic Lookup. | | SDC | SDC on which the Lookup is based. | | Default Query | Default query to apply. | | Query From | From clause for the Lookup page. | | Query Where | Where clause for the Lookup page. |
| | Mandatory | Determines if this is a mandatory column. |
| | Display Columns | | Subject Column | Column in the Subject SDC. | | Participant Column | Column in the Participant SDC. | | Mode | Choices are Display Value or Hidden. | | title | title displayed on the column header. | | Column Width | Column width in pixels. | | Link | | Href | Destination URL of the link. | | 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 | Tooltip to display onMouseOver. |
| | Display Value | Values displayed in place of the corresponding retrieved
values. These options are similar to those in the maint Element.
| | Date Format | Format in which the time and date are displayed. |
| | Page for adding new Subject | URL of the page used for adding a new Subject. | | External Application Search Class | This is used for configuring an Ajax class to search Subjects
in a external system. If this property is configured, a button "Add
Subject from External System" appears on the page. Clicking
this button makes an Ajax call to this class and sends all search
criteria. The Ajax class is now responsible to connect to the external
system in order to search for the Subject. This class must return
the LabVantage Subject Id. | | Accession Mode | This is used internally by the Task Definition and is not configurable.
| | Study | This is used internally by the Task Definition and is not configurable.
| | Site | This is used internally by the Task Definition and is not configurable.
| | Cohort | This is used internally by the Task Definition and is not configurable.
| | Study Display Format |
Format used to display Study information at various places in
the Accessioning Task. This can be configured to use any column
from the Study. The OOB default value is [studydesc] ([s_studyid]).
The AccessionSamples
Task displays the Study at the top of each Step to indicate
the Study under which the Samples are being Received. In general,
a typical use case is when you want to display a Study column
other than the StudyId. You can then use this property to configure
an alternate identifier for the Study. Putting this at the Step
level lets you use this feature in multiple Workflow Tasks. |
|
In the AccessionSamples Task,
this renders an "Event Selector" page to identify the Study and
Events for which you are receiving Samples.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Determines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step Type properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step
Type properties are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type properties.
| Additional Columns | | Identifier | Unique identifier for this item, rendered as an ID attribute
in the HTML tag. | | SDC | Choices are Sample, LV_SampleFamily, TrackItemSDC, LV_ParticipantEvent. | | Column | Column in the SDC specified above. | | title | title that is displayed on the Column header. | | Width | Width of the column in pixels. | | Mode | Choices are input, dropdownlist, dropdowncombo, lookup,
checkbox, datelookup, hidden. | | Date Format | Format in which the time and date are displayed. | | Validation | Client-side validation rules for text entered into input
fields. The options are similar to those in the maint Element. | | Link Reftype ID | If the Mode is dropdownlist or dropdowncombo, this can be
either a Reference Type identifier, or a semicolon-delimited
list of Reference Values to display. | | Lookup URL | If the Mode is lookup, this is the URL of the page to open
as a lookup. | | Dropdown SQL | If the Mode is dropdownlist, this is the SQL script that
retrieves data. | | Default Value | Value displayed when a new row is added. | | Dropdown Definition | If the Mode is dropdownlist, this retrieves data based on
an SDC definition:
| SDC | 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. |
|
| | Accession Mode | The Task checks this Variable and directs the User to next Step.
This is configured OOB to [variables.accessionmode]. | | Event Selection Mode | Determines whether to Receive Samples for a single event or multiple
events. This is configured OOB to Single. | | Study | Advanced property that is not configurable. Used for remembering
the last selected Study. | | Site | Advanced property that is not configurable. Used for remembering
the last selected Site. | | Cohort | Advanced property that is not configurable. Used for remembering
the last selected Cohort. | | Study Display Format | Format used to display Study information at various places in
the Accessioning Task. This can be configured to use any column
from the Study. The OOB default value is [studydesc] ([s_studyid]).
The AccessionSamples
Task displays the Study at the top of each Step to indicate
the Study under which the Samples are being Received. In general,
a typical use case is when you want to display a Study column
other than the StudyId. You can then use this property to configure
an alternate identifier for the Study. Putting this at the Step
level lets you use this feature in multiple Workflow Tasks. |
|
In the AccessionSamples Task,
this renders an "Accession Summary" page at the end of the Task
to show a list of the Accessioned Samples.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Determines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step
Type properties are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step
Type properties are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type properties.
| Text to display at top of the page | Text that is displayed at the top of the Accession Summary page. | | Columns | | Column | Column in the s_sample table. | | Mode | Choices are Display Value or Hidden. | | title | title that is displayed on the Column header. | | Width | Width of the column in pixels. | | Link URL | Allows configuring a hyperlink on the column value that
the User can click to open the link in a popup window. | | Display Value | Values displayed in place of the corresponding
retrieved values. These options are similar to those in the
maint Element. | | Date Format | Format in which the time and date are displayed. |
|
|
The ActionBlockStep executes an Action Block within a Task. This Step lets
you build the Action Block using the Action Block Editor to do things such
as map Task Variables onto Action properties and pass return properties from
Actions back into Task Variables.
Variables can be used as inputs properties for the actions, such as [variables.batchid]
or [variables.sampledetailsform.fields.sampletype]. Output/return properties
from the Action Block are automatically set into Task Variables. If the output
maps onto a defined Variable, the Variable Type must accept a String input.
Transitioning away from an ActionBlockStep (except "Back") will
automatically execute Action processing. Once executed, processing will not
be re-executed when the Step is revisited.
The API call is:
| • |
sapphire.task.step.actionblock.process() |
ActionBlockStep Properties:
| Step Definition Properties |
See Common Step Definition Properties. |
| Step Type Properties |
Defines the Step behavior.
| Action Block | Defines the Action Block. "Edit Action Block" opens
the Action Block Editor. | | Callback Action | JavaScript to execute after Action Block processing has completed.
This overrides the default "sapphire.task.next()" call. | | Confirm Message | Rich-text message to display before the Action Block is executed.
The Action Block can then be executed with sapphire.task.step.actionblock.process()
or any other "forward" transition (such as clicking "Next").
If you leave this property blank, the Action Block will execute
automatically on entry to the Step. | | Processing Message |
Rich-text message to display when Action Block is being executed
(defaults to "Processing
").
| | Operation | Free-text definition of the "ESig" operation (below)
being performed with the processing. This applies even if ESig is
not used. | | ESig | Displays an ESig dialog before the Action executes. This generates
a TraceLogId that is added to all audit records generated by the
Action Block.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
| | On Repeat | Determines what the Action Block does if the Task contains a
loop and the Action Block is accessed a second time.
| Block | Generates an error, i.e., this Action Block should not be
accessed twice. | | Re-Execute | Execute the Action Block on each loop. | | Skip | Skip this step for second and subsequent loops. |
|
|
| Step Properties |
None. |
The Attachment Step manages Attachments associated with SDIs. This Step can
show the Attachment Manager page in
edit or view mode, or in a view-only thumbnail view. The AttachmentStep is
an extension of the JSPStep.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type Properties.
| SDC Id | SDC Id of the primary SDC. | | Key Id 1 | KeyId1 of the SDI(s). This can be multiple SDIs or a Variable. | | Key Id 2 | KeyId2 of the SDI. This can be a Variable. | | Key Id 3 | KeyId3 of the SDI. This can be a Variable. | | Tab title | title displayed on the primary tab. | | Show Primary Tab | Shows/hides the primary tab. | | Allow Edit | Determines if Attachments can be edited. | | View Only | Determines if Attachments are displayed in view-only mode. | | Thumbnail View | Determines if Attachments are displayed in view-only thumbnail
mode. | | Can Re-Store Attachments | Determines if stored Attachments can be re-uploaded. | | Attachment Types | Defines Attachment Types that are allowed.
| Allowed Types | Collection of Attachment Types that are allowed to be used.
If this property is not set, all Attachment Types are allowed. | | Content Editable | Determines if Attachments of this Attachment Type can be
edited after creation. |
| | Allow Overwrite | Determines if Attachments can be overwritten. This applies only
to File Attachments stored by reference (see Attachments). |
|
The AttributeStep manages Attributes
associated with SDIs. This uses the ability to configured display of Attributes
associated with multiple SDIs as described in Navigator
Policy → Edit Set → Special Edit Set Properties. The AttributesStep
is an extension of the WebPageStep.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Web Page | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). | | Request Params | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type Properties.
| SDC Id | SDC Id of the primary SDC. | | Key Id 1 | KeyId1 of the SDI(s). This can be multiple SDIs or a Variable. | | Key Id 2 | KeyId2 of the SDI. This can be a Variable. | | Key Id 3 | KeyId3 of the SDI. This can be a Variable. |
|
The COCStep defines a Chain of Custody transfer within a Task. Transfers
can be from/to Users, Storage Units, external sources, or they can be derived.
COC is based on the handling of Trackable Items (also referred to as "Trackitems").
You can specify the actual TrackitemId or the keys of the Trackitem owner.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Trackitem SDC | SDC of the Trackitem owner. | | Trackitem KeyId1 | KeyId1 of the Trackitem owner. | | Trackitem KeyId2 | KeyId2 of the Trackitem owner. | | Trackitem KeyId3 | KeyId3 of the Trackitem owner. | | Trackitem Id | TrackitemId of the item being transferred. | | Transfer Message | Message displayed in the Step for the transfer. | | Transfer Image | Image displayed between the two transfer entities. | | Transfer From | Defines the source of the transfer:
| Type | Source of the transfer: External, User, Storage, or Derive. | | Reason Type | If "Type" is "User", this is the ESig
Reason prompt option: Free Text or Standard. | | Reason RefType | If "Type" is "User", this is the Reference
Type containing the Audit Reasons to be displayed on the ESig
page. | | Reason Required | If "Type" is "User", this determines
if an Audit Reason is required. | | Reason Variable | If "Type" is "User", this is the Variable
Id into which the Audit Reason is entered. | | Storage Unit Variable | If "Type" is "Storage", this is the
Variable Id into which the Storage Unit Id is entered. | | External Message | If "Type" is "External", this is the
text to display that describes the external source. |
| | Transfer To | Defines the target of the transfer:
| Type | Target of the transfer: External, User, or Storage. | | Reason Type | If "Type" is "User", this is the ESig
Reason prompt option: Free Text or Standard. | | Reason RefType | If "Type" is "User", this is the Reference
Type containing the Audit Reasons to be displayed on the ESig
page | | Reason Required | If "Type" is "User", this determines
if an Audit Reason is required. | | Reason Variable | If "Type" is "User", this is the Variable
Id into which the Audit Reason is entered. | | Storage Lookup Page | If "Type" is "Storage", this is a Storage
Unit Lookup page to locate the new Storage Location. | | Storage Unit Variable | If "Type" is "Storage", this is the
Variable Id into which the Storage Unit Id is entered. | | External Message | If "Type" is "External", this
is the text to display that describes the external target. |
| | Username Text | Text to display when prompting for a Username. | | Password Text | Text to display when prompting for a Password. | | Reason Text | Text to display when prompting for an Audit Reason. | | Storage Text | Text to display when prompting for a Storage Location. |
|
| Step Properties |
None. |
The ConverterStep converts SDI lists from one type to another, such as converting
a list of Samples to the unique list of Batches for the Samples.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Input SDC | Source SDC to be converted. | | Input Variable Id | Variable holding the list of SDIs for the "Input SDC". | | Output SDC | Target SDC. This is the SDC to which "Input SDC" is
converted. | | Output Variable Id | Variable into which the converted list of SDIs is entered. | | Conversion Type | Type of conversion (link definitions referenced below are specified
in the SDC Table
Maintenance section of the SDC Maintenance page):
| • | "Foreign Key" uses the foreign key definition
to derive the output SDIs. | | • | "Reverse Foreign Key" uses the reverse foreign
key definition to derive the Output SDIs. | | • | "Many To Many" uses the many-to-many definition
to derive the output SDIs. | | • | "SDIWorkItem" derives the output SDIs from the
internal SDIWorkitem definition. One of the Input SDCs or
Output SDCs must be SDIWorkItem. | | • | "QC Batch SDIs" derives the output SDIs from the
internal QC Batch definition. One of the Input SDCs or Output
SDCs must be QCBatch. | | • | "QC Batch WorkItems" derives the output SDIs from
the internal QC Batch Workitem definition. One of the Input
SDCs or Output SDCs must be QCBatch. | | • | "TrackItems" derives the output SDIs from the
internal Trackitem definition. One of the Input SDCs or Output
SDCs must be TrackItemSDC. | | • | "Custom SQL" derives the output SDIs using a SQL
statement defined in "SQL" below. |
| | Column (if ambiguous) | If "Conversion Type" is "Foreign Key" or "Reverse
Foreign Key", this defines the link column in the SDC definition.
This is required only if more than one foreign key exists for an
SDC. | | SQL | If "Conversion Type" is "SQL", this defines
the SQL required to derive a set of output SDIs. Note that an RSet
is generated for the list of input SDIs. The SQL should join against
the RSetItems table to generate the set of output SDIs. For example:
SELECT DISTINCT batchid FROM rsetitems, s_sample WHERE
rsetitems.rsetid=? AND rsetitems.keyid1 = s_sample.s_sampleid |
|
| Step Properties |
None. |
The DataEntryPageStep presents a
Data Entry page (GWT Data Entry Grid page using the gwtdataentrygrid
Element) within a Task. The Step properties can be configured to specify
three different Query Modes to retrieve data (a list of KeyIds, SDI Queries,
or DataSet Queries).
The API calls are:
| • |
sapphire.task.step.dataentry.save()
This provide the same functionality as clicking the "Save" button. |
| • |
sapphire.task.step.dataentry.saveAndRelease()
This provides the same functionality as clicking the "Save and Release"
button. |
DataEntryStep Properties:
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Data Entry View | Determines the Data Entry Grid to render. | | Is Read Only | Determines whether or not the entire Data Entry iframe page (both
the Data entry grid and the Detail panel) is readonly. For dynamic
setting, this supports the Request Parameter parameter readonly,
i.e., readonly=Y or readonly=N. | | Query Mode | Determines how data are retrieved:
| By Key Id | Passes SDCId and KeyId1,2,3 to the Step. This supports DataSet/SDIDataId
and SDIWorkItem/SDIWorkitemId as SDC/KeyId1 combinations. | | By SDI Query | Uses a predefined SDI Query. | | By DataSet Query | Uses a predefined DataSet Query. |
| | SDC | SDC for which data are entered. | | KeyId1 | If "Query Mode" is "By Key Id", this is the
list of SDI KeyId1s. | | KeyId2 | If "Query Mode" is "By Key Id", this is the
list of SDI KeyId2s. | | KeyId3 | If "Query Mode" is "By Key Id", this is the
list of SDI KeyId3s. | | Filter SDC Id | If "Query Mode" is "By DataSet Query", this
is the primary SDC filter. | | Filter KeyId1 | If "Query Mode" is "By DataSet Query", this
is the primary SDI (KeyId1) filter. | | DataSet Query | If "Query Mode" is "By DataSet Query", this
is the Dataset query to use. | | DataSet Query Params | If "Query Mode" is "By DataSet Query", this
defines Query parameters.
| Parameter | Collection of query parameters to support the specified
DataSet Query. |
| | SDI Query | If "Query Mode" is "By SDI Query", this is
the SDI Query to use. A dropdown list lets you choose after you
specify the SDCId. | | SDI Query Params | If "Query Mode" is "By SDI Query", this defines
Query parameters.
| Parameter | Collection of Query parameters to support the specified
SDI Query. |
| | Data Item Display Rule | Executes server-side filtering to determine how data are displayed.
You can choose a predefined rule or define one using a Groovy expression.
See "Data
Item Display Rule" in the gwtdataentrygrid Element. | | Save Validation Options | Determines whether or not to allow "Save" or "Save
and Release" when one or more mandatory Data Items are not
entered. The options are specified as follows:
| • | Do not Allow Save with Empty Mandatory Items | | • | Do not Allow Save and Release with Empty Mandatory Items |
| | Request Params | Additional parameters that can be passed into the page when it
is called. The format is:
param1=value1¶m2=value2
| | Auto Release on Next | Determines whether or not to do a "Save and Release"
on a click of the "Next" button. By default, clicking
the "Next" button is the same as clicking the "Save"
button. | | Operation | Free-text definition of the ESig operation being performed with
the processing. This applies even if ESig is not used. | | ESig | Displays an ESig dialog before saving. This generates a TraceLogId
that is added to all audit records generated by the save.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
|
|
| Step Properties |
None. |
The eFormStep presents a standard eForm
within a Task. Forms in the eFormStep are saved and processed in the same
manner as Forms in the eFormManager, i.e., a Document is created and processing
is executed.
A single Variable is used hold the value/state of the Form as a whole. The
fields within the Form define "sub-variables" (shown in a tree structure
in the Task Variables), which can be used elsewhere in the Task Definition
(such as [variables.myform.fields.myfield]). Typically, these "sub-variables"
are used in Action Blocks or other processing to create LabVantage objects.
Transitioning away from the eFormStep will automatically submit the Form
as if the "Submit" button was clicked in the eFormManager (including
validation, processing, etc.) and populate any Variables mapped onto theForm's
fields. Transitions will be blocked if Validation errors occur on the Form.
Transitioning back to the Form will show the saved Document.
The API call is:
| • |
sapphire.task.step.eform
This supports a subset of the standard eForms API, such as sapphire.task.step.eform.getFieldValue(
'myfield' ). |
eFormStep Properties:
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Mode | Defines the mode of the eForm when it opens:
| • | "Form" opens with a blank Form. | | • | "Document" opens with an existing Document. |
| | Form Id | If "Mode" is "Form", this is the FormId of
a standard saved Form. | | Form Version Id | If "Mode" is "Form", this is the Version of
the Form. | | New Document | If "Mode" is "Form", this is the new Document
Id generated when the Form is saved. | | Document Id | If "Mode" is "Document", this is the Document
Id of a saved eForm. | | Document Version Id | If "Mode" is "Document", this is the Document
Version Id of a saved eForm. | | Request Params | Additional parameters that can be passed into the eForm when
it is called. The format is:
param1=value1¶m2=value2
| | Default Values | Defines default values for Fields in the Form:
| Field Id | Field Id in the Form to which the default value is set. | | Default Value | Default value to set. |
| | Variable Mapping | Maps Fields in the eForm to Variables when the Step is unloaded.
| Variable Id | Variable Id into which the field value is entered. | | Field Id | FieldId in the eForm. | | Instance | Field instance in the eForm. |
| | On Back | Determines what the Form does if the Task goes "Back"
and the Form is accessed a second time.
| Block | Generates an error, i.e., this Form should not be accessed
twice. | | Set Mode to Form | Upon reentry, the Mode will be set to "Form". | | Set Mode to Document | Upon reentry, the Mode will be set to "Document". |
| | On Repeat | Determines what the Form does if the Task contains a loop and
the Form is accessed a second time.
| Block | Generates an error, i.e., this Form should not be accessed
twice. | | Set Mode to Form | Upon reentry, the Mode will be set to "Form". | | Set Mode to Document | Upon reentry, the Mode will be set to "Document". |
|
|
| Step Properties |
None. |
The ESigStep forces entry of ESig details within a Task. It can be used as
a gating mechanism in a Task and/or the ESig details can be used in subsequent
Steps. Note that some Steps (such as ActionBlockStep, MaintPageStep, etc.)
provide their own ESig mechanism.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| ESig Message | Message to diaplay to the User concerning the ESig. | | Username Text | User text prompt in the ESig. | | Password Text | Password text prompt in the ESig. | | Reason Text | Reason text prompt in the ESig. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed on
the ESig page. | | Reason Required | Determines if an Audit Reason is required. | | Reason Variable | Defines a Variable into which the entered Reason will be saved.
| | Audit Activity | Operation or audit activity represented by this ESig. | | Generate TraceLog Entry | Generates a TraceLogId taht can be used in subsequent Steps within the Task. | | TraceLog Variable | Defines a Variable for the generated TraceLogId. |
|
| Step Properties |
None. |
The FileChooserStep allows upload of a client-side file to the server, server-side
selection of files, and preview of the chosen files. The FileChooserStep is
an extension of the JSPStep.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Determines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type Properties.
| Type | Determines the type of file browser dialog to use: "Server"
(server-side) or "Client" (client-side). | | Prompt | Prompt for the file browser. | | Server Side Properties | These apply if "Type" is "Server".
| Root Path | Path at which the file browser opens. | | Extensions | Collection of file extensions for which to browse.
| Extension | File extension for which to browse (such as *.txt). | | title | Ttile of the file extension (such as Text File). |
| | Navigation | Determines how the server-side browser allows navigation.
| Free | Allows navigation both up and down the file tree. | | Lock Up | Allows navigation only down the file tree. | | Lock Up and Down | Allows only the capability of selecting files in the
specified directory. |
| | Embedded | Determines if the file browser is displayed as embedded
in the page. Set to "No" to use a popup window. | | Allow New File | Determines if new files that do not exist are allowed. |
| | Client Side Properties | These apply if "Type" is "Client".
| Upload | Determines if the selected file can be uploaded to the server. | | File Location Id | Value of the "File Locations → Id" property
in the File Location
Policy for the Upload node that is used to determine available
upload locations. Note that this is the identifier for the
set of "File Locations" properties. It is not the
name of the node itself. This defines the upload path. | | Extensions | File extensions for which the client-side dialog will browse. |
| | Show Preview | Shows a preview of the selected file. | | Button Text | Text of the button. | | Filename Variable | Variable Id into which the the selected file path is written. |
|
The FileViewerStep displays the contents of a text file. If the file is CSV
or Microsoft Excel, this can display as a spreadsheet using the spreadsheet
viewer in the Data File Parser.
The FileViewerStep is an extension of the JSPStep.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Determines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type Properties.
| Filename | Filename of the file to view. This can be the name of a non-binary
text file, or it can be a Variable. | | CSV File | If this is a CSV file, these properties apply.
| Display Type | Determines how the CSV text id displayed.
| Speadsheet | As a spreadsheet. | | Raw Text | Raw content. | | HTML | As an HTML table. |
| | Separator Character | This defaults to comma, but can be tab or other character. | | Quote Character | Defaults to single quote, but can be set to alternative. | | Escape Character | Defaults to CSV escape character. | | Line End Character | Defaults to CSV end-of-line character. |
| | Charset | Charset to use for the text reading. | | Maximum Lines To Read | Maximum number of lines to read from the text file. |
|
The FormStep provides a Form-based interface to collect data within a Task.
This Step should not be confused with the eFormStep, which actually hosts
a full eForm Document. The FormStep provides a subset of the functionality
available using eForms technology (such as validation, expression-based properties
to show/hide and enable/disable Fields, Sections, Groups, etc.), but with
these key differences:
| • |
The Form definition is saved within the Task, not in the Form table. |
| • |
Forms do not create a Document and do not support bound Worksheets. |
| • |
Forms do not have any processing associated with them. |
| • |
Forms do not have Annotations, Follow-Ups, Attachments or any other
construct that saves data against the Document tables. |
A single Variable of type "Form"is used hold the value/state of
the Form as a whole. The Fields within the Form define "sub-variables"
of the variable (shown in a tree structure in the Task Variables), which can
be used elsewhere in the Task definition (such as [variables.myform.fields.myfield]).
Typically these "sub-variables" are used in Action Blocks or other
processing to create LabVantage objects. The Form Step supports a subset of
the standard eForms API, e.g., sapphire.task.step.form.getFieldValue( 'myfield'
).
Transitioning away from the FormStep will automatically populate the Form
Variable with the value/state of the Form. Transitions will be blocked if
Validation errors occur on the Form. Transitioning back to the Form will set
the Form to the same value/state of the Form Variable.
This Step also lets you build Action Blocks and Groovy script using the Action
Block Editor. ActionBlocks and Groovy scripts are executed just before the
Step is unLoaded (meaning immediately before moving to the next Step). Both
types of processing can reference the Task context and the Task Variables,
and can return output variables in a manner similar to the ActionBlockStep
and GroovyStep. ESig properties are also available
to allow optional signing of the processing.
The API call is:
| • |
sapphire.task.step.form |
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Form Layout | Defines the Form to be displayed in the Step using the Form
Builder. | | Default Values | Defines default values for Fields in the Form:
| Field Id | Field Id in the Form to which the default value is set. | | Default Value | Default value to set. |
| | Variable Id | Defines a Variable to hold the Form values. | | Action Block | "Edit Action Block" opens the Action
Block Editor. | | Groovy | "Edit Groovy" opens the Action
Block Editor in Groovy mode. | | Operation | Free-text definition of the ESig operation being performed with
the processing. This applies even if ESig is not used. | | ESig | Displays an ESig dialog before the script executes. This generates
a TraceLogId that is added to all audit records generated by the
script.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
|
|
| Step Properties |
None. |
The GroovyStep executes Groovy script within a Task. This Step lets you build
the Groovy script using the Action Block Editor. Variables can be used in
the script using the implicit variables object, e.g., variables.batchid or
variables.sampledetailsform.fields.sampletype.
The GroovyStep can be run in a "Manual" Task (through prmpts in
the UI), or an "Auto-Execute" Task (in which case, the UI properties
are ignored).
Output values from this Step are automatically set into Task Variables. Output
values can be set into the implicit output object, e.g., output.rawsamples
= "S1;S2". If an output maps onto a defined Variable, the Variable
Types must match.
The API call is:
| • |
sapphire.task.step.groovy |
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Groovy | "Edit Groovy" opens the Action
Block Editor in Groovy mode. | | Callback Action | JavaScript to execute after script processing has completed. This
overrides the default "sapphire.task.next()" call. | | Confirm Message | Rich-text message to display before the script is executed. The
script can then be executed with sapphire.task.step.groovy.process()
or any other "forward" transition (such as clicking "Next").
If you leave this property blank, the script will execute automatically
on entry to the Step. | | Processing Message | Rich-text message to display when script is being executed (defaults
to "Processing
"). | | Operation | Free-text definition of the ESig operation being performed with
the processing. This applies even if ESig is not used. | | ESig |
Displays an ESig dialog before the script executes. This generates
a TraceLogId that is added to all audit records generated by the
script.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
| | On Repeat | Determines what the script does if the Task contains a loop and
the script is accessed a second time.
| Block | Generates an error, i.e., this script should not be accessed
twice. | | Re-Execute | Execute the script on each loop. | | Skip | Skip this step for second and subsequent loops. |
|
|
| Step Properties |
None. |
The HTMLStep presents HTML to the User for the purpose of issuing instructions
(such as text from an SOP) or a summary of what occurred earlier in the Task.
This Step includes an "acknowledgement" feature that forces a User
to acknowledge the message before the Task can proceed, with provisions for
requiring the User to re-authenticate before proceeding.
The API call is:
| • |
sapphire.task.step.html |
This Step supports substitution as follows:
Variables (using drag-and-drop or entry)
| Type of Variable
|
Basic Variable Substitution
|
| String |
[variables.variableid] |
| SDIList |
[variables.variableid] or [variables.variableid.keyid1]
(this also accepts keyid2 or keyid3) |
| Form |
[variables.variableid.fields.fieldid] |
Examples:
| • |
This task created [variables.copies] Samples |
| • |
You have added sample [variables.newsample.keyid1] of type [variables.formdetails.fields.sampletype] |
| • |
You are [variables.myform.fields.age] years old |
Step Type Properties
PropertyList and Collection Types not supported.
Example syntax:
| • |
[steptypeproperty.propertyid] |
Button Properties
This is useful for "Click the [button.next123.text]
button to continue" Example syntax:
User Details
Example syntax:
| • |
[user.connectionid] |
|
• |
[user.departmentlist] |
| • |
[user.databaseid] |
|
• |
[user.sysuserid] |
| • |
[user.defaultdepartment] |
|
• |
[user.sysusername] |
This Step also supports Groovy substitutions, which must be surrounded by
$G{}. Examples:
| • |
Added $G{variables.copies} Samples |
| • |
I will be creating $G{variables.howmany} sample$G{variables.howmany
== "1" ? "" : "s"} |
You can use Groovy to generate multiple variations of text and HTML formatting.
Examples:
SDIList object
| Syntax |
Description
|
| variables.mysamplelist.toString() |
generates a standard semicolon separated
list of keys, e.g. S1;S2;S3 |
| variables.mysamplelist.toText() |
generates a smarter list, e.g. "S1,
S2 and S3" |
HTML object (to generate HTML formatting
snippets around SDIList variables)
| Syntax |
Description
|
| html.toTable( mysamplelist ) |
generates a simple table (<table><tr><td>S1</td></tr></table>) |
| html.toList( mysamplelist ) |
generates a simple html list (<ul><li>S1</li></ul>) |
taskContext object ( all getters are available,
e.g., taskContext.getTaskdefid() )
| Syntax |
Description
|
| html.toTable( mysamplelist ) |
generates a simple table (<table><tr><td>S1</td></tr></table>) |
| html.toList( mysamplelist ) |
generates a simple html list (<ul><li>S1</li></ul>) |
User object
| Syntax |
Description
|
| user.sysuserid |
UserId in the SysUser table. |
HTMLStep Properties:
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| HTML | Defines the HTML for the Step. | | Show Acknowledgement | Displays the "Message" below that forces a User to acknowledge
the message before the Task can proceed. | | Position | Defines the position of the Acknowledgement
message: Top or Bottom. | | Message | Acknowledgement message. | | Password Required | If "Show Acknowledgement" is "Yes", this prompts
for Username and Password to re-authenticate before proceeding. |
|
| Step Properties |
None. |
The JSPStep provides a framework for custom functionality using standard
LabVantage JSP development techniques. This Step lets you define your own
properties to drive the JSP page in a manner similar to Page Types.
The API call is:
The ListPageStep presents an SDI List page within a Task. Use this primarily
for selecting items, i.e., its behavior is similar to a Lookup page as a Step
in the Task. Selected items would typically be stored in an SDIList variable.
Retrieval into the list can be driven by a Query, a list of SDIs, or by User
selection through the SDI List page Search Bar. As with other "page wrapper"
Steps, the ListPageStep toolbar will be overridden by the Task toolbar. Any
functions on the toolbar that must be preserved in the Task must be added
as Custom Buttons on the Step.
Transitioning away from the ListPageStep automatically populates the Variable
with the selected items in the list.
The API calls are
| • |
sapphire.task.step.list
This maps onto sapphire.page.list in the frame hosting the Web page and
provides access to the sapphire.page.list object API, e.g., sapphire.task.step.list.getSelected(). |
| • |
sapphire.task.step.list.window
This provides access to the frame window object, and thereby all page-defined
functionality, e.g., sapphire.task.step.list.window.getSelectedItems(). |
ListPageStep Properties:
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| List Page | The SDI List page to use. This can also be a Lookup page. | | SDC | SDC supported by the SDI List page. | | Query Mode |
Determines how the page is queried:
By Key Id: Queries by the SDI KeyId1. Provide a list of KeyIds.
These can be either manually entered or mapped from a Variable
using the KeyId1, KeyId2, and KeyId3 properties below. By Query: Choose one of the Query SDIs from the "Query"
dropdown list below and provide the desired "Query Params"
below. You can also provide a "Restrictive Where" clause
below to further limit the Query results. | | KeyId1 | If "Query Mode" is "By KeyId", specify the
KeyId1 to query. | | KeyId2 | If "Query Mode" is "By KeyId", specify the
KeyId2 to query. | | KeyId3 | If "Query Mode" is "By KeyId", specify the
KeyId3 to query. | | Query | If "Query Mode" is "QUery", choose the Query
here. | | Query Params | Parameters (if any) defined by the Query SDI.
| Parameter | Value of the Query Parameter. |
| | Restrictive Where | Restrictive "Where" clause to further limit the Query
results. | | Min Select | Minimum number of SDIs that can be selected. | | Max Select | Maximum number of SDIs that can be selected. Setting this to 1
changes from a checkbox to a radiobutton. | | Hide Search Bar | "Yes" hides the Search Bar, thus restricting Queries
that can be executed. | | Request Params |
Optional parameters to be passed to the page as if they were
passed in through the URL. The format is:
param1=value1¶m2=value2
| | Selected Item Variable Id | Variable into which the selected SDIs will be placed. |
|
| Step Properties |
None. |
The LoadArrayStep is used to load Plates in the LoadArray
Task Definition.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Web Page | URL of the page to load. | | Request Params | Request Parameters to input. This is used internally by the Task
Definition and is not configurable. For example, the OOB LoadArray
Task uses its defined Task Variables in the params as follows:
keyid1=[variables.selectedarray.keyid1]&methodid=[variables.arraymethod.keyid1]&methodversionid=[variables.arraymethod.keyid2] . | | Loaded Operation | This is not to be used for configuration. |
|
| Step Properties |
Extensions to the Step Type Properties.
| KeyId1 | This is used internally by the Task Definition and is not configurable. | | Primary Queue | This is used internally by the Task Definition and is not configurable. | | Secondary Queue | This is used internally by the Task Definition and is not configurable. | | Input Queues | Defines the Input Queues.
| Zone Type | This is used internally by the Task Definition and is not
configurable. | | SDC | This is used internally by the Task Definition and is not
configurable. | | Task Input Id | This is used internally by the Task Definition and is not
configurable. |
|
|
The LoadArrayZoneStep is used to load Zones in the LoadArray
Task Definition.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| JSP Filename | This is not to be used for configuration. | | Loaded Operation | This is not to be used for configuration. |
|
| Step Properties |
Extensions to the Step Type Properties.
| Array Id | This is used internally by the Task Definition and is not configurable. | | Array Method Id | This is used internally by the Task Definition and is not configurable. | | Array Method Version Id | This is used internally by the Task Definition and is not configurable. | | List of Zones to Load | This is used internally by the Task Definition and is not configurable. |
|
The MaintPageStep presents an SDI Maintenance page within a Task. The Step
properties define the SDC and KeyId1/2/3, plus provide options to add and
edit.
A set of Variables can be mapped to columns in the SDI Maintenance page to
be populated when a transition occurs. Transitioning away from the maint page
step (except "Back") will automatically save the page data and populate
the any Variables mapped onto the form columns. Transitions will be blocked
if an error occurs on the form. In add mode, transitioning depends on the
"On Back" and "On Repeat" properties below.
The API calls are
| • |
sapphire.task.step.maint
This maps onto sapphire.page.maint in the frame hosting the Web page and
provides access to the sapphire.page.maint object API, e.g., sapphire.task.step.maint.save(). |
| • |
sapphire.task.step.maint.window
This provides access to the frame window object, and thereby all page-defined
functionality, e.g., sapphire.task.step.maint.window.getSelectedItems(). |
MaintPageStep Properties
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Maint Page | The SDI Maintenance page to use. | | SDC | SDC supported by the SDI Maintenance page. | | KeyId1 | KeyId1 of the SDI. | | KeyId2 | KeyId2 of the SDI. | | KeyId3 | KeyId3 of the SDI. | | Mode | "Add" will let you add SDIs. "Edit" provides
editing capability. | | Operation | Free-text definition of the ESig operation being performed on
the page. | | ESig | Displays an ESig dialog before saving.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
| | Add Options | Options available if the "Mode" is "Add".
| Template | Template for the new SDI to be added. | | Copies | Number of copies to create. | | Show Template Selector | Determines if the Template Selector is shown. |
| | Request Params | Optional parameters to be passed to the page as if they were passed
in through the URL. The format is:
param1=value1¶m2=value2
| | Default Values | Injects literal or Variable values into the field default values.
| Dataset | This is currently not used, but has been defined for future
use. Currently, only default values for the primary can be
defined. | | Column Id | Column to be set in the primary. | | Default Value | Default value for the column. |
| | Variable Mapping | When navigating away from the Step (after a "Save"),
this stores the values of these fields in Variables.
| Variable Id | Defines a Variable into which the column value is entered. | | Dataset | This is currently not used, but has been defined for future
use. Currently, only default values for the primary can be
used. | | Column Id | Column in the primary Data Set to use. |
| | On Back | Determines what the page does if the Task goes "Back"
and the page is accessed a second time.
| Block | Generates an error, i.e., this page should not be accessed
twice. | | Set Mode to Add. | Sets page "Mode" to "Add". | | Set Mode to Edit. | If returning to this Step via a "Back" operation,
you can force the mode into "Edit". This is useful
if it was originally in "Add" mode. |
| | On Repeat | Determines what the page does if the Task contains a loop and
the page is accessed a second time.
| Block | Generates an error, i.e., this page should not be accessed
twice. | | Set Mode to Add | Sets page "Mode" to "Add". | | Set Mode to Edit | Sets page "Mode" to "Edit". |
|
|
| Step Properties |
None. |
The NoopStep does not perform any specific operation in a Task. Essentially,
it does nothing. However, the Task Manager framework processes it in the same
way as any other Step, so all generic Step functionality is performed, e.g.,
the Loaded Script and Transition functionality will execute. For example,
suppose a Task has three setup variables (setup1, setup2, setup3), and you
need a switch that determines whether or not the User can override those variables.
The first thing the Task should do is branch based on the "prompt"
variable. You can do this by adding a NoopStep with a Transition expression.
The QCSequenceStep allows QC Batches to be defined in a Step. The QC Batches
generated are based on the standard QC Batch wizard functionality, but they
are interactive in that the structure of the Batch is automatically shown
as Samples are added.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| QC Method | Defines the QC Method for the QC Batch. | | QC Method Version | Defines the QC Method Version for the QC Batch. | | QC Batch Variable | Defines a Variable to hold the new QC Batch Id that is generated. | | Task Input Id | The Input Queue from which you are choosing SDIs. This is a mandatory
property. | | Selected Items Variable Id | Name of the Variable that will hold the SDIs selected from the
Input Queue. This must be an SDIList Variable Type. | | Min Select | Minimum number of SDIs that can be selected. | | Max Select | Setting this to 1 changes from a checkbox to a radiobutton. | | Auto Select | If set to "Yes", the first "n" items in the
list specified by "Number to Auto Select" are automatically
selected, i.e., the checkbox is checked. | | Number to Select | Number of items to "Auto Select". | | Queue Usage | "Exclusive" means that any item chosen from the Input
Queue is removed from the Queue (to prevent it from being processed
by someone else).
"Shared" is a mode where items can remain on the Input
Queue to be processed multiple times (such as where the Queue
is a resource, as is the case with SDCs such as Consumable Lots). | | List Definition | Defines the SDI List.
| SDC | SDC supported by the page. | | Initial Grouped | "Yes" sets the page to group when it loads. | | Columns | Defines columns in the list.
| 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. | | title | Text displayed on the colum header of the SDI list. | | Mode | Display attributes of retrieved values in the column:
| Display Text | Shows retrieved values. | | Hidden Value | Hides retrieved values. |
| | Tip | Tooltip for the column value. This supports value
substitution. | | Width | Width of the column in pixels. | | Alignment | Horizontal position within the SDI list column (left,
middle, or right). | | Return Value | "Yes" returns the key value of the selected
column. For example, when you choose a Sample on a Lookup
Page, this would return the keyid1 (sampleid). | | Link | Defines the linked page.
| 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 | Tooltip text displayed onMouseOver. | | New Window Width | Overrides the default window width of 800px.
If the target is _blank or view, this opens a
new window. | | New Window Height | Overrides the default window height of 600px.
If the target is _blank or view, this opens a
new window. | | Open in LabVantage Dialog | Opens a LabVantage dialog rather than a browser
window. If the target is _blank or view, this
opens a new window. |
| | 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). | | Pseudo Column | 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:
| 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.
Sorting is performed by the JavaScript function sortResult(),
located in WEB-CORE/elements/scripts/list.js. |
All columns in the "Sort By" collection are used
for sorting. Clicking a column header results in the clicked
column being sorted first. The remaining columns defined
here sort according to their sequence in the collection
(excluding the clicked column). | | 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. | 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 | 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). | | 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.
| 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:| page | Text generated to identify the page number
(and number of pages) when paging occurs. | | 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 |
|
|
|
| Step Properties |
None. |
The QueueSelectorStep presents a list of SDIs from a Task's Input Queue and
allows the User to select one or more SDIs to be used in the Task execution.
This looks (and is configured) much like a Lookup page. The style, grouping,
sorting, and columns displayed in the list are configurable with Step properties
(similar to the list Element). The
selection of items (such as auto-select, number required, etc.) is also configurable.
The SDIs in the list are loaded using LabVantage Security options.
Many Tasks will use the QueueSelectorStep to let Users choose queued items.
However, there are exceptions where the QueueSelectorStep should not be used.
For example, this Step is not suitable for Auto-Execute Tasks (no human required),
when the User will always want to operate on all of the queued SDIs, or when
another Step takes care of choosing the queued SDIs (such as when loading
a Plate or QCBatch).
Transitioning away from the QueueSelectorStep automatically sets the Variable
associated with the Input Queue to the list of values selected and adds this
list (or updates it if the Step is revisited) to the Task execution items
in the database. Transitioning back to the QueueSelectorStep re-selects the
items previously selected.
The API call is:
| • |
sapphire.task.step.queueselector |
This API call can be used to return values from any columns using
sapphire.task.step.queueselector.getSelectedColumnValue( columnlist )
where columnlist is the column (or columns) from
which values are returned. Columns must be defined as "Return Values"
in the QueueSelectorStep "List Definition".
Use a semicolon to separate multiple selected
row values, such as aaa;bbb. Use a vertical bar to separate multiple column
values, such as aaa|QC.
For multiple selected rows with multiple column
values, use a semicolon to separate the rows and a vertical bar to separate
the rows, such as aaa|QC;bbb|DNA.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Task Input Id | The Input Queue from which you are choosing SDIs. This is a mandatory
property. | | Selected Items Variable Id | Name of the Variable that will hold the SDIs selected from the
Input Queue. This must be an SDIList Variable Type. | | Min Select | Minimum number of SDIs that can be selected. | | Max Select | Setting this to 1 changes from a checkbox to a radiobutton. | | Auto Select | If set to "Yes", the first "n" items in the
list specified by "Number to Auto Select" are automatically
selected, i.e., the checkbox is checked. | | Number to Auto Select | Number of items to "Auto Select". | | Queue Usage | "Exclusive" means that any item chosen from the Input
Queue is removed from the Queue (to prevent it from being processed
by someone else).
"Shared" is a mode where items can remain on the Input
Queue to be processed multiple times (such as where the Queue
is a resource, as is the case with SDCs such as Consumable Lots). | | Show Scanning Bar | Yes/No shows/hides the Scanning Bar. "List Element style
Scan" offers functionality similar to the list
Element "Allow Scan Selection" property. | | Scan Selection Column List | This is an optional property that can be used when "Show
Scanning Bar" is set to "List Element style Scan"
to scan using columns other than primary key columns. The functionality
similar to the list
Element "Scan Selection Column List" property. | | Scanning | Defines scanning options.
| Scan Text | Defines the text to prompt for a scan item. | | Item Not Found Text | Defines the text to display when an item scanned could not
be found in the queue. | | Check Aliases | Determines if scanned item aliases should be checked. | | Alias Type | Defines the type of alias to check against (leave blank
for all). | | Check Alternate Column | Allows items to be scanned by an alternate column in the
SDC's primary table. If "Yes", the "Alternate
Column" below will be checked during the scanning process. | | Alternate Column | Identifier of the alternate column checked during the scan. |
| | List Definition | Defines selected columns.
| SDC | SDC supported by the page. | | Initial Grouped | "Yes" sets the page to group when it loads. | | Columns | Defines columns.
| 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. | | title | Text displayed on the colum header of the SDI list. | | Mode | Display attributes of retrieved values in the column:
| Display Text | Shows retrieved values. | | Hidden Value | Hides retrieved values. |
| | Tip | Tooltip for the column value. This supports value
substitution. | | Width | Width of the column in pixels. | | Alignment | Horizontal position within the SDI list column (left,
middle, or right). | | Return Value | "Yes" returns the key value of the selected
column. For example, when you choose a Sample on a Lookup
Page, this would return the keyid1 (sampleid). | | Link | Defines the linked page.
| 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 | Tooltip text displayed onMouseOver. | | New Window Width | Overrides the default window width of 800px.
If the target is _blank or view, this opens a
new window. | | New Window Height | Overrides the default window height of 600px.
If the target is _blank or view, this opens a
new window. | | Open in LabVantage Dialog | Opens a LabVantage dialog rather than a browser
window. If the target is _blank or view, this
opens a new window. |
| | 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). | | Pseudo Column | 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:
| 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.
Sorting is performed by the JavaScript function sortResult(),
located in WEB-CORE/elements/scripts/list.js. |
All columns in the "Sort By" collection are used
for sorting. Clicking a column header results in the clicked
column being sorted first. The remaining columns defined
here sort according to their sequence in the collection
(excluding the clicked column). | | 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. | 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 | 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). | | 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.
| 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:| page | Text generated to identify the page number
(and number of pages) when paging occurs. | | 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 |
|
|
|
| Step Properties |
None. |
The ReagentChooserStep renders a form-like user interface to prompt for Consumables
for the provided SDI. The ReagentChooserStep is an extension of the JSPStep.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). |
|
| Step Properties |
Extensions to the Step Type Properties.
| Type | Reagent (Consumable) Type. | | KeyId1 | KeyId1 of the Reagent. | | Prompt | Text prompt. | | Mandatory | Determines if you must select a correct Reagent before continuing. |
|
The ReportStep displays a Report using the report viewer. Provide the Report
details from the Report SDC, plus the SDI keys to which it refers, and the
Step renders the report.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Mode | Report mode: "View Report" or "View Attachment". | | SDC | SDC Id of the SDI associated with the Report. | | KeyId1 | KeyId1 of the SDI associated with the Report. SDC Id of the
SDI associated with the Report. | | KeyId2 | KeyId2 of the SDI associated with the Report. | | KeyId3 | KeyId3 of the SDI associated with the Report. | | Report | Report Id to be displayed. | | Report Version | Version of the Report. | | Display Type | Display Type of the Report: "PDF" or "XLS". | | Parameter Values | Defines Parameters to be passed into the Report:
| Parameter | Name of the Parameter. | | Value | Value of the Parameter. |
| | Attachment Number | If reading the Report from the SDI, set this to the Attachment
Number. | | Attachment Class | Class of Attachment to read from the SDI. | | Request Params | Request parameters for the Report. |
|
| Step Properties |
None. |
The SendBulletinStep uses the SendBulletin
Action to sent a Bulletin to a User.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Action Block | "Edit Action Block" opens the Action
Block Editor. | | Callback Action | JavaScript to execute after Action Block processing has completed.
This overrides the default "sapphire.task.next()" call. | | Confirm Message | Rich-text message to display before the Action Block is executed.
The Action Block can then be executed with sapphire.task.step.actionblock.process()
or any other "forward" transition (such as clicking "Next").
If you leave this property blank, the Action Block will execute
automatically on entry to the Step. | | Processing Message | Rich-text message to display when Action Block is being executed
(defaults to "Processing
"). | | Operation | Free-text definition of the "ESig" operation (below)
being performed with the processing. This applies even if ESig is
not used. | | ESig | Displays an ESig dialog before sending.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
| | On Repeat | Determines what the Action Block does if the Task contains a loop
and the Action Block is accessed a second time.
| Block | Generates an error, i.e., this Action Block should not be
accessed twice. | | Re-Execute | Execute the Action Block on each loop. | | Skip | Skip this step for second and subsequent loops. |
|
|
| Step Properties |
Extensions to the Step Type Properties.
| To User Id | User who is to receive the Bulletin. | | Subject | Subject of the Bulletin. | | Message body | Message of the Bulletin. |
|
The SendMailStep uses the SendMail
Action to send an email.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Action Block | "Edit Action Block" opens the Action
Block Editor. | | Callback Action | JavaScript to execute after Action Block processing has completed.
This overrides the default "sapphire.task.next()" call. | | Confirm Message | Rich-text message to display before the Action Block is executed.
The Action Block can then be executed with sapphire.task.step.actionblock.process()
or any other "forward" transition (such as clicking "Next").
If you leave this property blank, the Action Block will execute
automatically on entry to the Step. | | Processing Message | Rich-text message to display when Action Block is being executed
(defaults to "Processing
"). | | Operation | Free-text definition of the "ESig" operation (below)
being performed with the processing. This applies even if ESig is
not used. | | ESig | Displays an ESig dialog before sending.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
| | On Repeat | |
|
| Step Properties |
Extensions to the Step Type Properties.
| To Address | Email address of the recipient. | | From Address | Address from which the email is sent. | | Subject | Subject of the email. | | Message | Message of the email. |
|
The SplitterStep provides a branching mechanism in a Task based on a declarative
set of conditions. This could typically be used to split an input list of
SDIs into different Output Queues (such as splitting a list of Samples by
their Status).
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| SDC | SDC corresponding to the list of SDIs to be split. | | Input Variable of Items | Variable that holds the list of input SDIs. | | Conditions Operator | Defines the combining condition operator when more than one "Condition"
(below) is defined. | | Conditions | Defines conditions for the split.
| Type | Defines the type of condition match: Value Match, Data Match,
or Exists. | | Dataset Name | If "Type" is "Value Match" or "Exists",
this defines the Data Set values to use in the Condition. | | Parameter List | If "Type" is "Data Match", this defines
the Parameter List data to use in the Condition. | | Parameter List Version | If "Type" is "Data Match", this defines
the Parameter List Version data to use in the Condition. | | Parameter List Variant | If "Type" is "Data Match", this defines
the Parameter List Variant data to use in the Condition. | | Dataset | If "Type" is "Data Match", this defines
the Data Set data to use in the Condition. | | Parameter | If "Type" is "Data Match", this defines
the Parameter data to use in the Condition. | | Parameter Type | If "Type" is "Data Match", this defines
the Parameter Type data to use in the Condition. | | Replicate | If "Type" is "Data Match", this defines
the Parameter Replicate data to use in the Condition. | | Column | If "Type" is "Value Match", this defines
the column data to use in the Condition. | | Value Operator | If "Type" is "Value Match" or "Data
Match", this defines the operator to use in the Condition.
Values are Equal To, Not Equal To, Is Blank, Not Blank, Contains,
Starts With, Ends With, Greater Than, Greater Than Or Equal
To, Less Than, Less Than Or Equal To, Inclusive Between and
Exclusive Between. | | Exists Operator | If "Type" is "Exists", this defines
the operator to use in the Condition. Values are Any, Equal
To, Not Equal To, Greater Than, Greater Than Or Equal To,
Less Than, and Less Than Or Equal To. | | Value | Value to use in the Condition. | | Upper Value | Second (or upper) value to use in the Condition if required
(such as with between conditions). |
| | Output Variable for Matching Items | Variable to contain the list of SDIs that match the Conditions. | | Output Variable for Non_Matching Items | Variable to contain the list of SDIs that do not match the Conditions. |
|
| Step Properties |
None. |
The ValidateCustodyStep validates to make certain the User has custody of
TrackItems, and allows the User to take custody of TrackItems. The User is
not allowed to continue unless he already has custody of the TrackItems or
he takes custody of all TrackIitems. When run in a Task Definition, set the
"inputtrackitemid" to the Task Variable that contains the TrackItemIds
to be validated. If the User already has custody of all TrackItems, this Step
will not appear in a GUI page.
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| JSP Filename | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). | | Loaded Operation | This is not to be used for configuration (the Step Type Properties
are hidden in the Task Definition). |
|
| Step Properties |
Defines the Step behavior.
| SDC | SDC associated with the custodial transfer. | | SDI Key 1
SDI Key 2 SDI Key 3 | SDIs associated with the custodial transfer. | | Display Column Collection | Columns displayed on the custody page. | | Allow Force Custody | Determines if the User can take custody, regardless of the current
Custodian. |
|
The VariableInputStep lets Users who are executing Tasks populate Task Variables
at runtime, i.e., while they are running a Task. This Step presents a list
of Task Variables (in list-based or form-based layout) from which the User
can choose. Configuration properties allow definition of the title and Editor
style of each Task Variable, as well as defining whether or not it is mandatory.
Prompts, input field styles (dropdown, lookup, etc.), defaults, and help are
derived from properties defined for the Task Variable.
Transitioning away from the VariableInputStep automatically sets the entered
values into the Task Variables. Transitioning back to the VariableInputStep
sets the values as previously entered.
This Step also lets you build Action Blocks and Groovy script using the Action
Block Editor. ActionBlocks and Groovy scripts are executed just before the
Step is unLoaded (meaning immediately before moving to the next Step). Both
types of processing can reference the Task context and the Task Variables,
and can return output variables in a manner similar to the ActionBlockStep
and GroovyStep. ESig properties are also available
to allow optional signing of the processing.
The API call is:
| • |
sapphire.task.step.variableinput |
VariableInputStep Properties
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Input style | Determines the variable layout: "List" or "Fixed
Form". | | Tab Text | If "Input style" is "Fixed Form", this is
the text displayed on the Form tab. | | List | If "Input style" is "List", this defines
visual attributes of the list.
| Prompt Column Width | Width of the column for the User prompt (in pixels). | | Input Column Width | Width of the column in pixels. | | Help Column Width | Width of the help text column in pixels. |
| | Fixed Form | If "Input style" is "Fixed Form", this defines
visual attributes of the form.
| Form Columns | Defines the number of columns used to display the Variables
(same as maint formcols). |
| | Variables | Details concernin the Task Variables:
| Variable Id | Variable defined in the Task to display in the Step. | | Prompt | Prompt for the Variable input. This overrides any default
prompt defined with the Variable. | | Editor style | Editor style for the Variable input. This overrides any
default Editor style defined with the Variable. | | Default Value | Default value for the Variable input. This overrides any
default value defined with the Variable. | | Mandatory | Determines if the Variable input is mandatory. This overrides
any default mandatory setting defined with the Variable. | | Help | Help text for the Variable input. This overrides any default
help text defined with the Variable. | | Col Span in Form | Defines the number of columns the Variable should occupy
in the form layout. | | Link To Variable | Defines a link to a prior Variable in the set. This allows
the Vvariable to be shown next to the prior Variable in the
list layout. This is useful for showing a units variable next
to the value Variable. |
| | Action Block | "Edit Action Block" opens the Action
Block Editor. | | Groovy | "Edit Groovy" opens the Action
Block Editor in Groovy mode. | | Operation | Free-text definition of the ESig operation being performed with
the processing. This applies even if ESig is not used. | | ESig | Displays an ESig dialog before the script executes. This generates
a TraceLogId that is added to all audit records generated by the
script.
| ESig Required | "Yes" executes an ESig prompt following a button
onClick event. "No" does not execute an ESig prompt. | | Message | Specifies the "Statement of Signing" text, which is passed
into the ESig page and appears at the top of the Esig prompt. | | Reason Required | Determines if an Audit Reason is required. | | Reason Type | ESig Reason prompt options: Free Text or Standard. | | Reason RefType | Reference Type containing the Audit Reasons to be displayed
on the ESig page. |
|
|
| Step Properties |
None. |
Tthe WebPageStep displays a standard LabVantage page. Any Layout defined
with the page is ignored. Note that in order to operate as a "well behaved"
page within a Task, a page must:
| • |
Expose a global supportsTask() method that returns true. |
| • |
Remove toolbar rendering (advancedtoolbar or other custom toolbars). |
| • |
Call sapphire.task.pageLoaded() when all onLoad functionality is complete. |
The API calls are
| • |
sapphire.task.step.webpage
This maps onto sapphire.page in the frame hosting the web page and provides
access to the sapphire.page object API, e.g. sapphire.task.step.webpage.maint.save(). |
| • |
sapphire.task.step.webpage.window
This provides access to the frame window object and hence all page defined
functionality, e.g., sapphire.task.step.webpage.window.getSelectedItems(). |
WebPageStep Properties
| Step Definition Properties |
See Common Step Definition
Properties. |
| Step Type Properties |
Defines the Step behavior.
| Web Page | Identifier of the Web page. | | Request Params | Additional parameters that can be passed into the page when it
is called. The format is:
param1=value1¶m2=value2
| | Loaded Operation | Free-text to denote that the page loaded. |
|
| Step Properties |
None. |
