AVEVA AIM Viewer

The document viewing area of the AIM Dashboard can be accessed through an embedded browser component in a desktop application.

Append the following to your AIM Dashboard web address:

• viewer?documentId={Document full Id}&tagId={Tag full Id}

  For example: http://localhost:16000/viewer?documentId=IPE|VPD|Area-15A&tagId=IPE|E-9001

  Parameters

  Parameter	Mandatory	Description	Value (Example)
  documentId	Yes	Full ID of the Document to be rendered.	IPE|905676
  tagId	No	Full ID of the Tag to be highlighted in the Document.	IPE|E-9002
  fileId	No	Some documents can have multiple files (compound documents). If you want to display any file other than the primary file, use this parameter. Note: The file with the fileId must be a file of the document with documentId.	IPE|905676.svg

There is a sample application located in INSTALLDIR\Dashboard\Samples\DashboardViewerSample.zip which shows a sample hosting the viewer.

Handling Events

The following section describes how to handle selection events in the viewer when using the System.Windows.Forms.WebBrowser control:

• To enable the JavaScript to call your C# application hosting the WebBrowser set ObjectForScripting to a COM Visible object any time before the URL is set on the control.

• The method called on viewer selection is OnViewerSelection and one argument is passed identifying the tag that has been selected.

For example:

[PermissionSet(SecurityAction.Demand, Name = "FullTrust")]
[System.Runtime.InteropServices.ComVisibleAttribute(true)]
public class ScriptInterface
{
public void OnViewerSelection(String message)
{

}
}