AVEVANet

The AVEVANet node is specifically designed to enable XR to connect to AVEVA NET™ and AVEVA™ Asset Information Management (AIM) instances to retrieve asset-related data.

Platform support

This node is fully supported on XR-Windows, XR-Portable iOS, and XR-Portable Android platforms.

Managing the connection

The connectionMode field enables you to specify the connection mode:

• anonymous. There is no need to supply user credentials. This approach can be used where the user is already connected and logged in to AVEVA NET dashboard. Can be used when connecting to AVEVA NET only.

• login. The user must supply a username and password to connect. Can be used when connecting to AVEVA NET only.

• token. This mode is reserved uniquely for connecting to AIM and requires the application to be started with cloud licensing (LAAS). On portable platforms (iOS and Android), the AVEVA Connect startup sequence needs to be enabled to fetch the tokens from the AVEVA Connect Servers.

The uri and portalID fields are used to define the instance to connect with. The role must be set to one of the roles available to the user that connects.

Use connect and disconnect to establish and close the connection with the server. The connectionState field can be used to verify connection success.

Note: Any change made to any of the following fields: -connectionMode, -username, -password, -role, -uri, -portalID will automatically force disconnection.

Managing queries

You can execute a query only when the connection is up and running.

Note: To successfully execute a query on a saved search, that shared search MUST have been installed on the AVEVA NET or AIM instance.

Perform a query

1. Specify the savedSearch to be use for the query.

2. Specify the context in order to restrict the search.

3. Use the query field to pass parameters to the saved search and trigger its execution.

Inspect a query

• Inspect the queryError field to check the query execution state.

The value of the queryError field changes to undefined when the query starts. The value then changes to error or ok, depending on query success or failure.

When the queryError value reads ok, you can read the results of the query in the queryResult field.

Note: The queryResult table is made up of 21 columns and requires at least basic AVEVA NET or AIM knowledge to be able to interpret its content.

Getting document addresses

When the connection is up, it is possible to retrieve a document ID from the AVEVA NET instance.

By using the getDocumentAddress, the node returns the http address for retrieving the document. This address can be used, for example, to open a link inside the DocumentViewer.

Code example

This is a code example for the AVEVANet node.

<AVEVANet name="anetClient" uri="http://inhyzse3d02:16000/" portalId="GCD32" role="Administrator" />

Node fields

These are the fields for the AVEVANet node. Only the node-specific fields are indicated, not fields obtained by inheritance.

Field inheritance: NodeBase > AVEVANet