Activity Stream
An Activity Stream is a user interface component that displays an event-based (historical) list of actions performed by an application end-user in SAMM. Additionally, the Activity Stream interface in SAMM provides end-users with the ability to enter comments and track their communication in the same stream.
Contents
- 1 Example
- 2 Activity Attributes
- 3 Attribute Selection Criteria
- 4 Filtering Activity Streams
- 5 Notifying Users
- 6 Business Rules
- 7 UI Design Specifications
- 8 Activity Stream Inventory
- 9 Tracked Activities
- 9.1 Afloat M&R
- 9.2 Ashore M&R
- 9.2.1 Availabilities / Availability Details
- 9.2.2 Availabilities / Work Item Details
- 9.2.3 Availabilities / Work Package/Service Order Details
- 9.2.4 Library Items / Details Dialog
- 9.2.5 PMIA / Main Interface
- 9.2.6 PM Details
- 9.2.7 TransAlt Ship / Complete TransAlt
- 9.2.8 TransAlt Ship / TransAlt Details
- 9.2.9 VRRs / Repair Details
- 9.3 Admin
- 9.4 SMS
- 9.5 Universal
Example
Activity Attributes
Example/Anatomy | Attribute Name | Definition | Mandatory | Attribute Values | Notes |
---|---|---|---|---|---|
![]() | |||||
Category / Sub-category |
|
Yes | Categories will be displayed on the front-end as icons with tooltips (Alt Text) that show the category name. | ||
Author | Describes the completion or final action in a process. | Yes |
|
-- | |
Action | Action taken by the user. | Yes |
|
Action value will depend on the activity category. | |
Subject | Refers to the object that action is being performed on. | Yes |
|
-- | |
Location | Refers to the vessel that the Activity was performed against | No |
See Attribute Selection Criteria |
Displayed as a Pill. Use Row ID | |
Activity Description | Description of the activities that were performed in a a specific instance. | Yes | See Attribute Selection Criteria | -- | |
Date Time Stamp | Date and time in which the activity was performed in | Yes | [YYYY-MM-DD HH:MM] See Attribute Selection Criteria |
-- |
Attribute Selection Criteria
The Criteria below provides guidance on how to select the appropriate value or display for each attribute associated with an activity:
Category / Sub-category
- Each activity will fit within one of 5 main categories, based on the nature of the action that was taken.
- Within each category there are sub-categories which add a greater specificity to the action that was taken. Each category will have a default/generic sub-category that will be assigned to each activity in the event that a specific sub-category hasn't been assigned.
Author
Attribute Value | Selection Criteria |
---|---|
Autogenerated based on the user that is logged in, and displayed as [Last Name, First Name] |
|
Action
Attribute Value | Selection Criteria |
---|---|
"created" |
|
"entered" |
|
"updated" |
|
"sent" |
|
Subject
Subject Title | Selection Criteria |
---|---|
[Details Screen Title] |
|
[Sub-Category Name] |
|
Location
Attribute Value | Selection Criteria |
---|---|
[Vessel] Pill |
|
Description
Date Timestamp
Atribute Value | Selection Criteria |
---|---|
Value is auto generated in the [YYYYY-MM-DD HH:MM] format. |
|
Filtering Activity Streams
Activity streams can be filtered based on their attributes:
- View (Can be multi-select)
- Category (Attribute)
- Sub-Category (Attribute)
Notifying Users
When adding a comment, users can notify others by typing in the person's name and selecting it from a menu. The desired user will be added to the "Notify Users" input in the form of a pill with a remove icon. Multiple names will be separates by semicolons.
Example
Animation
Business Rules
General Rules
- Activity Streams in SAMM are specific to the activity performed on a selected item.
- Interface shall be the same for both 1.0 and 2.0 frameworks.
Sorting
- Activity Stream will be sorted in descending order, where the most recent activity is displayed at the top, and the most recent activity is scrolled into view.
Implementation Strategy
- Existing Activity events will all be placed under the "Update" category.
- Implementation of new Activity events will reflect the new category / sub-category distinction.
UI Design Specifications
http://www.emprisecorporation.com/dev/samm-documentation/#activity-stream
Activity Stream Inventory
Module | Sub-Module | Link | Design Framework (Old/New) |
---|---|---|---|
Afloat M&R | Corrective Maintenance | New | |
Ashore M&R | Availabilities | Old | |
Ashore M&R | Library Items | Old | |
Ashore M&R | TransAlt Ship | Old | |
Ashore M&R | VRRs | Old | |
Admin | Feedback | New | |
Admin | Task Manager | Old | |
Admin | TransAlt-PM | Old | |
SMS | Findings | Old |
Tracked Activities
Afloat M&R
Corrective Maintenance / Repair Details
The Corrective Maintenance activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Repair | Creation | Creation | Includes:
|
Vessel | Update | Details | |
Title | Update | Details | |
Repair No. | Update | Details | |
Status | Update | Details | |
Priority | Update | Details | |
RAC | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Equipment Addition, Removal, Import | Update | Equipment/Parts | |
Parts Addition, Removal, Import | Update | Equipment/Parts | |
MCode Addition or Subtraction | Update | Details | Takes place when a user clicks on the Maintenance button in Shipboard info and associates Maintenance to the repair. Added MCodes will show up in the Equipment Tab > Maintenance Completion secondary tab. |
MOR Creation | Creation | Creation | Display Order Id (From Order Dropdown) |
MOR Submission to CMLS | Completion | Completion Details | Display the Order Id (From Order Dropdown) |
Shoreside Status | Update | Details | |
PE Comments | Comments | PE Comments | |
Change of type (Work Request to SFWL or VRR)/ExternalID Change | Update | Details | |
Shipboard Status | Update | Details | |
Disposition | Update | Details | |
FORAC | Update | Details | |
Close Out Notes | Completion | Completion Details | |
Convert To SFWL | Update | Details | Takes Place when a User clicks the Convert to SFWL button, and the VRR is converted to a SFWL |
Ashore M&R
Availabilities / Availability Details
The Availability details screen Activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of Availability | Creation | Creation | Includes:
|
Vessel | Update | Details | |
Availability Type | Update | Details | |
Port Engineer | Update | Details | |
Scheduled Start Date | Update | Details | |
Scheduled End Date | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Availabilities / Work Item Details
The Availabilities Work Item activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Work Item | Creation | Creation | Includes:
|
Vessel | Update | Details | |
Title | Update | Details | |
SWBS | Update | Details | |
Status | Update | Details |
|
RAC | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Specification Uploaded or Deleted | Update | Details | Will display the File Name |
Equipment Addition, Removal, Import | Update | Equipment/Parts | |
Parts Addition, Removal, Import | Update | Equipment/Parts | |
MCode Addition or Subtraction | Update | Details | Takes place when a user clicks on the Maintenance button in Shipboard info and associates Maintenance to the repair. |
MOR Creation | Creation | Creation | Display Order Id (From Order Dropdown) |
MOR Submission to CMLS | Completion | Completion Details | Display the Order Id (From Order Dropdown) |
Line Item Addition or Removal | Update | Details | |
Funding | Update | Details | |
Estimates Uploaded or Deleted | Update | Details | Will display the file name. |
Availability | Update | Details | Includes:
|
Work Package | Update | Details | Includes:
|
Deferral Reason | Update | Details | Only displays if WI has been Deferred. Reasons Include:
|
Availabilities / Work Package/Service Order Details
Tracked Activities will display based on the Contract Type; Work Package or Service Order:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of Work Package/Service Order | Creation | Creation | Includes:
|
Contract Type | Update | Details | |
Contract/P.O. No. | Update | Details | |
S.O. No. | Update | Details | Only for Service Order Contract Types |
S.O. Title | Update | Details | Only for Service Order Contract Types |
Status | Update | Details |
|
Port Engineer | Update | Details | Updated at Availability level |
Scheduled Start Date | Update | Details | |
Scheduled End Date | Update | Details | |
Project Code | Update | Details | |
Task Code | Update | Details | |
Funding Code | Update | Details | |
Specification Uploaded or Deleted | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Estimates Uploaded or Deleted | Update | Details | Will display the File Name. |
Availability | Update | Details | Includes:
|
Work Package (For Service Orders) | Update | Details | Includes:
|
Deferral Reason | Update | Details | Only displays if SO has been Deferred. Reasons Include:
|
Library Items / Details Dialog
The Library Items Details Dialog activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Library Item | Creation | Creation | Includes:
|
Item Type | Update | Details | |
Title | Update | Details | |
SWBS | Update | Details | |
WI # | Update | Details | |
RAC | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Applicable Vessels Addition or Removal | Update | Details | |
Specification Uploaded or Deleted | Update | Details | Will display the File Name |
Equipment Addition, Removal, Import | Update | Equipment/Parts | |
Parts Addition, Removal, Import | Update | Equipment/Parts | |
MCode Addition or Subtraction | Update | Details | Takes place when a user clicks on the Maintenance button in Shipboard info and associates Maintenance to the repair. |
MOR Creation | Creation | Creation | Display Order Id (From Order Dropdown) |
MOR Submission to CMLS | Completion | Completion Details | Display the Order Id (From Order Dropdown) |
Line Item Addition or Removal | Update | Details | |
Funding | Update | Details | |
Estimate | Update | Details |
PMIA / Main Interface
The Activity Tab in the details section of the PMIA main interface will track the following (note this is based off of the Service Order details screen):
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Service Order | Creation | Creation | Includes:
|
Vessel | Update | Details | |
Title | Update | Details | |
SWBS | Update | Details | |
Service Order Number | Update | Details | |
RAC | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Specification Uploaded or Deleted | Update | Details | Will display the File Name |
Equipment Addition, Removal, Import | Update | Equipment/Parts | |
Parts Addition, Removal, Import | Update | Equipment/Parts | |
MCode Addition or Subtraction | Update | Details | Takes place when a user clicks on the Maintenance button in Shipboard info and associates Maintenance to the repair. |
MOR Creation | Creation | Creation | Display Order Id (From Order Dropdown) |
MOR Submission to CMLS | Completion | Completion Details | Display the Order Id (From Order Dropdown) |
Line Item Add or Remove | Update | Details | |
Funding | Update | Details | |
Estimate | Update | Details |
PM Details
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of Planned Maintenance | Creation | Creation | Includes
|
Completion of Planned Maintenance | Completion | Completion | Includes
|
Status | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Equipment Addition, Removal, Import | Update | Equipment/Parts | |
Parts Addition, Removal, Import | Update | Equipment/Parts | |
Schedule Addition, Edit, Removal | Update | Details | Includes
|
User Notes | Comments | User Notes | |
History Removal | Update | Details | Includes
|
VTL Documents Addition, Removal | Update | Details | Will display the file names |
Deferral Reason | Update | Details | Only displays if WI has been Deferred. Reasons Include:
|
TransAlt Ship / Complete TransAlt
The TransAlt Ship activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Completion of a TransAlt | Completion | Completion | Includes:
|
Availability | Update | Details | |
WP / SO | Update | Details | |
Work Item | Update | Details | |
Attachments Upload, Import, Delete | Update | Details | Will display the File Names |
Associate SFWL Addition or Removal | Update | Details | |
PE Comments | Comments | PE Comments | |
SF Comments | Comments | SF Comments | |
Completion Form Remove | Update | Details | |
FORAC | Update | Details | |
TransAlt Ship / TransAlt Details
The TransAlt Ship activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a TransAlt | Creation | Creation | Includes:
|
Creation of a Service Request | Creation | Creation | Includes:
|
Disassociation of a TransAlt | Update | Details | Includes:
|
General Tab | Update | Details | All Field changes within the General Section of the General Tab. |
SF Comments | Comments | SF Comments | |
Attachments Upload, Import, Delete | Update | Details | Will display the File Names |
Progress Update | Update | Details | |
Vote Change | Update | Details | |
Removal of a user from FORAC | Update | Details | |
Removal of a user from the Vote Table | Update | Details | |
Weight & Moment | Update | Details | Includes:
|
Weight & Moment Line Item | Update | Details | The addition or removal of an item |
Weight & Moment Status | Update | Details | List old then new Status |
Related Items | Update | Details | The addition or removal of an item |
VRRs / Repair Details
The VRRs activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Repair | Creation | Creation | Includes:
|
Vessel | Update | Details | |
Title | Update | Details | |
Repair No. | Update | Details | |
Status | Update | Details | |
Priority | Update | Details | |
RAC | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Equipment Addition, Removal, Import | Update | Equipment/Parts | |
Parts Addition, Removal, Import | Update | Equipment/Parts | |
MCode Addition or Subtraction | Update | Details | Takes place when a user clicks on the Maintenance button in Shipboard info and associates Maintenance to the repair. Added MCodes will show up in the Equipment Tab > Maintenance Completion secondary tab. |
MOR Creation | Creation | Creation | Display Order Id (From Order Dropdown) |
MOR Submission to CMLS | Completion | Completion Details | Display the Order Id (From Order Dropdown) |
Shoreside Status | Update | Details | |
PE Comments | Comments | PE Comments | |
Change of type (Work Request to SFWL or VRR)/ExternalID Change | Update | Details | |
Shipboard Status | Update | Details | |
Disposition | Update | Details | |
FORAC | Update | Details | |
Close Out Notes | Completion | Completion Details | |
Convert To SFWL | Update | Details | Takes Place when a User clicks the Convert to SFWL button, and the VRR is converted to a SFWL |
Admin
Feedback Management / Feedback Details
The Feedback activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Feedback | Creation | Creation | Includes:
|
General Tab | Update | Details |
|
Equipment Tab: Addition/Removal | Update | Equipment/Parts | |
Proposal Tab: Add/Revise | Update | Details | Will display the Revision Comments. |
Attachments Tab: Upload, Import, Delete | Update | Details | Will display the File Names. |
Related Items | Update | Details | The addition or removal of an item. |
Email Details | |||
Comments | Comments | Comments | Entered via Activity Tab or Quick Edit. |
Task Manager / Service Request Details
The Task Manager activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Service Request | Creation | Creation | Creation of a New Request is tracked in the parent TransAlt's Activity Tab.
|
Title | Update | Details | |
Vessel | Update | Details | |
Status | Update | Details | |
Priority | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
SF Comments | Comment | SF Comments | |
Vote | Update | Details | |
Progress Update | Update | Details | Includes
|
Task Disassociation | Update | Details |
Includes:
|
TransAlt-PM / TransAlt Details
The TransAlt-PM activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a TransAlt | Creation | Creation | Includes:
|
Creation of a Service Request | Creation | Creation | Includes:
|
Disassociation of a TransAlt | Update | Details | Includes:
|
General Tab | Update | Details | All Field changes within the General Section of the General Tab. |
SF Comments | Comments | SF Comments | |
Attachments Upload, Import, Delete | Update | Details | Will display the File Names |
Related Items | Update | Details | The addition or removal of an item. |
Progress Update | Update | Details | |
Vote Change | Update | Details | |
SMS
SMS Finding / Finding Details
The SMS Finding activity tab will track the following:
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Finding | Update | Details | - |
Requirement | Update | Details | - |
Severity | Update | Details | - |
Initiated By | Update | Details | - |
Status | Update | Details | - |
Date | Update | Details |
|
Universal
Repair Details
Tracked Activity | Category | Sub-Category | Notes |
---|---|---|---|
Creation of a Repair | Creation | Creation | Includes:
|
Vessel | Update | Details | |
Title | Update | Details | |
Repair No. | Update | Details | |
Status | Update | Details | |
Priority | Update | Details | |
RAC | Update | Details | |
Attachments Uploaded or Deleted | Update | Details | Will display the File Names |
Equipment Addition, Removal, Import | Update | Equipment/Parts | |
Parts Addition, Removal, Import | Update | Equipment/Parts | |
MCode Addition or Subtraction | Update | Details | Takes place when a user clicks on the Maintenance button in Shipboard info and associates Maintenance to the repair. Added MCodes will show up in the Equipment Tab > Maintenance Completion secondary tab. |
MOR Creation | Creation | Creation | Display Order Id (From Order Dropdown) |
MOR Submission to CMLS | Completion | Completion Details | Display the Order Id (From Order Dropdown) |
Shoreside Status | Update | Details | |
PE Comments | Comments | PE Comments | |
Change of type (Work Request to SFWL or VRR)/ExternalID Change | Update | Details | |
Shipboard Status | Update | Details | |
Disposition | Update | Details | |
FORAC | Update | Details | |
Close Out Notes | Completion | Completion Details | |
Convert To SFWL | Update | Details | Takes Place when a User clicks the Convert to SFWL button, and the VRR is converted to a SFWL |