{"id":3666,"date":"2016-03-21T23:37:48","date_gmt":"2016-03-21T15:37:48","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=3666"},"modified":"2025-05-08T15:44:21","modified_gmt":"2025-05-08T07:44:21","slug":"entities","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/entities\/","title":{"rendered":"Entities, the backbone of all data"},"content":{"rendered":"<p class=\"intro-text\"><\/p>\n<p class=\"note\">This article is about entities in IFS OI Server, what they are and what they do. For details on how to configure entities in IFS OI Server, see: <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/configuring-your-system\/configuring-entities\/\">Configuring Entities<\/a>.<\/p>\n<p class=\"intro-text\">Entities are the backbone of all data in IFS OI Server, and represents the objects in your world that you want to gather information about. These can be real world objects, like a well or pump, or they can be things that are known by convention, such as an area, or business unit. \u00a0<\/p>\n<div id=\"attachment_5746\" style=\"width: 299px\" class=\"wp-caption alignright\"><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/model3.png\" rel=\"lightbox-0\"><img loading=\"lazy\" decoding=\"async\" aria-describedby=\"caption-attachment-5746\" class=\"border-image   wp-image-5746 size-full\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/model3.png\" alt=\"\" width=\"289\" height=\"434\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/model3.png 289w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/model3-100x150.png 100w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/model3-16x24.png 16w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/model3-24x36.png 24w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/05\/model3-32x48.png 32w\" sizes=\"auto, (max-width: 289px) 100vw, 289px\" \/><\/a><p id=\"caption-attachment-5746\" class=\"wp-caption-text\">Entities being modelled in a hierarchy<\/p><\/div>\n<p class=\"intro-text\">Entities are added to\u00a0hierarchies, to represent the relationships between them. For example, we can have entities that represent a well, or a country, or a pump. You can put entities into a hierarchy to organise them in a way that makes sense for your organisation.<\/p>\n<p class=\"intro-text\">Entities have attributes, which represent specific aspects of the thing we are concerned with. For example, we may have an entity that represents a well, and the well has several aspects that we care about, such as Flow Rate, Choke, and Tubing Head Pressure.<\/p>\n<p class=\"left-bar\">Related: <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/hierarchies\/\">Hierarchies<\/a>, <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/attributes\/\">Attributes<\/a><\/p>\n<p class=\"intro-text\">At a higher level, wells might be grouped according to region, state, or country. These regions, states, or countries are also entities \u2013 and they may also have attributes, such as total oil production.<\/p>\n<p class=\"intro-text\">Now let\u2019s get a bit more technical and look in more detail at how entities are defined within the system.<\/p>\n<h2 class=\"page-subheading\">Entity<\/h2>\n<p class=\"intro-text\">At a simplistic level, an entity has 3 main parts: name, display name, and description. The name is a unique name that the entity is known by within IFS OI Server. The display name is what appears in consuming applications \u2013 often, but not always, this will be the same as the unique name.<\/p>\n<table width=\"568\">\n<tbody>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\"><strong>Name<\/strong><\/td>\n<td width=\"186\"><strong>Display Name<\/strong><\/td>\n<td width=\"255\"><strong>Description<\/strong><\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\">Western Australia<\/td>\n<td width=\"186\">WA<\/td>\n<td width=\"255\">WA Business Unit<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\">Pilbara<\/td>\n<td width=\"186\">Pilbara<\/td>\n<td width=\"255\">Pilbara Region<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\">Mobile Fleet<\/td>\n<td width=\"186\">All Mobile Fleet equipment<\/td>\n<td width=\"255\">Grouping of all Mobile Fleet equipment<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\">Herbert<\/td>\n<td width=\"186\">Herbert Gas Well<\/td>\n<td width=\"255\">Herbert Gas Producing Well<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\">Derby<\/td>\n<td width=\"186\">Derby Water Well<\/td>\n<td width=\"255\">Derby Water Injection Well<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\">Hunter<\/td>\n<td width=\"186\">Hunter Oil Well<\/td>\n<td width=\"255\">Hunter Oil Producing Well<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>&nbsp;<\/p>\n<h2 class=\"page-subheading\">System Identifiers<\/h2>\n<p class=\"intro-text\">A key aspect of IFS OI Server is that it is able to pull in and consolidate entities from different systems, from other IFS OI applications such as Procount, Stratus, and P2P, or from other data systems.<\/p>\n<p class=\"intro-text\">One of the issues that people run into when trying to integrate systems is that the same item may be called different things in each of the systems, so how do we keep all of these different names linked up?<\/p>\n<p class=\"intro-text\">In IFS OI Server we do this by using a <em>System Identifier<\/em>. Each entity can have a different name in each data source connected to IFS OIServer.\u00a0 We can then refer to a single entity and IFS OI Server will use the system identifier to understand which entity we are referring to in the underlying source system.<\/p>\n<p class=\"left-bar\">Related: <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/datasources\/\">Datasouces and Adaptors<\/a><\/p>\n<p class=\"intro-text\">For example, an entity may exist in P2P and in Procount under different names. In reality, these represent the same real-world object. In order to represent that in IFS OI Server, we must be aware of how P2P and Procount identify that entity internally. We do this by associating the entity with corresponding system identifiers \u2013 consisting of the system name and the identifier for the entity itself.<\/p>\n<table width=\"450\">\n<tbody>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" width=\"128\"><strong>Name<\/strong><\/td>\n<td width=\"186\"><strong>Display Name<\/strong><\/td>\n<td width=\"65\"><strong>System<\/strong><\/td>\n<td width=\"71\"><strong>Identifier<\/strong><\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px;\" rowspan=\"2\" width=\"128\">Derby<\/td>\n<td style=\"padding-left: 5px;\" rowspan=\"2\" width=\"186\">Derby Water Well<\/td>\n<td style=\"padding-left: 5px; border-left: 1px solid #cccccc;\" width=\"65\">P2P<\/td>\n<td width=\"71\">Derby_2184<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td style=\"padding-left: 5px; border-left: 1px solid #cccccc;\" width=\"65\">Procount<\/td>\n<td width=\"71\">Q52KL5<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p class=\"intro-text\">Once these have been set up, IFS OI Server can do some automatic mapping to these systems, for example when running a dataset query:<\/p>\n<p><code>SELECT ENTITYNAME(Id), Status FROM STRATUSTABLE WHERE<br \/>\n StratusId = PARAM(name, entity)<\/code><\/p>\n<p class=\"left-bar\">Related: <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/connecting-your-data\/creating-a-dataset-datasource\/\">Creating a Dataset Datasource<\/a>, <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/connecting-your-data\/creating-a-dataset-datasource\/how-to-write-a-dataset-query\/\">How to Write a Dataset Query<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Entities are the backbone of all data in IFS OI Server, and represent real world objects about which we want to gather information and model. This article describes what entities are and how they are used.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/entities\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":47939,"parent":3648,"menu_order":9,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[3],"tags":[109,108,330,329],"class_list":["post-3666","page","type-page","status-publish","has-post-thumbnail","hentry","category-primer","tag-attributes","tag-entities","tag-integrating-systems","tag-system-identifiers","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3666","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=3666"}],"version-history":[{"count":3,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3666\/revisions"}],"predecessor-version":[{"id":67468,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3666\/revisions\/67468"}],"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\/47939"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=3666"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=3666"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=3666"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}