Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

Asset Framework and PI System Explorer (PI Server 2018)

Create URI Builder data references

  • Last UpdatedJan 11, 2023
  • 5 minute read

When a URI Builder data reference is used in a template, value substitution takes place at run time.

Copy an existing web link or AVEVA PI Vision link and make it dynamic in a URI Builder data reference in which you substitute part of the URI with a value derived from an attribute, an attribute reference or a substitution parameter. You assign the dynamic web link value or AVEVA PI Vision link value to an attribute template or attribute.

  1. Open a web browser and locate the web link or the AVEVA PI Vision link you use as a starting point in creating a link value on an attribute template or attribute.

  2. Select the entire URI and copy it.

  3. In the navigator pane of PI System Explorer, choose from the following actions.

    To create a URI data reference on ...

    Do this ...

    A template

    1. Click Library.

    2. Expand Templates in the browser tree.

    3. Choose a template type and select an existing template, or click New Template.

    An element

    1. Click Elements.

    2. Select an existing element in the browser tree, or click New Element.

    A model

    1. Click Elements.

    2. Select an existing model in the browser tree, or right-click and click New Model.

    An event frame

    1. Click Event Frames.

    2. Expand a search collection for event frames in the browser tree.

    3. Select an existing event frame, or click New Event Frame.

    A transfer

    1. Click Event Frames.

    2. Expand a search collection for transfers in the browser tree.

    3. Select an existing transfer or click New Transfer.

  4. Choose from the following actions.

    • In the Attribute Templates tab, select an existing attribute template, or click New Attribute Template to create a new attribute template.

    • In the Attributes tab, select an existing attribute, or click New Attribute to create a new attribute.

  5. In the attribute configuration panel, configure the attribute template or attribute as needed, and choose URI Builder from the Data Reference drop-down list.

  6. Click Settings.

  7. In the URI Builder Data Reference window, click in the Paste a URI from a web browser to use as a template for configuration field and paste the URI you copied in step 2.

  8. Click Continue.

    The pasted URI is displayed in the URI Builder Data Reference window, broken down into its Scheme, Address or Host, Port, and Path field components. If the URI contains queries and fragments, those are also displayed in the Query and Fragment fields.

  9. In the URI Builder Data Reference window, choose one of the following actions.

    To configure ...

    Do this ...

    A dynamic web link

    Modify the components of the pasted URI as needed.

    • You can choose between Scheme values of http and https.

    • You can change the Port value to any number between 1 and 65535. The default values for http and https schemes are 80 and 443 respectively.

    • To make portions of the Path field dynamic, select a segment. Then click and select from the following options:

      • A list of other attributes for the selected object. Note that attributes must appear in single quotes.

      • A list of attribute references. You can also select Search to enter search criteria in the Attribute Search window.

      • A list of commonly used substitution parameters. For more information, see List of PI AF substitution parameters.

    • In the Query table, you can modify Key and Value settings as needed.

      • To add a key, click . In the Key and Value fields, type a value or click and select from the same options as above.

      • To delete a parameter, select a key or value and click .

    A AVEVA PI Vision link

    1. Click the PI Vision option.

    2. In the Display field, modify the value as needed. You can also click and select from the following options:

      • A list of other attributes for the selected object. Note that attributes must appear in single quotes.

      • A list of attribute references. You can also select Search to enter search criteria in the Attribute Search window.

      • A list of commonly used substitution parameters. For more information, see List of PI AF substitution parameters.

    3. In the Parameters table, modify Key and Value settings as needed.

      • To add a key, click . In the Key field, click , select a parameter and assign a value. In addition to typing a value you can select from the same options as in step b above.

      • To delete a parameter, select a key or value and click .

      When linking to a display on an event frame, URI Builder automatically adds Asset, Start Time and End Time parameters. For more information on other parameters, see the AVEVA PI Vision topic URL parameters reference.

  10. Click OK.

TitleResults for “How to create a CRG?”Also Available in