Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-114199

As an App User, I want to add and view all comments related to a Workflow App instance

    Details

      Description

      As an App User, I want to add and view all comments related to a Workflow App instance, so that I can track and fully understand all considerations made by any analysts that were involved in the instance workflow.

      Design Deliverables

      [Mockups|https]
      [Component|https]

      Context

      Nowadays our Workflow Engine already allows users to submit comments on Workflow Instances. Those comments can be added in any step of the workflow and even during transition and reassign actions. This story aims to allow the comment feature to be included in the Workflow Powered App entry views, but with the following improvement:

      • When a user opens an existing record of a Workflow App, he shall be able to include new comments in the Form/Details View of the record as well as seeing all the comments inserted by anyone and in any step. Similar to how comments works in JIRA Issues.

      Aside from that, all the other capabilities that the comment feature has should also be available in Workflow Powered Apps. Including:

      • Add comments
      • Edit Comments
      • Delete Comments
      • Subscribe
      • Unsubscribe
      • Reply to a comment
      • Read Comments
      • See Comment Author
      • See Comment submission Date
      • Comment when assigning or transition
      • Tag someone in a comment
      • See the number of total comments that a instance has.

      Acceptance Criteria

      1- See All Comments of an Entry

      Given a Workflow Powered App with one or more entries (aka workflow instances),
      when a user opens the Form/Details View of one of the entries,
      then the user should be able to see all the comments that were added to the entry.

      • All comments that were included in the entry/Workflow instance should be available, no matter who added or in which step it was added.
      2- Add a Comments in an Entry

      Given a Workflow Powered App with one or more entries (aka workflow instances),
      when a user has opened the Form/Details View of one of the entries,
      then the user should be able to add a new comment in the entry.

      • The user doesn't need to be assignee in order to place a comment;
      • The view doesn't need to be in edition mode to add a comment;
      • Users should not be able to add comments in the Form View when creating a new entry. The comments should only be available after the entry is already created.
      3- Edit a Comments in an Entry

      Given that a user has inserted a comment in a Workflow Powered App entry,
      when the user clicks in his own comment and selects the option to edit,
      then the user should be able to modify his comment and save the changes.

      • Users should be able to identify comments that have been edited by the author.
      4- Delete a Comments in an Entry

      Given that a user has inserted a comment in a Workflow Powered App entry,
      when the user clicks in his own comment and selects the option to delete,
      then the user should be able to delete his comment.

      5- Reply a Comments in an Entry

      Given a Workflow Powered App Entry with one or more comments,
      when a user clicks in the reply option of one of those comments,
      then the user should be able to add a new comment that will be nested in the replied comment.

      6- Subscribe in a Entry

      Given a user not subscribed to a Workflow Powered App Entry,
      when a user clicks in the Subscribe option in the entry,
      then the subscribed user should start being notified about new comments and replies included in the entry.

      7- Unsubscribe in a Entry

      Given a user subscribed in a Workflow Powered App Entry,
      when a user clicks in the Unsubscribe option in the entry,
      then the subscribed user should stop being notified about new comments and replies included in the entry.

      8- See Comments Metadata

      Given a Workflow Powered App Entry with one or more comments,
      when a user has opened the Form/Details View of one of the entries,
      then he should be able to see the author, creation date and edition date (if applicable) of each comment.

      9- Insert Comment when Reassigning

      Given a Workflow Powered App entry,
      when a user selects the option to reassign the entry,
      then the user should be able to insert a new comment alongside the reassignment.

      10- Insert Comment when Transitioning

      Given a Workflow Powered App entry,
      when a user selects the option to transition the entry to another step,
      then the user should be able to insert a new comment alongside the transition.

      11- Tag Another User in Comments

      Given a Workflow Powered App entry,
      when the user is writing a new comment for the entry,
      then the user should be able to tag another user by using the @ shortcut function.

      • The tagged user should be notified about this comment.
      12- See Number of Total Comments

      Given a Workflow Powered App Entry with one or more comments,
      when a user has opened the Form/Details View of one of the entries,
      then he should be able to see the number of total comments that the entry has.

      Definition of Done (DoD):

      • All Acceptance Criteria were passed;
      • Make sure that the expected automated tests were created (unit / integration / functional) and passed successfully;
      • Code with peer review completed;
      • Validated by QA, Product Designer and/or PM;
      • No critical bug related to Story scope (ex.: similar of FP4, FP5);
      • Make sure that all system documentation were updated (if necessary)
      • Make sure that it has the extensions points needed to allow GS and customers to customize the feature (If applicable)

        Attachments

          Activity

            People

            Assignee:
            support-lep@liferay.com SE Support
            Reporter:
            matheus.xavier Matheus Xavier
            Engineering Assignee:
            SE Support
            Recent user:
            Rodrigo Cunha
            Participants of an Issue:
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Packages

                Version Package