| Operations |
Defines operations available on the Control
Toolbar.
| Property | Description | | Identifier | Unique label for this operation within this control. | | Show | Determines if the operation is visible on the toolbar. | | Text | Text shown on the operation. | | Tip | Tooltip shown for the operation. | | Image | Image displayed for the operation icon. | | Activate Operation | Determines if the Operation is executed from the
Control Toolbar (and F2 Edit shortcut key). In general, "Activate
Operation" is typically enabled only when the Control is view-only
and does not have an editor (such as the SDI Viewer Control). | | Type | Defines the functionality performed by the Operation
(with the exception of the "Menu" option as described
below).
| Option | Description | | Menu | Allows an Operation button to display a sub-menu
of other Operations. | | ExternalAdd | Defines a Lookup page that returns one or
more SDIs. The SDIs are then associated with the Control in
the WorksheetItemSDI table. | | TaskExecution | Defines a Standalone Task to execute. The
Standalone Task automatically adds the SDIs associated with
the Control (in the WorksheetItemSDI table) to a matching
(by SDC) Input Queue, and adds any SDIs generated to the WorksheetItemSDI
table on completion. If you are unfamilar with Standalone
Tasks, see Workflow
Task Conceptual Reference → Standalone Tasks. Choosing
this exposes the "SDC Operation" property (below). | | ModalLink | Defines a Maintenance page to edit the set
of SDIs associated with the Control. Choosing this exposes
the "SDC Operation" property (below). | | ModelessLink | Defines a page to display when the Operation
button is clicked. Choosing this exposes the "SDC Operation"
property (below). | | ActionBlock | Allows Actions to be executed. The Action
sequence and control logic is defined using the Action
Block Editor (open by clicking "Edit Action Block").
Choosing this exposes the "SDC Operation" property
(below).
Standard substitutions of [worksheetid], [worksheetversionid],
[worksheetitemid], and [worksheetitemversionid] are available.
LIMS Controls have the additional substitutions of [sdcid],
[keyid1], [keyid2] and [keyid3]. KeyId substitutions are
derived from the SDIs associated with the Control (or Worksheet
if the "Operation Source" property is set to "Worksheet"). | | Custom | Defines JavaScript to execute when the Operation
button is clicked. |
| NOTE: | For page operations (Modal, Modeless, ExternalAdd) and Task operations, the following substitution is supported:
[metadata.xxx] where xxx is the "attributeid" When substituting, the system will first check to see if the attribute (metadata) exists on the Control. If not, then it will check the Worksheet metadata. |
| NOTE: | SDIs can be added to Controls using any of
the following methods:
| • | Drag SDIs from the LIMS Data panel into the Control.
No new SDIs are created or added to the Worksheet. Associations
are simply being added to the WorksheetItemSDI table. | | • | Use the "ExternalAdd" Operation Type. No
new SDIs are created, but the WorksheetSDI and WorksheetItemSDI
tables are updated with the selected SDIs. | | • | Use the "TaskExecution" Operation Type.
For example, this could define a "LoginSample"
Standalone Task that creates new SDIs and adds/associates
them to the Worksheet on Task completion. |
|
| | Page | Lookup page to open when selecting SDIs. | | Operation Data Source | Determines which SDIs in the Worksheet are used/updated.
This applies to the "ExternalAdd", "TaskExecution",
"ModalLink", "ModelessLink", and "ActionBlock"
Operation Types.
This determines the source of the input SDIs for "TaskExecution",
"ModalLink", "ModelessLink" and "ActionBlock"
Operation Types ("Control" or "Worksheet"). This means that Operations can use the Worksheet SDIs rather
than the WorksheetItem SDIs, irrespective of the source they are
using for display. For example: The "Data Source" can be set to "Control"
to display SDIs associated with the Control, while "Operation
Data Source" can be set to "Worksheet" for the
"Add" Operation. Newly added SDIs are then associated
with the Worksheet as a whole. | | SDC Operation | Associates an operation on the Control
Toolbar with an SDC
Operation. This applies to the "TaskExecution", "ModalLink",
"Modeless Link, and "ActionBlock" Operation Types.
When a Worksheet Contributor clicks the button to execute the
operation, ALL of the SDIs on the Worksheet (or Control, as applicable)
are checked to ensure that the User has security privileges to
perform the operation on the SDIs. If the User does not have privileges
for any of the SDIs, the button operation is aborted and a message
is displayed indicating that the operation is not permitted on
all of the Samples. | | Filter Items | Filters (based on an SDIs column value) the list of SDIs on which this button operates.
| Property | Description | | Column id | The column in the SDC shown by the control. | | Operator | Choose either "In" or "Not In". | | Value List | Value List is a semicolon separated list of possible values on which the "In" or "Not In" will match against.
Only those SDIs that match this criteria will be passed to the operation. |
This applies to the "TaskExecution", "ModalLink",
"Modeless Link, and "ActionBlock" Operation Types. | | Is View-Only (No Refresh) | This provides a view only option for operations that do not modify the data in a Control, or the SDIs of a Control.
When "Yes": | • | After the Control, Section or Worksheet has been completed, only the "View" button (for view only operations) remains available. | | • | Once the operation behind the button completes (i.e., a Task completes, or the modal dialog closes), no controls (including the current one) are Refreshed. Since the Control, Section or Worksheet has been marked as Complete, and modifications are no longer permitted, a refresh is unnecessary. |
The View Only operation is not available for "External Add" button types.
The "Dock" button remains available (if appropriate). | | Refresh | Determines how to refresh the Worksheet upon completion.
This applies to the "ExternalAdd", "TaskExecution",
"ModalLink", and "ActionBlock" Operation Types.
This determines the type of refresh required at the completion
of the operation ("Control", "LIMS Controls",
"Section", or "Worksheet"). The default behavior
is to refresh only the Control. Note that LIMS Controls are all Controls in the worksheet that
"support SDIs", i.e., drive their display using SDIs
associated with the Worksheet or Control. For example: "Refresh" can be set to "Worksheet"
for the "Add" Operation to refresh the entire Worksheet
after adding new SDIs. |
Role protection can be enabled for defined Operations. Clicking the lock icon opens the "Roles" dialog. Select the Role(s) required to perform the Operation. Consider the following when enabling Roles for a Control: | • | Roles defined against Controls on Templates will be copied (not inherited) when that Template is used on a Worksheet. | | • | If Roles are defined against an operation, the User must have at least one of the specified Roles to see that particular operation. They must ALSO have permissions to execute the operation based on the Worksheet privileges. | | • | If the roles are defined against the "Activate Operation", and the user does not have the appropriate Role, then the "F2" (or double-click) method of activating the control will be disabled. |
|