SIP - Procedures

Overview

The Procedures tab provides an interface in which end-users can create, view, and approve procedures based on their application role. Application roles for this interface are the following:

• Procedure Editor - Regular user, who is creating a procedure and submitting it for approval.
• Procedure Approver (Admin role) - Admin user who will view submitted procedures and will approve or deny.

The user's role will determine the features and controls that are available in order to successfully complete tasks.

Main Interface

Display Inactive

Hide Inactive

• Users may hide or display inactive procedures by using the filter dropdown, on the main grid toolbar.

Row Details

• Rows on the grid can be expanded to show secondary details pertaining to the respective row. Details available are the following:
  • The name of the procedure creator
  • The name of the procedure approver (if the procedure has a status of Approved)
  • Comments (Editable by all roles)

Row Details - Add Comments

• Users may update comments for each procedure by clicking on "Edit." Upon clicking on the Edit control, an modal dialog in which comments can be added will be displayed.

Filter

• Creator and Approver roles will default to displaying all Procedure Statuses and Procedure Types.

Adding a Procedure

• When clicking on the "ADD NEW" button, the end-user will be presented with an Add Procedure Dialog. Upon successful completion and submission of the information in the Add Procedure dialog, the user will be taken to the Procedure Builder Interface in a "blank canvas" state as seen here: http://wiki.emprisecorporation.com/index.php/TOMI_-_Procedure_Builder#Blank_Canvas_State .

In the Add Procedure dialog the user will enter the following information:

• Procedure Title
  • 128 Characters
• Procedure Type
  • Available Procedure Types are outlined in the table below:

Procedure Types / Procedure Properties Dialogs

• When Editing Procedure Properties, an additional dropdown field labelled "Preview Widget" will be available to allow the user to select which widget data shall appear in the Preview column in Inspection Planning.
  • This is available for all procedure types, except for Reference.

Procedure Type / Definition	Procedure Properties Dialog	Business Rules
Deficiency A short procedure which documents a deficiency and has the additional attribute of Deficiency Type. Deficiency Types can be associated with any other procedure type.		Selecting "Deficiency" In the Procedure Type dropdown will bring up another dropdown in which the user will be able to select a Deficiency Type. Field Name Field Type Field Options Notes Procedure Title Single Line Text Input - Disabled after Approval Procedure Type Dropdown Selection Administrative Deficiency Maintenance Reference Test Plan Disabled after Approval Deficiency Type Dropdown Selection Administrative Corrosion Feedback General Hull Inspection PEVI Port Engineer Inspection SMART Editable before and after Approval Feedback type shall auto-generate a Feedback record in SAMM upon completion
Maintenance Procedure A procedure which is tied to an MCODE or MaintenanceProcedureId and therefore eventually tied to a Task Code.		Selecting "Maintenance" In the Procedure Type dropdown will bring up additional selection inputs: Inspection Area, Inspection Type(s), and Deficiency Type(s). Procedure Title Field: Disabled after Approval Procedure Type Field: Disabled after Approval Inspection Area Field: Editable before and after Approval Inspection Type(s) Field: Editable before and after Approval, Allows selection of Multiple Items Deficiency Type(s) Field: Editable before and after Approval, Allows selection of Multiple Items Ellipsis/Bucket Business Rules: Bucket Selection Input Field Domain Data After Selection All Items Selected All Items Selected Multiple (But Not All) Items Selected Multiple Items Selected One Item Selected Item Name
Administrative Procedure Used for admin purposes only and therefore never tied to a Task Code. These can be used for SAMM installations etc. When Editing Procedure Properties, an additional dropdown field labelled "Preview Widget" will be available to allow the user to select which data shall appear in the Preview column in Inspection Planning.		Procedure Title Field: Disabled after Approval Procedure Type Field: Disabled after Approval
Reference --		Procedure Title Field: Disabled after Approval Procedure Type Field: Disabled after Approval
Test Plan The same as a Maintenance Procedure but can contain Maintenance Procedure widgets in a Widget Type "Container" At design time the user would add a container widget and the system would allow for the association of a maintenance procedures widget. At execution time the database will insert all active maintenance procedure widgets at the task code level associating the appropriate equipment id values. This allows for varying equipment id values for the same equipment across vessels as well as allowing the development of Test Plans prior to procedure task code assignment.		Selecting "Test Plan" In the Procedure Type dropdown will bring up additional selection inputs: Inspection Area, Inspection Type(s), and Deficiency Type(s). Procedure Title Field: Disabled after Approval Procedure Type Field: Disabled after Approval Inspection Area Field: Editable before and after Approval Inspection Type(s) Field: Editable before and after Approval, Allows selection of Multiple Items Deficiency Type(s) Field: Editable before and after Approval, Allows selection of Multiple Items Ellipsis/Bucket Business Rules: Bucket Selection Input Field Domain Data After Selection All Items Selected All Items Selected Multiple (But Not All) Items Selected Multiple Items Selected One Item Selected Item Name

