Comments

The Comments widget enables collaboration in a Workshop module.

References

You can use references to mention objects in comments. References are interactive, selecting one can either display the mentioned object’s properties in a tooltip or trigger an event in the module such as opening a modal or showing the Object View.

See below for an example of configuring and using references in the Comments widget:

Configuration	Usage

Permissions

Comments are not separate objects, they are attached directly to the parent object. They do not show up in Object Explorer and can only be displayed using the comments widget. To make the comments searchable in Ontology see the section below.

Comments follow the permissions of the parent object, so if you can access the object then you can view and post new comments under it. This means that Restricted Views are automatically supported. You can also delete your own comments if you unintentionally posted something.

Note on granular permissions

Let us explore more granular permissions using an example of a medical practice. A medical practice can configure a patient object with column level permissions, so that only the basic fields are visible to the admins and the doctors can view both the basic fields and any sensitive fields. To prevent admins from viewing comments left by doctors on sensitive fields, the practice creates a separate proxy object called PatientSensitiveComments. This way they can have two comment threads in their module, one comment thread directly on the patient object that is visible both to admins and doctors, and another comment thread on the proxy object PatientSensitiveComments that is only visible to doctors.

(Advanced) Making comments searchable in Ontology

You can preserve the history of comments in Ontology by enabling an Action Log. To do this, toggle on Action to perform after commenting and navigate to the Ontology to configure fields like Comment text, Parent Object, and Current user. Or, you can go for a more complex mirroring of comments in Ontology by creating a dedicated object type to store comments, this would allow to mirror deleting of comments which is not possible with Action Log which is append only.

There are several things to consider before adding Comment text to the Action Log:

You should be careful if the parent object is configured as a Restricted View and the row-level permissions reference a field that can be changed, since the Action Log is append-only. For example, if a ticket has a field called Sensitivity level whose value changes from Public to Legal only, then the comments already stored in the Action Log will still contain the previous value Public. To make sure the comments you copy to Ontology layer follow the permissions of the parent object, you should create a dedicated Ticket Comment object and configure an action that changes the Sensitivity level of the ticket to also update the Sensitivity level of the comments stored in the Ticket Comment object.
The Action Log will not show the rich text display of comments like in the Comments widget.

Notifications

After commenting on an object, you will be automatically subscribed to get notifications when other users comment on the object. Mentioning a user in a comment will also send a notification to them and subscribe them to receive notifications for future comments on the object. Notifications are delivered as an email to the user and appear in their notification inbox in Foundry.

Notifications should be seen as an enhancement to the workflow and should not be the only way of notifying a user know that there is an outstanding action. Users should be able to see tasks assigned to them in your Workshop application in an inbox view.

Default notifications

The Comments widget comes with notifications enabled by default. The default notifications include a link to the Object View for the object on which the comment was left. To make sure the user can see the comment when they click the link, you should configure the object view to be backed by a Workshop module with a Comments widget. To customize the notification text or to include a link to the Workshop application instead, follow the instructions for custom notifications.

Custom notifications

To send a custom notification, you can disable “Send default notifications” and configure an “Action to perform after commenting” which has a notification side-effect, refer to the action notification documentation for more information. The Comments widget provides special values that can be passed to an action such as Users to notify or Comment text. These allow you to easily construct a custom notification. To include a link to a specific location in your Workshop application you can configure a module interface variable. The examples below show how you can configure a custom notification:

Set up an Action in Ontology with following fields
Then add the notification side effect to the action rules
Configure the notification that should be sent
Configure the action in the Comments widget to pass Users to notify and Comment text

Attachments

You can upload attachments, such as files and images, either under the parent object or directly under a comment. Attachments uploaded under a comment will be visible only in the Comments widget and are best suited for draft documents and iteration. We recommend only uploading small attachments, for larger attachments you will notice a long upload time and there is a 200 MB limit. We recommend uploading larger attachments directly on the parent object.

Action Log

The Comment widget can display comments and actions taken on the relevant objects in one unified feed. Learn more about Action Log here.

Comment widget showing comments and actions in one unified feed.

Frequently asked questions

Can I create comments automatically when an action happens?

The Comments widget lets you display Action Log entries in a common feed with comments, so automated "comments" should be represented as Action Log entries.

Comments from the Comments Helper in Object Explorer cannot be displayed or reused in Workshop's Comments widget.