{"id":14828,"date":"2016-05-09T12:09:32","date_gmt":"2016-05-09T04:09:32","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=14828"},"modified":"2017-12-14T14:30:03","modified_gmt":"2017-12-14T06:30:03","slug":"breadcrumb-4-3-2","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/breadcrumb\/breadcrumb-4-3-2\/","title":{"rendered":"Breadcrumb (4.3.2)"},"content":{"rendered":"<p class=\"page-subheading\"><\/p>\n<p class=\"left-bar\">This article applies to versions 4.3.2 and earlier of P2 Explorer.\u00a0For help on the latest version of the Breadcrumb component, see <a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/breadcrumb\/\">Breadcrumb<\/a>.<\/p>\n<h3 class=\"page-subheading\">Overview<\/h3>\n<p class=\"intro-text\">Breadcrumbs are a useful navigation tool for pages that allow users to drill down into a hierarchy to discover further information about a selected entity.<\/p>\n<p class=\"intro-text\">The following diagram shows a breadcrumb configured to display the entities in a hierarchy:<\/p>\n<p class=\"intro-text\"><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumb1.png\" rel=\"lightbox-0\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-3184 size-large\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumb1-800x232.png\" alt=\"\" width=\"800\" height=\"232\" \/><\/a><\/p>\n<div style=\"position: relative;\">\u00a0<\/div>\n<table>\n<tbody>\n<tr>\n<td width=\"130\"><strong>Entity Name<\/strong>:<\/td>\n<td>The name of the entity to display \u00a0in the breadcrumb. It\u00a0is always an event that can both publish and subscribe. The entered value is\u00a0the name of the event that is published when an entity is selected from the breadcrumb. It is also the name of the event that the Breadcrumb listens to in order to determine the entity names to display.<\/td>\n<\/tr>\n<tr>\n<td><strong>Hierarchy Name<\/strong>:<\/td>\n<td>The name of the hierarchy that the breadcrumb uses to get the entities from. This setting can either be a text value or an event. When set to an event, it is the name of the event that the Breadcrumb listens to in order to determine the hierarchy to display.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<hr \/>\n<h3 class=\"page-subheading\">Tutorial<\/h3>\n<p class=\"intro-text\">In this tutorial, we'll look at adding a Breadcrumb to a page. This Breadcrumb will display the hierarchy path of the entity chosen in an Entity Selector. We'll also add a Target Bar to show how clicking within the breadcrumb can affect another component on the page.<\/p>\n<p class=\"intro-text\"><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1.png\" rel=\"lightbox-1\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-2641\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1.png\" alt=\"breadcrumbexample1\" width=\"669\" height=\"506\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1.png 669w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-150x113.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-24x18.png 24w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-36x27.png 36w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-48x36.png 48w\" sizes=\"auto, (max-width: 669px) 100vw, 669px\" \/><\/a><\/p>\n<p class=\"intro-text\">Let's go through this process, step-by-step.<\/p>\n<hr \/>\n<h3 class=\"page-subheading\">Step by Step: Creating a Breadcrumb That Shows the Hierarchy of a Selected Entity<\/h3>\n<p class=\"intro-text\">Before you start, open a new tab in Explorer and click the \u201cCreate a New Page in Studio Mode\u201d thumbnail. Choose the <a title=\"Grid Layout\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/grid-layout\/\">grid<\/a>\u00a0layout - you can adjust the rows and columns if you like but it's not important for this exercise.<\/p>\n<p class=\"intro-text\">If you have access to the training environment, you can follow the steps exactly as outlined here. Otherwise, you will need to adjust the configuration to suit your data.<\/p>\n<p class=\"intro-text\"><strong>Step 1. Add the Breadcrumb\u00a0to the page<\/strong><\/p>\n<p class=\"intro-text\"><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbdrag1.png\" rel=\"lightbox-2\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-2647 size-large\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbdrag1-800x454.png\" alt=\"breadcrumbdrag1\" width=\"800\" height=\"454\" \/><\/a><\/p>\n<p class=\"intro-text\">Drag and drop the\u00a0Breadcrumb component\u00a0onto a grid cell.<\/p>\n<p class=\"intro-text\">\u00a0<\/p>\n<p class=\"intro-text\"><strong>Step 2.\u00a0\u00a0Configure the\u00a0Breadcrumb<\/strong><\/p>\n<p class=\"intro-text\"><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbconfig.png\" rel=\"lightbox-3\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-2610 size-large\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbconfig-800x253.png\" alt=\"breadcrumbconfig\" width=\"800\" height=\"253\" \/><\/a><\/p>\n<p class=\"intro-text\">In this step, we want to populate the hierarchy name\u00a0from an event that the breadcrumb is listening to. \u00a0You'll notice that the\u00a0events are already filled in with default event names. You can choose to change this name if you want, but often there's no real need to. Specify the following events:<\/p>\n<ul class=\"intro-text\">\n<li>Entity Name: \u00a0selectedEntity<\/li>\n<li>Hierarchy Name: (Event) selectedHierarchy<\/li>\n<\/ul>\n<p class=\"intro-text\">Entity Name is always an event, so that the breadcrumb will dynamically update when another component\u00a0on the page publishes the entity that the user has selected.<\/p>\n<ul class=\"intro-text\">\n<li>This is often used to link components such as charts and tables.<\/li>\n<li>It\u00a0also means that other components on the page can listen to the event that is published when a user clicks on an item in the breadcrumb, which in turn will dynamically update the components on the page.\u00a0\u00a0<\/li>\n<\/ul>\n<p class=\"intro-text\">\u00a0<\/p>\n<p class=\"intro-text\">\u00a0<strong>Step 3. \u00a0Add and configure an Entity Selector<\/strong><\/p>\n<p class=\"intro-text\"><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbentitysel.png\" rel=\"lightbox-4\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-2648 size-large\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbentitysel-800x466.png\" alt=\"breadcrumbentitysel\" width=\"800\" height=\"466\" \/><\/a><\/p>\n<p class=\"intro-text\">Drag and drop the <a title=\"Entity Selector\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/entity-selector\/\">Entity Selector<\/a> onto a grid cell, and configure it as follows:<\/p>\n<ul class=\"intro-text\">\n<li>Selected Entity: selectedEntity<\/li>\n<li>Selected Entities:\u00a0selectedEntities<\/li>\n<li>Hierarchy Name: (Event)\u00a0selectedHierarchy<\/li>\n<li>Template Filter: (Text) Well<\/li>\n<li>Start Node: (leave this blank)<\/li>\n<li>Number of Selections: (Number) 1<\/li>\n<\/ul>\n<p class=\"intro-text\">You will notice that the first 3 items already have some default names configured. You can change this if you like, but you will need to remember your changes and substitute appropriately for the next step.<\/p>\n<p class=\"intro-text\">\u00a0<\/p>\n<p class=\"intro-text\"><strong>Step 4. \u00a0Set the event defaults<\/strong>\u00a0<\/p>\n<p class=\"intro-text\"><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbdefaults.png\" rel=\"lightbox-5\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-2649 size-large\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbdefaults-800x552.png\" alt=\"breadcrumbdefaults\" width=\"800\" height=\"552\" \/><\/a><\/p>\n<p class=\"intro-text\">At the moment, the page shows nothing because the user hasn't selected anything. Let's change that and get some default data to display. We do this by creating defaults for the <a title=\"Events\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/events\/\">events<\/a> specified in the components in the previous steps.\u00a0<\/p>\n<ul class=\"intro-text\">\n<li>Click the <em><strong>Event Defaults<\/strong><\/em> button on the Studio toolbar.<\/li>\n<li>Add an event called <em>\"selectedEntity\"<\/em>\u00a0with the text <strong>BOSSIER 1<\/strong>.<\/li>\n<li>Add\u00a0an event called <em>\"selectedHierarchy\"<\/em> with the text <strong>P2 Energy Solutions<\/strong>.<\/li>\n<\/ul>\n<p class=\"intro-text\">You should now see the Breadcrumb and Entity Selector populated with entities. Note that you can set the\u00a0event\u00a0defaults at any time.<\/p>\n<p class=\"intro-text\">Click the preview\u00a0<a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/03\/preview.png\" rel=\"lightbox[1419] lightbox-6\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-2896\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/03\/preview.png\" alt=\"preview\" width=\"13\" height=\"14\" \/><\/a>\u00a0button on the Studio toolbar to see what your page will look like in run-time. You will now be able to select entities from the Entity Selector and observe the change in the Breadcrumb.<\/p>\n<p class=\"intro-text\"><strong>Step 5. Add some data<\/strong><\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbdata1.png\" rel=\"lightbox-7\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-3188 size-large\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbdata1-766x600.png\" alt=\"\" width=\"766\" height=\"600\" \/><\/a><\/p>\n<p class=\"intro-text\">Click the preview\u00a0<a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/03\/preview.png\" rel=\"lightbox[1419] lightbox-6\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-2896\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/03\/preview.png\" alt=\"preview\" width=\"13\" height=\"14\" \/><\/a>\u00a0button again to switch back to edit mode, and do a couple of more things. We're going to add some data and another component to demonstrate further interaction with the Breadcrumb.<\/p>\n<ul class=\"intro-text\">\n<li>Below the canvas, click the button labelled \u201c<a title=\"Add Data\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/add-data\/\">Add Data<\/a>\u201d.<\/li>\n<li>Choose the source data you are going to use. For this tutorial, we are using a <a title=\"Add a Relational Dataset\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/add-data\/add-a-dataset\/\">dataset<\/a> called \u201cProductionSumWithTargets_Perth.\u201d<\/li>\n<li>In the configuration options, specify the following:\n<ul class=\"intro-text\">\n<li>Name: ProductionSumWithTargets_Perth1 (this is automatically added)<\/li>\n<li>Query: ProductionSumWithTargets_Perth\u00a0(this is the query in P2 Server that is being used to return the data)<\/li>\n<li>Parameters \u2013 names:\u00a0(Event) selectedEntity<\/li>\n<li>Parameters \u2013 prodEndTime: (Datetime)\u00a018\/03\/2015 12:00:00 AM<\/li>\n<li>Parameters \u2013 prodStartTime: (Datetime)\u00a001\/02\/2012 12:00:00 AM<\/li>\n<li>Parameters \u2013 readingType: (Text) Monthly<\/li>\n<li>Parameters \u2013 typeTemplate: (Text) Well<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p class=\"intro-text\"><strong>Step 6. Add a Target Bar<\/strong><\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbtargetbar.png\" rel=\"lightbox-9\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-2985 size-large\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbtargetbar-800x418.png\" alt=\"\" width=\"800\" height=\"418\" \/><\/a><\/p>\n<p class=\"intro-text\">As a last step, let's add a <a title=\"Target Bar\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/target-bar\/\">Target Bar<\/a> that will make use of that data.<\/p>\n<ul class=\"intro-text\">\n<li>Drag and drop a Target Bar\u00a0onto another cell on the page.<\/li>\n<li>Configure the settings as follows:\n<ul class=\"intro-text\">\n<li>Source Data:\u00a0ProductionSumWithTargets_Perth1<\/li>\n<li>Actual Column: (Text) Oil<\/li>\n<li>Target Column: (Text) Oil Tgt<\/li>\n<li><a title=\"Filter Column and Filter Value\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/filter-column-and-filter-value\/\">Filter Value<\/a>: (Event) selectedEntity<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p class=\"intro-text\"><strong>Step 7. All done!<\/strong><\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1.png\" rel=\"lightbox-1\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-2641 size-full\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1.png\" alt=\"breadcrumbexample1\" width=\"669\" height=\"506\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1.png 669w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-150x113.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-24x18.png 24w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-36x27.png 36w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/breadcrumbexample1-48x36.png 48w\" sizes=\"auto, (max-width: 669px) 100vw, 669px\" \/><\/a><\/p>\n<p class=\"intro-text\">Congratulations! You now have a fully functioning breadcrumb that changes depending on the entity you select.<\/p>\n<ul class=\"intro-text\">\n<li>Click the preview\u00a0<a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/03\/preview.png\" rel=\"lightbox-11\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-2896\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/03\/preview.png\" alt=\"preview\" width=\"13\" height=\"14\" \/><\/a>\u00a0button on the Studio toolbar to see what your page will look like in run-time.<\/li>\n<li>Watch the Target Bar\u00a0change as you choose different entities.<\/li>\n<li>When you select an entity from the breadcrumb, the components on the page are also affected.<\/li>\n<\/ul>\n<p class=\"intro-text\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-1348\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/save.png\" alt=\"save\" width=\"48\" height=\"53\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/save.png 48w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/save-22x24.png 22w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/save-33x36.png 33w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2015\/02\/save-43x48.png 43w\" sizes=\"auto, (max-width: 48px) 100vw, 48px\" \/>\u00a0Don't forget to <a title=\"Saving Your Page\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-create-your-first-page\/saving-your-page\/\">save your page<\/a>!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Breadcrumbs are a useful navigation tool for pages that allow users to drill down into a hierarchy to discover further information about a selected entity. This page describes how to configure a Breadcrumb, and applies to versions 4.3.2 and earlier of P2 Explorer.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-explorer\/explorer-studio\/controls\/breadcrumb\/breadcrumb-4-3-2\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":4626,"parent":1431,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[11],"tags":[14,36],"class_list":["post-14828","page","type-page","status-publish","has-post-thumbnail","hentry","category-tutorial","tag-breadcrumb","tag-navigation","Product-ex"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/14828","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=14828"}],"version-history":[{"count":0,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/14828\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/1431"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/4626"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=14828"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=14828"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=14828"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}