{"id":12399,"date":"2017-11-23T11:14:04","date_gmt":"2017-11-23T03:14:04","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=12399"},"modified":"2024-07-04T15:13:14","modified_gmt":"2024-07-04T07:13:14","slug":"setting-up-hierarchies","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/configuring-your-system\/setting-up-hierarchies\/","title":{"rendered":"Setting Up Hierarchies"},"content":{"rendered":"\n

This article describes how to create hierarchies using IFS OI Server Management or the Import\/Export spreadsheet. For general information on hierarchies, see: \u00a0Hierarchies in IFS OI Server<\/a>.<\/p>\n

A hierarchy is an organised structure of entities, intended to form a model of assets within an organisation. Configuring a well-structured hierarchy is crucial to getting the most out of your asset model. You can configure a hierarchy using Server Management or the Import\/Export spreadsheet.<\/p>\n

<\/i>BEST PRACTICE<\/span><\/p>\n

Your hierarchies should never contain more than 1,000 children under a single node - not only does this make the hierarchy difficult to navigate, it also impacts the performance of IFS OI Server.<\/p>\n<\/div>\n

\u00a0<\/p>\n

Server Management<\/h2>\n

In Server Management, configuring a hierarchy requires 2 steps, all done through the Hierarchies menu option:<\/p>\n

    \n
  1. Creating the hierarchy.<\/li>\n
  2. Assigning entities to the hierarchy.<\/li>\n<\/ol>\n

    The only prerequisite is that you must have already created the entities you intend to use.<\/p>\n

    Prerequisite Step: Configuring Entities<\/a><\/p>\n

    Creating a Hierarchy<\/h3>\n

    To create a hierarchy in IFS OI Server Management:<\/p>\n

    1. Open IFS OI Server Management, and click the Hierarchy\u00a0\"hierarchyicon\"\u00a0<\/strong>icon.<\/p>\n

    2. Click Create New Hierarchy<\/strong>.<\/p>\n

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

    Note: If you want to edit the details of an existing hierarchy, hover over\u00a0it from the list below the Create button, and click the edit\u00a0\"editicon\"\u00a0button.<\/p>\n

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

    3. Give the hierarchy a name<\/strong> and a description<\/strong>. Note that the name must be unique and cannot contain any reserved characters.\u00a0For the description, it's often useful to provide a broader explanation\u00a0of the purpose of the hierarchy and the type of entities it contains.<\/p>\n

    Related: Reserved Characters & Keywords<\/a><\/p>\n

    4. Specify an Ordinal<\/strong>. This determines the order of the hierarchy in relation to other hierarchies, on the Hierarchies page.\u00a0The ordinal must be a number greater than 0, or left blank.<\/p>\n

    Items will be ordered by their ordinal first, from lowest to highest. Items without an ordinal will then be ordered alphabetically.<\/p>\n

    An ordinal of 0<\/b><\/span>\u00a0indicates the hierarchy should be at the top of the list.<\/p>\n

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

    5. When you have finished, click the Save<\/strong> button in the top right corner.<\/p>\n

    Assigning Entities to the Hierarchy<\/h3>\n

    To assign entities to a hierarchy in IFS OI Server Management:<\/p>\n

    1. Open IFS OI Server Management, and click the Hierarchy\u00a0\"hierarchyicon\"\u00a0<\/strong>icon.<\/p>\n

    2. Click the name of the hierarchy.<\/p>\n

    3. Find an entity in the list (either by scrolling or searching for it) and then drag it onto the empty hierarchy box.<\/p>\n

    \"hierarchy-annot\"<\/a><\/p>\n

    Note<\/strong>: Currently, start and end times can only be specified using the import\/export spreadsheet.<\/p>\n

    4. Continue to drag entities onto the hierarchy.<\/p>\n

    You can also 'pin<\/strong><\/em>' desired entities to the top of its parent.\u00a0
    \nWhen an entity is pinned, it is reordered so that it becomes the first child of its parent, and an ordinal is set. When subsequent entities within the parent are pinned, they are moved to the bottom of the pinned entities\u00a0and are also set an ordinal.
    \nYou can then re-order the pinned entities\u00a0in the order you want. The remaining unpinned entities\u00a0will still be sorted alphabetically by Display Name<\/em>.
    \nNew entities\u00a0that are dragged to the list of pinned entities, will also be pinned by default.<\/p>\n

    5. When you have finished, click the Save<\/strong> button in the top right corner.<\/p>\n

    Done! Now that you have created and populated a hierarchy, your asset model is ready to use in IFS OI Explorer<\/a>.<\/p>\n

    Removing Entities from the Hierarchy<\/h3>\n

    When you want to remove an entity from a hierarchy, you are only severing the entity's relationship<\/em> with the hierarchy. To do this:<\/p>\n

    1. Click the entity you want to remove.<\/p>\n

    2. In the Relationship Details<\/strong> panel on the right, click Delete Relationship<\/strong>.<\/p>\n

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

    3. In the Are you sure?<\/strong> window:<\/p>\n

    \u00a0 A. Check the details of the Hierarchy Relationship<\/strong>.<\/p>\n

    Note: Deleting a hierarchy relationship also deletes all of the relationships below it in the hierarchy (i.e. the entity's children). The entities themselves remain in the system, but are removed from the hierarchy.<\/p>\n

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

    \u00a0 B. If you want to proceed, select the YES, I understand<\/strong> check box.<\/p>\n

    \u00a0 C. Click the Delete<\/strong> button. The entity is removed from the hierarchy, along with all its children.<\/p>\n

    Video<\/h3>\n

    Watch:<\/strong> this video [2:18] to see how to use the hierarchy editor. Note: This video is of an older version (4.5.0) of the hierarchy editor.<\/p>\n

    \r\n\t\r\n\t

    \u00a0<\/p>\n

    \n

    Import\/Export Spreadsheet<\/h2>\n

    The Import\/Export spreadsheet is generally only used to make bulk changes.<\/p>\n

    For details on the spreadsheet and how to obtain it, see\u00a0Exporting Your Configuration<\/a>.<\/p>\n

    If you want to create hierarchies as part of a bulk configuration, you need to\u00a0use the following\u00a0tabs in the Import\/Export spreadsheet<\/a>:<\/p>\n