Inspection Type(s) Selection

Deficiency Type(s) Selection

Blank Canvas State / No Data to Display

Specifications

• Message should be centered both vertically and horizontally in the Grid area

Element Specification

Main Grid Toolbar Design Specification

Main Grid Toolbar Anatomy

• Grid Title - Provides the end-user with a contextual title pertaining to the grid that they are viewing.
• Row Count - Provides the end-user with a count of the results being displayed on the grid in an X of y format, where x is the amount of rows currently being displayed, and y is the total number of rows associated with the query.
• Grid Refresh - Provides the end-user with a way to refresh the grid data.
• View All - Provides the end-user with a way to display all records and when clicked and will update the Row Counter accordingly.
• Live Search - Live Search provides end-users with the ability to perform a text search that applies to the procedure titles on the grid.
• Filter Button - Provides the end-user with a control to open the Filter interface. Additionally, the Filter button will provide a count of all of the filters that are currently applied.
• Add New Button - Clicking on the Add New button will bring the end-user to the "Procedure Builder" interface in the blank canvas state, where they will then build the procedure as seen in: http://wiki.emprisecorporation.com/index.php/TOMI_-_Procedure_Builder#Blank_Canvas_State

Row Anatomy

• Expand/Collapse Icon - Clicking on the Expand/Collapse icon will display or hide additional details for the selected row. This feature is available for all user roles.

• Procedure Title - The procedure title will be displayed on the grid for all user roles.

• Status Pill The status pill will indicate the procedure status. Available statuses will be:
  • Draft
  • Submitted
  • Approved

• Role-Specific Actions - End users will be able to perform actions on the selected procedure based on their user role and the procedure's status.

Row State	Example	Notes
Normal		N/A
Hover		N/A
Selected		N/A
Inactive		Inactive rows can be toggled on and off from within the filter dropdown.

Actions

There will be a single Actions menu in which actions will be enabled or disabled based on the business rules below:

Business Rules

• With each row the database will return both the Editor and Approver attribute. Each will be true or false 1 or 0.
  • All users can always perform the actions “PREVIEW” and “DUPLICATE”.
  • A procedure can only be “ACTIVATE” or “DEACTIVATE” if Editor is True and the status is “Draft”
  • A user can “SUBMIT” a procedure if Editor is true and the status is “Draft”.
  • A user can Approve or Deny a procedure if Approver is true and status is “Submitted”.
  • A User can also Deny a procedure if Editor is true and status is “Submitted”

The table below defines each action by status and user role:

Action	Behavior	Display in Draft Status	Display in Submitted Status	Display in Approved Status	Display when Inactive	Applicable Roles	Notes
Preview	Opens the Procedure Previewer in a new tab.	Enabled	Enabled	Enabled	Enabled	Editor Approver
Edit...	Opens the Procedure Builder interface (in the same tab) and loads the procedure configuration that was last saved.	Enabled	Disabled	Disabled	Disabled	Editor
Procedure Properties...	Opens the Procedure Properties Dialog.	Enabled	Disabled	Enabled	Disabled	Editor
Duplicate	Duplicates the selected procedure right below it, with "- Copy" appended to the procedure name.	Enabled	Enabled	Enabled	Enabled	Editor
Validate Procedure...	Checks the procedure for issues and displays one of two dialogs (seen here) based on the outcome.	Enabled	Enabled	Enabled	Enabled	Editor
Activate	Activates an inactive procedure.				Enabled	Editor Approver	If The procedure state is already set to "Active" this option will be disabled in the menu.
Deactivate	Makes an active procedure inactive. The inactive procedure will then be hidden or displayed on the grid based on settings set forth on the main grid toolbar.				Disabled	Editor Approver
Submit	Submits the selected procedure for an approver to review, and approve. Submitted procedures will no longer be editable by the Creator. The status pill will show a status of "Submitted."	Enabled	Disabled	Disabled	Disabled	Editor
Approve	When an approver approves a procedure, it will be tied to an MCode, and eventually be linked to an equipment Id and will then become a Task Code - This process will take place in SAMM (MML). The procedure status will change to "Approved."	Disabled	Enabled	Disabled	Disabled	Approver
Deny	When an approver denies a procedure, it will be sent back to the creator, where it will go back to Draft status.	Disabled	Enabled	Disabled	Disabled	Editor Approver

Procedure Properties

Validate Procedure

Validation Outcome	Emerging Dialog	Notes
No Issues Detected
Issues Detected		If the error details exceeds the length of the text area, a scrollbar will be utilized.

Approve Procedure

Deny Procedure

Design Specification

Submit Procedure - Error

If a user attempts to Submit a procedure and any of it's widgets' required attributes are incomplete, the following message will be displayed:

Interactive Prototype & Production Assets

https://xd.adobe.com/view/afc583f1-803b-4b2b-5342-8234d20ad286-d9f4/screen/a53fe697-22c7-457c-bea9-465fdcd59db1/TOMI-Web-My-Procedures-Option-2