Activity Stream

From Emprise Wiki
Jump to: navigation, search

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.

Example

Activity Stream-Example.png

Activity Attributes

Example/Anatomy Attribute Name Definition Mandatory Attribute Values Notes
Activity Stream-Anatomy of an Activity.png
Category / Sub-category
  • A category is a major functional grouping in which an activity is placed. Each activity can be placed within one of four main activity categories.
    • Within each category there are sub-categories which add a greater specificity to the action the action 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.
Yes
  • Icon - Add.png - Creation
  • Icon - Update.png - Update
  • Icon - Comments.png - Comment
  • Icon - Completion.png - Completion
  • Icon - Email.png - Email

See Attribute Selection Criteria

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
  • [Last Name, First Name] of user who performed the activity

See Attribute Selection Criteria

--
Action Action taken by the user. Yes
  • created
  • entered
  • updated
  • sent

See Attribute Selection Criteria

Action value will depend on the activity category.
Subject Refers to the object that action is being performed on. Yes
  • [Details Screen Title]
  • [Sub-category]


See Attribute Selection Criteria

--
Location Refers to the vessel that the Activity was performed against No
  • [Vessel Name]

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.

Activity Stream-Anatomy of an Activity-Category.png


Category Category Selection Criteria Sub-Category Sub-Category Selection Criteria Example
Comments
  • When comments are entered for the purpose of communication among multiple users.
Comments (Default/Generic)
  • This sub-category is to be used as a generic catch-all for comments, when no other specific sub-category is specified.
Activity Row - Entered Comments (Generic).png
SF Comments
  • Use this sub-category to indicate comments made by the ship force (Afloat).
Activity Row - Updated Comments.png
PE Comments
  • Use this sub-category when Port Engineer comments have been entered (Ashore).
Activity Row - Entered PE Comments.png
Administrative Comments
  • Use this sub-category when indicating that comments have been made by an administrator.
Activity Row - Entered Administrative Comments.png
Completion
  • When an item or task has been completed.
Completion Details (Default/Generic)
  • Catch-all subcategory for completion-related tasks.
Activity Row - Updated Completion Details.png
Creation
  • When any new major application item, made up of multiple components, is created. This includes:
    • Creation of an item that has an associated details screen.
Creation (Default/Generic)
  • Catch-all for all (tracked) fields entered at the time of the creation of an item.
Activity Row - Create.png
Email
  • When an email is sent using the detail's screen's "Send Email" controls.
Email (Default/Generic)
  • Used to indicate when an email has been sent from the end-user, using SAMM.
Activity Row - Sent Email.png
Update
  • When values within an existing item are entered, changed or removed.
Details (Default/Generic)
  • This sub-category is to be used as a generic catch-all for updates made on a screen, when no other specific sub-category is specified. This sub-category does not include updates to comments.
Activity Row - Updated Details.png
Admin Update
  • Used to indicate that an administrator has made an update to the a screen via the admin version of the screen.
Activity Row - Entered Admin Updates.png
Equipment/Parts
  • Used to indicate the addition/removal of Equipment or Parts to an Equipment.
Activity Row - Update Equipment-Parts.png

Author

Activity Stream-Anatomy of an Activity-Author.png


Attribute Value Selection Criteria
Autogenerated based on the user that is logged in, and displayed as [Last Name, First Name]
  • Always display this value.

Action

Activity Stream-Anatomy of an Activity-Action.png

Attribute Value Selection Criteria
"created"
  • Category is Creation.
"entered"
  • Category is Comment and a new value is entered into a control that was previously null.
  • Category is Completion and a new value is entered into a control that was previously null.
  • Category is Update and sub-category is Admin Updates.
"updated"
  • Category is Update and a value is changed when a previous value exists or there is a combination of previous values being null and existing.
  • Category is Comments and a value is changed when a previous value exists.
  • Category is Completion and a value is changed when previous value exists or there is a combination of previous values being null and existing.
