{"id":24906,"date":"2017-03-02T08:47:54","date_gmt":"2017-03-02T00:47:54","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=24906"},"modified":"2017-08-15T09:43:46","modified_gmt":"2017-08-15T01:43:46","slug":"links-and-the-table-of-contents-4-4-0","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/configuring-your-system\/links-and-the-table-of-contents\/links-and-the-table-of-contents-4-4-0\/","title":{"rendered":"Links and the Table of Contents (4.4.0)"},"content":{"rendered":"\n

This article applies to P2 Server versions 4.4-4.4.4. For more, see Links and the Table of Contents<\/a>.<\/p>\n

This article describes how to create links (previously called renderers<\/em>) in P2 Server Management and group them for display in the P2 Explorer ribbon. For information on how to assign links to a template, see: Creating Templates and Attributes<\/a>.<\/p>\n

In P2 Server, links can be assigned to templates. When a template with assigned links is designated as the primary template for an entity, those assigned links will appear in the entity's Table of Contents in P2 Explorer. Here is an example of a Table of Contents for entity Bossier 1-1:<\/p>\n

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

Links can be organised into groups for display in the Table of Contents, or may remain ungrouped. The default link on a template will appear as the first link in the Table of Contents, and will be larger than the other links.<\/p>\n

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

What can you link to?<\/h2>\n

You can create links to an Explorer page or trend by specifying the GUID for the page or trend.\u00a0You can also link to a URI, which can be an external website.<\/p>\n

An important capability is that you can also use expressions inside links to drive custom URLs. This provides the ability to open custom reports in an external system with data from P2 Server. These systems include document management systems, maintenance systems, reporting systems, or even custom third party systems,\u00a0as long as they accept the parameters.<\/p>\n

Examples<\/h3>\n

Simple well report<\/strong><\/p>\n

The following example opens an external website in a new browser window, and passes through the name of the entity selected in P2 Explorer (or another application that can consume these links):<\/p>\n

https:\/\/myExternalSite\/openWellReport?Well=EXPR(ENTITY)<\/pre>\n
Well report with dates<\/strong><\/p>\n
This example opens an external website in a new browser window, and passes through the name of the selected entity, as well as\u00a0the start and end of the current production day (calculated at the time the link is clicked):<\/p>\n
https:\/\/myExternalSite\/openWellReport?Well=EXPR(ENTITY)&StartTime=EXPR(ProductionDayStart(Time()-86400))\r\n&EndTime=EXPR(ProductionDayStart(Time()))<\/pre>\n
Well report with live tag data<\/strong><\/p>\n
This example opens an external website in a new browser window, and passes through the name of the selected entity, as well as the value of a historian tag (Silver), at the time the link is clicked:<\/p>\n
https:\/\/myExternalSite\/openWellReport?well=EXPR(ENTITY)&CurrentValue=EXPR({Silver,sampleMethod='Raw'})<\/pre>\n
\u00a0<\/p>\n
Server Management<\/h2>\n
There are 2 main parts to creating a Table of Contents:<\/p>\n
    \n
  1. Creating the link groups.<\/li>\n
  2. Creating the links.<\/li>\n<\/ol>\n
    The only prerequisite is that the thing you are linking to must already exist.<\/p>\n
    Once the links are\u00a0created, they can be assigned to a template<\/a>\u00a0- this step will also define the default link for entities that have the template designated as primary.<\/p>\n
    Creating a Link Group<\/h3>\n
    To create a link group in P2 Server Management:<\/p>\n
    1. Open P2 Server Management, and click the Configuration<\/strong> \"configurationicon\"<\/a>\u00a0icon.<\/p>\n
    2. Click Link\u00a0Groups<\/strong>.<\/p>\n
    3. Click Create New Link\u00a0Group<\/strong>.<\/p>\n
    Note: If you want to edit an existing group, select\u00a0it from the list below the Create button.<\/p>\n
    <\/a><\/p>\n
    4. Give the link\u00a0group 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 link\u00a0group\u00a0and how it will be used.<\/p>\n
    Related: Reserved Characters & Keywords<\/a><\/p>\n
    <\/a><\/p>\n
    5. When you have finished, click the Save<\/strong> button in the top right corner.<\/p>\n
    \u00a0<\/p>\n
    Creating a Link<\/h3>\n
    To create a link in P2 Server Management:<\/p>\n
    1. In\u00a0P2 Server Management, and click the Configuration<\/strong> \"configurationicon\"<\/a>\u00a0icon.<\/p>\n
    2. Click Links<\/strong>.<\/p>\n
    3. Click Create New Link<\/strong>.<\/p>\n
    Note: If you want to edit an existing link, select\u00a0it from the list below the Create button.<\/p>\n
    <\/a><\/p>\n
    4. Fill out the following information:<\/p>\n