SIP - Procedure Builder
From Emprise Wiki
Contents
- 1 Overview
- 2 Main Toolbar
- 3 Widget Selection Panel
- 4 Procedure Table
- 5 Widget Properties
- 5.1 Empty Widget Properties Pane
- 5.2 Single Attachment Entry
- 5.3 Multiple Attachment Entry
- 5.4 Checkbox
- 5.5 Container Widget
- 5.6 Container Section
- 5.7 Date
- 5.8 Date & Time
- 5.9 Drop Down Text Selection
- 5.10 Feet Inch
- 5.11 Grid Layout Widget
- 5.12 Header
- 5.13 Image
- 5.14 Major Section
- 5.15 Minor Section
- 5.16 Multi Line Text Entry
- 5.17 Numeric Value Entry
- 5.18 Text Box Prompt
- 5.19 Reference Widget
- 5.20 Reference Section
- 5.21 Single Line Text Entry
- 5.22 Text
- 5.23 Time
- 6 Features
- 7 Panel Configurations
- 8 Additional Links
Overview
TOMI's procedure builder interface provides end-users with the ability to create a procedure via an intuitive drag-and-drop front end interface.
The procedure builder interface is made up of four major functional areas:
- Main Toolbar
- Widget Selection Panel
- Procedure Table
- Widget Properties
Main Toolbar
The main toolbar provides the end user with the ability to:
- Edit a procedure title.
- Preview the procedure.
Edit Procedure Details
Note: For additional procedure type properties options, click here.
Widget Selection Panel
The Widget Selection Panel is made up of is a collapsible panel fixed to the left side of the procedure builder interface. Within this panel there are widgets, organized by category, that can be dragged into the procedure table area in order to build a procedure. Widgets will fit within one of three categories:
- Static - Widgets that display data to the user but don't provide data entry capabilities.
- Data Entry - Widgets that require data entry by the end-user.
Widgets
| Widget Selection Panel | Widget Type | Definition | Data Entry | Attributes |
|---|---|---|---|---|
| ||||
| Single Attachment Entry | Provides an interface to attach a single attachment. | Yes |
| |
| Multiple Attachment Entry | Provides an interface to attach multiple attachments. | Yes |
| |
| Checkbox | Provides a True/False Yes/No type check box interface | Yes |
| |
| Container Widget | Provides a reference to external procedure widgets | Yes |
| |
| Container Section | Provides a reference to external procedure widgets | Yes |
| |
| Date | Provides a date entry interface | Yes |
| |
| Date Time | Provides a date and time entry interface | Yes |
| |
| Feet Inch | Provides an interface for the entry of feet and inch | Yes |
| |
| Grid Layout | Provides a grid for the ease of input for multiple lines of the same type of data | Yes |
| |
| Header | Display of a Procedure's title | No |
| |
| Image | Displays an image | No |
| |
| Major Section | NULL | No |
| |
| Minor Section | NULL | No |
| |
| Multi Line Text Entry | Provides a multi-line text entry interface | Yes |
| |
| Numeric Value Entry | Provides a numeric entry interface | Yes |
| |
| Text Box Prompt | NULL | No |
| |
| Drop Down Text Selection | NULL | Yes |
| |
| Single Line Text Entry | Provides a single line text entry interface | Yes |
| |
| Text | NULL | No |
| |
| Time | Provides a time entry interface | Yes |
|
Procedure Table
The procedure table is made up of the widgets that have been dragged and dropped (into the procedure table area) by the end-user.
The display of each widget will be made up of the following elements:
- Drag Icon - Provides the ability for the user to drag and re-organize widgets within a procedure.
- Widget Icon - Provides a quick visual representation of the widget for quick recognition.
- Contextual Attribute - Provides the user with contextual information of the widget within the procedure. NOTE: This label will vary based on the Widget type's available attributes.
- Widget Type - Displays the widget type to reinforce the Widget logo
- Properties Icon - Clicking on this icon will open the Widget Properties panel for the corresponding widget.
- Duplicate - Will duplicate the widget and its properties. Duplicated widgets will appear immediately below the widget that was acted on.
- Remove - Will remove the widget from the procedure.
Widget Contextual Attributes
The table below illustrates the Widget Type attributes that will be pulled to fill in the "Contextual Attribute" for each widget type when displaying a widget in the procedure table.
| Widget Type | Attribute(s) |
|---|---|
| Single Attachment Entry | Label |
| Multiple Attachment Entry | Label |
| Checkbox | Label |
| Container Widget | |
| Container Section | |
| Date | Label |
| Date Time | Label |
| Feet Inch | Label |
| Header | Label |
| Image | If no Label is added, use "Image" |
| Major Section | Label & Text - Truncate text if it exceeds spacing requirements |
| Minor Section | Label & Text - Truncate text if it exceeds spacing requirements |
| Multi Line Text Entry | Label |
| Numeric Value Entry | Label |
| Text Box Prompt | Text |
| Drop Down Text Selection | Label |
| Sigle Line Text Entry | Label |
| Text | Text - Truncate text if it exceeds spacing requirements |
| Time | Label |
Widget Properties
The Widget Properties panel provides the end user with the ability to configure the selected widget in the procedure table.
- Once the user has clicked the "Save" button, the widget configuration will be saved.
- Once the widget configuration has been saved, users may select a different widget from the procedure table, and the Widget Properties panel will load the properties for the selected widget (based on the widget types attributes).
- If a widget's properties have been updated but have not yet been Save, and the user clicks on a different widget in the procedure table, they will be presented with a prompt dialog to ensure that no unsaved changes are lost. See http://wiki.emprisecorporation.com/index.php/TOMI_-_Procedure_Builder#Unsaved_Changes_Dialog
- The hint field in the widget properties panel will become mandatory when a regular expression is selected for validation. This will inform the end user of the expected input entry format for error prevention.
Empty Widget Properties Pane
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| -- | -- | -- | -- | -- | -- | |
| -- | -- | -- | -- | -- | -- | |
| -- | -- | -- | -- | -- | -- | |
| -- | -- | -- | -- | -- | -- | |
| -- | -- | -- | -- | -- | -- | |
| -- | -- | -- | -- | -- | -- | |
Single Attachment Entry
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Supported File Types | Dropdown - Multi-select | Yes | See File Type Documentation | -- | -- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Multiple Attachment Entry
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Supported File Types | Dropdown - Multi-select | Yes | See File Type Documentation | -- | -- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Checkbox
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Container Widget
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Widget | Ellipsis - Single-Select | Yes |
|
|
-- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Container Section
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Procedure Name | Ellipsis - Single Selection | No | Will display a list of existing Maintenance Procedures that the user has access to. | 
|
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Widgets | Add/Remove Button | Yes | Will display widgets from the selected Maintenance Procedure. | 
|
| |
| Container Widget Text Properties | Multi-Line Text entry - Read Only | No | -- | -- | This text area will display the text properties from the selected widget in the Widgets section. | |
| Clear | Button | -- | -- | 
|
| |
Date
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Date & Time
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Drop Down Text Selection
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Options | Multi-Line Text entry | No | -- | -- | Each line in the text entry represents a dropdown value option. | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Feet Inch
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Regular Expression | Dropdown - Single Selection | No |
|
|
-- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Grid Layout Widget
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Data Entry | Radio Buttons | Yes |
|
-- | Determines if data in the grid will be entered top to bottom or left to right. | |
| Number of Minor Sections | Numeric Entry | Yes | -- | -- |
| |
| Number of Rows | Numeric Entry | Yes | -- | -- |
| |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Header
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Image
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Select Image | Ellipsis - Single Select | Yes | -- | System Dialog | -- | |
| Text | Single Line Text entry | Yes | -- | -- | -- | |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Major Section
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Text | Single Line Text entry | Yes | -- | -- | -- | |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Minor Section
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Text | Single Line Text entry | Yes | -- | -- | -- | |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Multi Line Text Entry
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Regular Expression | Dropdown - Single Selection | No |
|
|
-- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Numeric Value Entry
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Regular Expression | Dropdown - Single Selection | No |
|
|
| |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Text Box Prompt
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Text | Multi-Line Text entry | Yes | -- | -- | -- | |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Reference Widget
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Widget | Ellipsis - Single-Select | Yes |
|
|
-- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Reference Section
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Procedure Name | Ellipsis - Single Selection | No | Will display a list of existing Maintenance Procedures that the user has access to. |
|
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Widgets | Add/Remove Button | Yes | Will display widgets from the selected Maintenance Procedure. | 
|
| |
| Container Widget Text Properties | Multi-Line Text entry - Read Only | No | -- | -- | This text area will display the text properties from the selected widget in the Widgets section. | |
| Clear | Button | -- | -- | 
|
| |
Single Line Text Entry
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- |
| |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Regular Expression | Dropdown - Single Selection | No |
|
|
-- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- |
| |
Text
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Text | Multi-Line Text entry | Yes | -- |
|
| |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Time
| Example | Properties | |||||
|---|---|---|---|---|---|---|
|
Input Name | Input Type | Required | Domain Data | Emerging Screens | Notes |
| Widget Type | Static Image & Read-Only Text | No | -- | -- | Image corresponds with widget type | |
| Label | Single Line Text entry | Yes | -- | -- | -- | |
| Hint | Single Line Text entry | No | -- | -- | -- | |
| Required | Dropdown | Yes |
|
NOTE: Conditional option will remain disabled (but visible) until implemented.
|
| |
| Include in Test Plan | Checkbox | No | -- | -- | Only available for "Test Plan" type Procedures | |
Features
Blank Canvas State
When a user creates a new procedure and enters the procedure builder for the first time, the interface will be in a "Blank Canvas" state.
- The interface will prompt the user to begin by dragging a widget (from the widget panel) into the procedure table area.
Widget Selection - From Blank Canvas
Widget Selection - Existing Procedure
Widget Reordering
Widgets within the procedure table can be re-organized by clicking on the "Drag" icon to the left of the digter, and dragging the widget to the desired location. A blue indicate will appear, denoting the where the widget will be placed in the procedure, based on the mouse's location.
Panel Configurations
All Panels Collapsed
Widget Selection Expanded
Widget Properties Expanded
Widget Selection Collapsed + Properties Panel Expanded
Unsaved Changes Dialog
A user will be presented with an "Unsaved Changes" Dialog if they have entered data into the widget properties panel and click on another row, or add another widget.
Additional Links
Interactive Prototype
https://xd.adobe.com/view/afc583f1-803b-4b2b-5342-8234d20ad286-d9f4/
Bluescape
N/A