"sent"
  • Category is Email

Subject

Activity Stream-Anatomy of an Activity-Subject.png

Subject Title Selection Criteria
[Details Screen Title]
  • Category is Creation.
[Sub-Category Name]
  • Use for all categories except Creation.

Location

Activity Stream-Anatomy of an Activity-Location.png

Attribute Value Selection Criteria
[Vessel] Pill
  • Category is Comments with a sub-category of PE Comments
  • Category is Comments with a sub-category of SF Comments

Description

Activity Stream-Anatomy of an Activity-Description.png

Description Display Selection Criteria Example
Display a bullet to indicate each change that is made or instance that is being tracked.
  • Always Use.
Activity Stream-Displaying Updated Previous Value.png
Display the previous value with a strike-through and the new value next to it.
  • Use if the Category is Update and a previous value is updated.
Activity_Stream-Displaying_Updated_Previous_Value.png

Display the previous comment with a strike-through and the new comment below it as a new bullet.

  • Use if the Category is Comments and an existing comment is updated.
Activity_Stream-Displaying_Updated_Previous_Value.png
Display only the new value next to the field title.
  • Use if a value is entered into a control that did not have any previous value(s).
Activity Stream-Displaying New Value.png
Display only the new comment.
  • Use if a comment is entered into a control that did not have any previous comment.
Activity Stream-Displaying New Value.png
Show the nulled value with a strike-through.
  • Use if a control is nulled.
Activity Stream-Displaying Nulled Value.png

Date Timestamp

Activity Stream-Anatomy of an Activity-Timestamp.png


Atribute Value Selection Criteria
Value is auto generated in the [YYYYY-MM-DD HH:MM] format.
  • This value will always be displayed.

Filtering Activity Streams

Activity streams can be filtered based on their attributes:

Dialog - Activity Stream View (Multiple).png


  • 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

Activity Stream-Example2.png

Animation

Activity Stream Notifications.gif

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:
  • Date Opened
  • Vessel
  • Title
  • Repair No.
  • Status
  • Priority
  • RAC
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
  • Availability Type
  • Port Engineer
  • Schedule Start Date
  • Scheduled End Date
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:
  • Date Opened
  • Vessel
  • Title
  • Availability
  • SWBS
  • RAC
Vessel Update Details
Title Update Details
SWBS Update Details
Status Update Details
  • If WI Status is changed, Old Status shall feature a strikethrough and New Status shall display next to it.
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:
  • Initial Availability Selected.
  • If WI is Deferred/Rescheduled, Old Availability shall feature a strikethrough and New Availability shall display next to it.
Work Package Update Details Includes:
  • Initial Work Package Selected.
  • If Work Package is Changed, Old WP shall feature a strikethrough and New WP shall display next to it.
Deferral Reason Update Details Only displays if WI has been Deferred. Reasons Include:
  • Inadequate facilities to complete this effort
  • Inadequate government information
  • Inadequate manpower to complete effort
  • Inadequate time to complete the effort
  • Lack of Funding
  • Lack of Material
  • Operational Changes

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/P.O. No.
  • S.O. No.
  • S.O. Title
  • Port Engineer
  • Scheduled Start Date
  • Scheduled End Date
  • Project Code
  • Task Code
  • Funding Code
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
  • If SO Status is changed, Old Status shall feature a strikethrough and New Status shall display next to it.
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:
  • Initial Availability Selected.
  • If SO is Deferred/Rescheduled, Old Availability shall feature a strikethrough and New Availability shall display next to it.
Work Package (For Service Orders) Update Details Includes:
  • Initial Work Package Selected.
  • If Work Package is Changed, Old WP shall feature a strikethrough and New WP shall display next to it.
