Configuring comments in legacy views
Legacy view component
You're currently viewing a topic about a legacy view component in Studio. This component can still be used in legacy Studio views, however we recommend using the visual view editor in the new Studio experience. The updated interface includes drag and drop capabilities, allowing you to easily add components and configure your views.
For more information, see: Views.
The comment component allows app viewers to add text based comments within a view. These comments are displayed only within that view and are not stored or visible in other areas of the platform.
An example of the comments component:
Basic comments configuration
When configuring basic comments, the following attributes are available:
Attribute | Required | Type | Description |
|---|---|---|---|
objectId | Yes | String | Defines the identifier that the commments are associated with. Note that the comments are then only visible within the view, rather than across the Celonis platform.
|
The example YAML for basic comment configuration:
id: comments-cba6a50d-7db7-4dc2-8f36-e29454afe15d
type: comments
settings:
objectId: ${id}Advanced comments configuration
When configuring advanced comments, the following attributes are available:
Attribute | Required | Type | Possible Values | Default | Description |
|---|---|---|---|---|---|
name | No | String | Comments | Defines the name shown at the top of the comments component. | |
commentLimit | No | Integer | 5 | Defines the number of comments displayed on one page. | |
dateFormat | No | Boolean |
| yyyy-MM-dd hh:mm | Defines the format of the comment timestamp. |
The example YAML for advanced comment configuration:
id: comments-cba6a50d-7db7-4dc2-8f36-e29454afe15d type: comments settings: objectId: 1234 name: Comments dateFormat: yyyy-MMM-dd hh:mm commentLimit: 10