4.4.4.3 Comment Collaboration & Inline Editing in Details View

The Comment Collaboration & Inline Details Editing feature allows your team to collaborate efficiently by adding comments directly within text fields in both Details view and Edit/Creation forms. This lets team members provide feedback, ask questions, and suggest changes right within the content. You can also escalate discussions into actionable Change Requests (CRs) for streamlined change management.

This guide will cover:

• How to access the Details view modes, that enable the comment and edit functions
• How to view and respond to existing comments
• How to create your own comments
• How to manage comments: editing, resolving, and deleting
• How to raise a Change Request (CR) from a comment thread
• Editing text fields directly using Inline Editing
• Rules & limitations
  

For instructions on using the comment feature in Edit/Creation forms, click here.

Accessing the Details View Modes

1. Navigate to the Details view of the desired object
2. Click on the VIEWING menu at the top-right of the page.
3. You will see the following modes:
   • VIEWING: View the content without any comments.
   • REVIEWING: Add and view comments, and raise a Change Request (CR).
   • EDITING: Make inline edits to the object’s name and text fields.

*Only users with Write permission will be able to access the EDITING mode.

Viewing & Responding to an Existing Comment

4. Switch to REVIEWING mode
5. If there are existing comments, the text will be highlighted in blue. Click on the highlighted text to view comments.

6. To respond to a comment:
   • Click on the Add Comment… button.
   • A text box will appear for you to add your response.
   • Click Save.

Adding a New Comment

1. Highlight the desired text in the Details view.
2. A button will appear. Click on it.

1. A side panel will open on the right.
2. Enter your comment in the box.
3. Click Save.

Managing Comments: Editing, Resolving & Deleting

1. Switch to REVIEWING mode.
2. Locate the comment you want to manage.
3. Click the three-dot menu.
4. Choose one of the following actions:
   • Resolve: The comment will be removed from the panel, and a discussion topic will be automatically created in the Collaboration module.
     • The discussion topic includes the full comment history and is Closed upon creation.
   • Delete: Permanently removes the comment. Users can only delete their own comments.
     • Deleting a comment does not create a discussion topic. If compliance tracking is required, consider resolving the comment instead.
     • Notifications are sent to relevant users, including the object’s Author and comment creator.
   • Edit: Modify the comment as needed, then click Save to apply the changes. Users can only edit their own comments.

Raising a Change Request (CR) from a Comment Thread

1. Switch to REVIEWING mode.
2. Click on the three-dot menu next to the original comment
3. Select Raise a CR from the thread.
4. This creates a new topic in the Collaboration module, including the original comment and any replies.
5. The original comment thread is removed from the panel to prevent duplication.

Inline Editing

Inline editing allows users to modify text fields directly in EDITING mode without needing to navigate to a separate editing page.

1. Switch to EDITING mode.
2. Click on the text field you want to edit, or on the pen button next to the name to edit it.
3. Make your changes directly within the field.
4. Click outside the text field to save your changes automatically.

Rules & Limitations

Comment Retention:

• If a user reverts to an older version that contains comments, the comments remain intact.
• Once a user moves to a new version, comments linked to specific text may no longer be available.
  

Permissions & Editing Restrictions:

• The Scope field in the Process module is not currently editable.
• In Published mode, users can only access VIEWING and REVIEWING.
• Users need at least Read Published permission on an object to leave comments.
• All users with at least Read Published permission can view comments.
• In Latest mode, users with Write permission can edit text and see comments made in both Latest and Published modes.
• Users in Published mode can reply to comments made in Latest mode and vice versa.
• If a user in Published mode tries to leave a comment on an object whose draft is locked (due to approval, endorsement cycle, or another user), the comment may appear to be created but will not be saved.

Mode Persistence When Navigating Between Objects & Versions

• When switching between objects, the user’s current mode (Viewing, Reviewing, or Editing) is maintained unless security rules apply:
  • Viewing → Viewing
  • Reviewing → Reviewing
  • Editing → System checks permissions:
    • If the user has edit rights for the new object, Editing mode is retained.
    • If the user lacks edit rights, they are reverted to Viewing mode.
• When switching between versions:
  • Viewing → Viewing
  • Reviewing → Reviewing, but commenting is restricted unless on the latest draft or published version.
  • Editing → Reverts to Viewing mode to prevent unintended edits.

Inline Editing Restrictions

• Inline editing is disabled/removed in the following cases:
  • Read Published mode → Inline editing options are removed.
  • Read Latest mode (if user lacks Write permissions) → Clicking inline editing triggers a notification stating that editing is only allowed in the latest version.
  • When toggling between Read Latest and Read Published → Inline editing is removed for consistency.

Versioning & Locking Mechanism:

• If a user edits inline text, the system locks the object to prevent conflicts. It will unlock when they exit.
• Clicking outside a text field after editing triggers a version check:
  • If changes were made, a new version is created.
  • If no changes were made, the page does not refresh, and no new version is created.

Notifications:

• Subscribers to the object and users associated via RASCI-VS receive notifications for new comments and replies.
• The comment creator will be notified when someone replies.

Change Requests:

• Raising a CR is only possible in REVIEWING mode.
• Once a CR is raised, notifications are sent automatically to relevant stakeholders via RASCI-VS.
• One a CR is raised, the original comment thread is removed from the panel to prevent duplication.