Deferral Reason Update Details Only displays if SO has been Deferred. Reasons Include:
  • Inadequate facilities to complete this effort
  • Inadequate government information
  • Inadequate manpower to complete effort
  • Inadequate time to complete the effort
  • Lack of Funding
  • Lack of Material
  • Operational Changes

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:
  • Date Opened
  • Title
  • Item Type
  • SWBS.
  • WI #
  • RAC
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:
  • Date Opened
  • Vessel
  • Title
  • SWBS.
  • Service Order Number
  • RAC
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
  • Date Created
  • User Name
  • Procedure
  • Vessel
  • Equipment
  • Billet
  • Required By
  • Feedback
Completion of Planned Maintenance Completion Completion Includes
  • Completion Date
  • User Name
  • Meter
  • Act. Labor Hours
  • Attachments
  • Comments
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
  • Operational Status
  • Frequency
  • Periodicity
  • OR
  • Metered Maintenance
  • Metered Units
User Notes Comments User Notes
History Removal Update Details Includes
  • Port Engineer
VTL Documents Addition, Removal Update Details Will display the file names
Deferral Reason Update Details Only displays if WI has been Deferred. Reasons Include:
  • Inadequate facilities to complete this effort
  • Inadequate government information
  • Inadequate manpower to complete effort
  • Inadequate time to complete the effort
  • Lack of Funding
  • Lack of Material
  • Operational Changes

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:
  • Date Completed
  • Availability
  • WP / SO
  • Work Item
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
Email Email Email

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:
  • Date Created
  • Title
  • Status
  • Priority
  • Username
  • Comment
    • Generated from <VRR#> <VRR Title> on <ship name> when a User creates a TransAlt from VRRs
Creation of a Service Request Creation Creation Includes:
  • Date Opened
  • Task Id
  • Title
  • Username
  • Vessel
Disassociation of a TransAlt Update Details Includes:
  • Date Removed
  • Task Id
  • Title
  • Status
  • Username
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
Email Email Email
Weight & Moment Update Details Includes:
  • Username
  • Date
  • Vessel (Displayed in all caps)
  • Comments
  • Reset Baseline
    • Comments from Reset Baseline Modal
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:
  • Date Opened
  • Vessel
  • Title
  • Repair No.
  • Status
  • Priority
  • RAC
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:
  • Date Created
  • Subject
  • Email Address (created by)
  • Status
    • Entered via Feedback Creation or Quick Edit
  • Assigned
    • Entered via Feedback Creation or Quick Edit
  • Reason
    • Entered via Feedback Creation or Quick Edit
  • Scope
  • Vessel
  • Type
  • SME Category
  • Message
  • Equipment
  • Attachments
General Tab Update Details
  • All Field changes within the General Section of the General Tab.
    • Status: Entered via Details Screen or Quick Edit
    • Assigned: Entered via Details Screen or Quick Edit
    • Reason: Entered via Details Screen or Quick Edit
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 Email Email
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.


Includes:

  • Date Opened
  • Title
  • Username
  • Vessel
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
Email Email Email
Progress Update Update Details Includes
  • Planned Start Date
  • Planned End Date
Task Disassociation Update Details
  • Removal of a Related Item
  • Displays as "Related Item Removed:" for the activity stream.

Includes:

  • Task ID
  • Title

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:
  • Date Created
  • Title
  • Status
  • Priority
  • Username
Creation of a Service Request Creation Creation Includes:
  • Date Opened
  • Task Id
  • Title
  • Username
  • Vessel
Disassociation of a TransAlt Update Details Includes:
  • Date Removed
  • Task Id
  • Title
  • Status
  • Username
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
Email Email Email

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
  • When the status of the SMS Finding changes to Accepted, CAP Submitted, CAP Accepted, CAP Complete, or Closed. Then date from the Confirm Date Selection Dialog is tracked.
Email Email Email

Universal

Repair Details

Tracked Activity Category Sub-Category Notes
Creation of a Repair Creation Creation Includes:
  • Date Opened
  • Vessel
  • Title
  • Repair No.
  • Status
  • Priority
  • RAC
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

Templates