{"id":3669,"date":"2017-01-31T23:37:36","date_gmt":"2017-01-31T15:37:36","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=3669"},"modified":"2024-06-21T15:21:51","modified_gmt":"2024-06-21T07:21:51","slug":"comments","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/comments\/","title":{"rendered":"Comments: Communicating with context"},"content":{"rendered":"\n<p class=\"note\">This article is about how comments are stored in IFS OI server, and how they can be used. \u00a0For details on how comments are implemented in IFS OI Explorer, see: <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/comments-button\/\">Comments Button<\/a>,\u00a0<a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/trends\/creating-a-trend\/\">Creating a Trend<\/a>.<\/p>\n<p class=\"intro-text\">IFS OI Server\u2019s commenting system is a smart way of adding time stamped commentary to <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/entities\/\">entities<\/a>, all stored in a common location, with extra information associated with it. \u00a0This extra information adds another whole level of information to this simple textual comment.\u00a0<\/p>\n<p class=\"intro-text\">This extra information allows us to perform many different types of smart searching, filtering and linking, so we can associate these simple pieces of text with the real life objects that the comment was made about. \u00a0The <em><strong>context<\/strong><\/em> that is applied to\u00a0each comment allows you filter out comments on a report, based on this extra information. \u00a0For example, on an Oil Sales report you may only want to show comments that are tagged with the context of oil, so other comments about downtime or gas sales can be hidden. \u00a0<\/p>\n<p class=\"intro-text\">\u00a0Comments are stored in the IFS OI<a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/server-system-overview\/\">\u00a0Server<\/a> database, with the following information:<\/p>\n<ul class=\"intro-text\">\n<li>Text of the comment<\/li>\n<li>Start date and time\u00a0where the\u00a0comment\u00a0applies<\/li>\n<li>End date and time where the\u00a0comment\u00a0applies (can be the same as\u00a0the start time if the comment only applies for an instant in time)<\/li>\n<li>Entity to which the comment applies (Entity or Entity:Attribute or Entity:Attribute!AttributeValue)<\/li>\n<li>Author of the comment<\/li>\n<li>Context<\/li>\n<li>The application from which the comment was made<\/li>\n<\/ul>\n<p class=\"intro-text\">The system provides comment data storage and retrieval for applications which don\u2019t have any comment storage capability.<\/p>\n<p>&nbsp;<\/p>\n<h2 class=\"page-subheading\">Time-aware comments<\/h2>\n<p class=\"intro-text\">Comments are always made with a date and time in mind. This is a time period with a start time and end time (e.g. a production month or day).<\/p>\n<p class=\"intro-text\">This means that the comment will apply to an entity for that period of time.\u00a0If you want a comment to apply to a particular instant in time, you can make the start time and end time the same.<\/p>\n<p>&nbsp;<\/p>\n<h2 class=\"page-subheading\">Context<\/h2>\n<p class=\"intro-text\">A comment\u2019s context is some extra information that is added to the comment by a consuming application, such as IFS OI Explorer, and is used in a way that makes sense to that application.<\/p>\n<p class=\"intro-text\">For example, in IFS OI Explorer, the context is determined by the page designer. In the case of the comments button component, all comments entered via that component on a page has the context as whatever is decided by the page designer. To illustrate, suppose the comments on a page all have the context of \u201cOil Report\u201d. Explorer can apply filtering to all the comments in the system to only show comments relevant to the current Explorer page.\u00a0<\/p>\n<p class=\"intro-text\">Taking this a step further, a page designer can use the same context for the same entity on a completely different page. When a comment is applied to that entity, users will see all comments for that entity and\u00a0context (e.g. Oil Report), even though they are displayed on different pages.<\/p>\n<p class=\"left-bar\">Related: <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/comments-button\/\">Comments Button<\/a><\/p>\n<p>&nbsp;<\/p>\n<h2 class=\"page-subheading\">Threaded comments<\/h2>\n<p class=\"intro-text\">The commenting system is threaded, so that users can reply to comments.\u00a0 This allows each of the sub comments to be kept together, allowing a user to see a full history of the conversation.<\/p>\n<p class=\"intro-text\">Replies can only be made one level deep.<\/p>\n<p>&nbsp;<\/p>\n<h2 class=\"page-subheading\">How comments can be used<\/h2>\n<p class=\"intro-text\">Consuming applications can use the commenting system in various ways.<\/p>\n<p class=\"intro-text\">For example, in IFS OI Explorer, there is a Comments button component that allows comments to be added to a page, and users can also <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/trends\/creating-a-trend\/#Step_6_Adding_Viewing_and_Replying_to_Comments_on_a_Trend_Tag\">add comments via the trend<\/a>.<\/p>\n<p class=\"intro-text\">Comments are displayed in IFS OI Explorer in a panel that appears on the right side of the page, when the user clicks the comments icon on the page or trend.<\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused.png\" rel=\"lightbox-0\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-5817 size-full\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused.png\" alt=\"howcommentscanbeused\" width=\"1205\" height=\"450\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused.png 1205w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused-768x287.png 768w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused-150x56.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused-24x9.png 24w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused-36x13.png 36w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/howcommentscanbeused-48x18.png 48w\" sizes=\"auto, (max-width: 1205px) 100vw, 1205px\" \/><\/a><\/p>\n<p class=\"intro-text\">Each consuming application can use the IFS OI Server Comments system in a way that makes sense for that application, making it a very flexible system.<\/p>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>IFS OI Server\u2019s commenting system is a smart way of adding time stamped commentary to entities, in a common location, with extra information associated with it. This article describes how the commenting system works.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/comments\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":5820,"parent":3648,"menu_order":12,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[3],"tags":[663],"class_list":["post-3669","page","type-page","status-publish","has-post-thumbnail","hentry","category-primer","tag-comment","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3669","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=3669"}],"version-history":[{"count":3,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3669\/revisions"}],"predecessor-version":[{"id":67521,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3669\/revisions\/67521"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3648"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/5820"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=3669"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=3669"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=3669"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}