{"id":31095,"date":"2018-11-06T11:13:58","date_gmt":"2018-11-06T03:13:58","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=31095"},"modified":"2024-10-09T12:54:35","modified_gmt":"2024-10-09T04:54:35","slug":"comments","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/comments\/","title":{"rendered":"Comments"},"content":{"rendered":"

<\/p>\n

This article applies to versions 4.6.2 and later of IFS OI Explorer. For more, see Release History<\/a>.<\/p>\n

Overview<\/h2>\n

The Comments component displays a list of comments on an Explorer page, rather than in the Explore<\/strong> panel.<\/p>\n

Unlike the Comments button component, where the user clicks an icon to open the comments in the Explore<\/strong> panel, comments from a Comments component are always on the page: there are no icons to click, and the list is always visible, with vertical scrollbars if the comments don't fit.<\/p>\n

The comments list on a page is very similar to that in the Explore<\/strong> panel; the main difference is that a user cannot change the comments time range on the Comments component.<\/p>\n

To enable changing the dates for a comments list on a page, a separate date\/time control (such as a Date\/Time Range Picker<\/a>) can be added to the page.<\/p>\n

\"\"<\/a><\/p>\n\n\n\n
The Comments list on an Explorer page<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Users can add comments for data and comment context, for a timestamp specified by the page designer (defaulted to the page variable endTime<\/em>) and can search for comments within the configured time range.<\/p>\n

Comments are stored in IFS OI Server and can be viewed in Explorer trends, and in Explorer pages that have been configured for comments. For example, a comment that is added for entity ABC<\/em> on Explorer Page 1<\/strong> can be viewed and replied to on Explorer Page 2<\/strong> if the page has been configured for comments for that entity, and from Trend 1<\/strong> if that trend uses the same entity - provided the time ranges overlap.<\/p>\n

Related: Comments in Explorer<\/a>, Formatting Text<\/a><\/p>\n

Finding the Component<\/h3>\n

The Comments component is in the Display \"Display group of the Components Toolbox.<\/p>\n

\"\"<\/a><\/p>\n

 <\/p>\n

\n

Quick Start<\/h2>\n

You can very quickly configure a Comments component, by giving it a fixed Entity<\/em> property.<\/p>\n

In the Comments<\/strong> component editor, assign a fixed value to the Entity property, then save and finish the page.<\/p>\n

1. For the Entity<\/strong> property, select Entity<\/em> from the drop-down (for a fixed value), and type Abes.Flowrate<\/em> in the text box (this is a tag name in the Sample Data).<\/p>\n

\"\"<\/a><\/p>\n

2. Click Finish and Open<\/strong> on the Studio toolbar.<\/p>\n

\"\"<\/a><\/p>\n

3. In Display Mode, type a comment in the edit box, then click Save<\/strong> or press Enter<\/strong>.<\/p>\n

\"\"<\/a><\/p>\n

Note: Live Preview only applies to version 4.6.2. In later versions, mentions are supported natively and a text format toolbar<\/a> is available.<\/p>\n

Your new comment appears in the list.<\/p>\n

\"\"<\/a><\/p>\n

You can add, reply, edit<\/strong>*, and delete<\/strong>* comments in the comments list (no comments shown in this example). See Working with Comments<\/a>. (*Editing and Deleting options depend on role privileges.)<\/p>\n

Related: Using Comments for collaboration<\/a> in display mode.<\/p>\n

 <\/p>\n

\n

Configuration<\/h2>\n

The Comments component and the Comments Button component have a very similar configuration.<\/p>\n

The following diagram shows a configured Comments component:<\/p>\n\n\n\n
\n\n\n\n\n\n\n\n\n\n
1. Timestamp<\/strong><\/td>\nThe comment's timestamp. The default is the page variable: endTime<\/em>. Comments that are added using this Comments component have this as their timestamp, and relate to the comment's data for this timestamp.<\/td>\n<\/tr>\n
2. Show From<\/strong> and Show To<\/strong><\/td>\nThe date\/time range for which to display comments. Only comments with a timestamp within this range appear in the Comments list. The default values are the page variables: startTime<\/em> and endTime<\/em>.<\/td>\n<\/tr>\n
3. Entity<\/strong><\/td>\nChoose Variable<\/em> from the drop-down list to use a variable for this property, otherwise Entity<\/em>. This is the comment's data, and can be a tag, an entity, or an attribute. Comments that are added using this comments component will be for this data.<\/td>\n<\/tr>\n
4. Hierarchy<\/strong><\/td>\nIf you choose to use a hierarchy (choose Variable<\/em> from the drop-down list to use a variable for this property, otherwise Hierarchy<\/em>), then comments for the component's specified entity, as well as all of its descendent entities in the specified hierarchy, are shown in the comments list. This should only be used if the Entity<\/strong> property is an entity (not a tag or an attribute).<\/em><\/td>\n<\/tr>\n
5. Comment Context<\/strong><\/td>\nOptionally type a Comment Context<\/em> to apply a filter to the comments that are added using this comments component. Read more about Comment Context<\/a>.<\/td>\n<\/tr>\n
6. Style<\/strong><\/td>\nSelect a suitable style from the drop-down list.<\/td>\n<\/tr>\n
7. Position<\/strong><\/td>\nSelect a position in Precision Layout<\/a> or Grid Layout<\/a> (depending on where the component is placed).<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n\n\n\n\n
\"\"<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Related: Comments Button<\/a><\/p>\n

 <\/p>\n

\n

Tutorial: Configuring Various Comments components<\/span><\/h2>\n

If you're unfamiliar with the process of building pages, read the article Building an Explorer Page<\/a>.<\/p>\n

In this tutorial, we'll add several Comments components, as well as a Breadcrumb component. We'll also add some Text Labels to label the different configurations used in our Comments components.<\/p>\n

For all of the tutorials, we will keep the default values for: Timestamp, Show From<\/em> and Show To<\/em> properties.<\/p>\n

At the end of the tutorial, your page should look something like this:<\/p>\n

\"\"<\/a><\/p>\n

If you'd prefer to do just a part of the tutorial, then choose from the list here:<\/p>\n