URL parameters reference

Asset=<path>

Configures an existing display to swap related assets that share the same PI AF template. Specify the assets by appending Asset to the URL, followed by the path of the new asset.

Path for a data item on a PI AF server:

\\ServerName\DatabaseName\ParentElement\ChildElement

Syntax rules:

• Multiple assets are delimited by semicolons. A full server path must be provided for each asset.

  Example:

  https://webserver/pivision/#/Displays/15914/BoilerInformation?Asset=\\AFServer1\Houston\CrackingProcess\Equipment\Boiler309

Calculations= <JSON string>

Specifies calculations for a temporary (ad hoc) AVEVA PI Vision display. These calculations do not appear on the display symbol unless a corresponding data item refers to the calculation. For additional details, see Temporary (ad hoc) displays with calculations.

Syntax rules:

• Must be a valid JSON string that defines any calculations referenced by data items.

• See Calculation parameter reference for details on how to define calculation objects in the JSON string.

  Example:

  
  https://webserver/pivision/#/Displays/AdHoc?DataItems=calc:Temperature.Value;calc:Level.Maximum&Calculations=[{"Name":"Temperature","Server":"piserver","Expression":"'CDT158'-100"},{"Name":"Level","Server":"piserver","Expression":"'BA:Level.1'-25"}]
  
  

DataItems=<path>

Specifies a data item or multiple data items for a temporary (ad hoc) AVEVA PI Vision display.

Path on a PI AF server:

\\ServerName\DatabaseName\ParentElement\ChildElement|ChildAttribute

Path on a Data Archive server:

\\ServerName\TagName

Syntax rules:

• Attributes are delimited by the pipe (|) character.

• Multiple data items are delimited by semicolons. A full server path must be provided for each data item.

• If the DataItems parameter specifies an asset, all of its plottable attributes appear in the symbol.

  Example:

  https://webserver/pivision/#/Displays/AdHoc?DataItems=
  \\AFserver1\Houston\B-210|Temperature;\\AFserver\B-210|Pressure;

HideSidebar

Hides the sidebar of a display.

Example:

https://webserver/pivision/#/Displays/AdHoc?DataItems=
\\AFserver1\Houston\B-210|Temperature&HideSidebar

Note: Hide parameters can also be assigned a true or false value. So, for example, if a display has the HideSidebar set and it contains a link to a different display, that link can include HideSidebar=false so that the side bar will be shown.

HideTimebar

Hides the timebar of a display.

Example:

https://webserver/pivision/#/Displays/AdHoc?DataItems=
\\AFserver1\Houston\B-210|Temperature&HideTimebar

(See the note for HideSidebar.)

HideToolbar

Hides the toolbar of a display.

Example:

https://webserver/pivision/#/Displays/AdHoc?DataItems=
\\AFserver1\Houston\B-210|Temperature&HideToolbar

(See the note for HideSidebar.)

Mode=kiosk

Specifies how an existing display should be presented. In the kiosk mode, you cannot search for data or save the display.

https://webserver/pivision/#/Displays/3117/PowerAnalysis?mode=kiosk

Redirect=false

Overrides the AVEVA PI Vision redirect to a mobile site. By default, a user of a smaller device or browser is redirected to the AVEVA PI Vision mobile website. Use this parameter to bypass this behavior, such as when you embed an AVEVA PI Vision display in your own dashboard.

Example:

http://webserver/pivision/#/Displays/3117/PowerAnalysis?redirect=false

Rootpath=<path>

Configures an existing display to swap a parent (or other ancestor) asset for the child assets on the display. Specify the root by appending rootpath to the URL, followed by the path of the new parent asset.

Example:

https://webserver/pivision/#/Displays/39189/Wind-Farm-Temperatures?rootpath=\\csaf\windpowergenfleet\Wind Power Generation Fleet\Big Buffalo Wind Farm

StartTime=<PI time>

EndTime=<PI time>

Specifies the start and end time of a display.

Note: Start and end times must be used in pairs. We recommend using ISO 8601 standards because they are not affected by time zones. When using a time zone designator with ISO 8601, specify your offset from UTC with ±[hh]:[mm] format.

For more information, see Set the time zone for a display.

Example:

https://webserver/pivision/#/Displays/202?starttime=2017-10-25T12:50:49.755Z&endtime=2017-10-25T13:50:49.755Z

Symbol=<symbol type>

Specifies the symbol type that appears in a temporary (ad hoc) display. Valid symbol types include verticalgauge, horizontalgauge, radialgauge, table, trend, value, xyplot, and ACT (asset comparison table). The number of data items supported varies by symbol. Asset comparison tables do not support PI points. If no symbol is specified, a trend is the default symbol type for a temporary (ad hoc) display.

For example, to change the symbol type to a table, use the Symbol=table parameter:

https://webserver/pivision/#/Displays/AdHoc?DataItems=
\\AFserver1\Houston\B-210|Temperature&Symbol=table

To configure a temporary (ad hoc) trend that shows only one value scale when there are multiple data items, include the Symbol=trend parameter with the MultipleScales=false setting:

https://webserver/pivision/#/Displays/AdHoc?DataItems=
\\afserver\B-210|Temperature;\\piserver\aPIPoint&Symbol=trend;MultipleScales=false

TZ=<time zone name>

Specifies a time offset from UTC time (Coordinated Universal Time) so that users see data in the time zone you specify. The TZ parameter can also specify Windows (for example, Eastern Standard Time) or IANA (for example, America/Denver) time zone names.

Syntax:

• There cannot be any spaces within the time zone offset specification.

• The offset can be positive or negative. To apply a positive offset, you must encode the + (plus) sign as %2B.

• You can enter the time offset in either of the following formats: H:MM or HH:MM.

  Example:

  https://webserver/pivision/#//Displays/3117/PowerAnalysis?tz=UTC-5:00