{"id":37650,"date":"2018-09-07T08:25:44","date_gmt":"2018-09-07T00:25:44","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=37650"},"modified":"2024-10-09T12:54:36","modified_gmt":"2024-10-09T04:54:36","slug":"comments-button","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/comments-button\/","title":{"rendered":"Comments Button"},"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 Button is a component that a page designer can position on a section of a page, or over an image (such as a schematic) so that a user can add and view comments for data that would most likely relate to that section or image (depending on configuration).<\/p>\n

When a user clicks the configured Comments Button in Display Mode, the Explore<\/strong> panel opens to show comments relating to the Comments button's data.<\/p>\n

\"\"<\/a><\/p>\n\n\n\n
The Comments appears in the Explore panel<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

The Comments button is filled in \"\" if there are comments for the comment's time period, and just shows an outline \"\" if there are none.<\/p>\n

Note<\/strong>: The Comments button icon appearance on a page may vary, depending on styling.<\/p>\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 or selected time range. Comments are stored in IFS OI Server and can be viewed anywhere in Explorer trends, and in Explorer pages that have been configured for comments.<\/p>\n

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

Finding the Component<\/h3>\n

The Comments Button 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 Button, by giving it a fixed Entity<\/em> property.<\/p>\n

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

1. For the Entity<\/strong> property, select Entity<\/em> from the drop-down (for a fixed value), and type Silver<\/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, click the Comments Button. The Comments list (empty for this period) appears in the Explore<\/strong> panel, with the Title: \"Comments for Silver\".<\/p>\n

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

4. From here, you can add, reply, edit<\/strong>*, and delete<\/strong>* comments, or search<\/strong> for comments in a different time range. See Working with Comments<\/a>. (*Editing and Deleting options depend on role privileges.)<\/p>\n

Usually, your comments button would be positioned next to the data it is describing, as in this page where the comments button for tag Silver<\/em> is positioned next to a data label for Silver<\/em>:<\/p>\n

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

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

 <\/p>\n

\n

Configuration<\/h2>\n

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

The following diagram shows a configured Comments Button component:<\/p>\n\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 Button 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. This date range can be changed in Display mode, using Date\/Time Pickers<\/a>. 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 button 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 to this comments button. Read more about Comment Context<\/a>.<\/td>\n<\/tr>\n
6. Style<\/strong><\/td>\nSelect a suitable style from the drop-down list (no styles are available in the example).<\/td>\n<\/tr>\n
7. Alignment <\/strong><\/td>\nClick on one of the boxes to override the selected style's alignment.<\/td>\n<\/tr>\n
8. 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 component<\/a><\/p>\n

 <\/p>\n

\n

Tutorial: Configuring Various Comments Buttons<\/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 Button components, as well as a Breadcrumb component. We'll also add some Text Labels to label the different configurations used in our Comments Buttons.<\/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