Configure AIM-Integration Services using 3DVis Cloud

This section explains how to setup and configure AIM on-prem using the AVEVA 3D Visualization Service (3DVis) for 3D model visualization (AIM-Integration Services).

This requires AIM 6.0 or above to be used on-prem.

For New AIM-Integration Services Customers

For customers who want to integrate AIM On-prem with 3DVis Cloud Streaming Service:

CONNECT Configuration

1. Log into your AVEVA CONNECT account.

2. Go to Folder Management.

3. Open the folder where your AIM-Integration Services service is enabled, to further enable the 3DVis Cloud Streaming Service in the same folder.

    

4. After selecting the Folder, identify the 3DVis Cloud Streaming Service and open the sub-menu using the vertical 3 dots.

    

5. Select Manage integrations.

   All the 3DVis integration points for the CONNECT account are listed.

6. Enable the correct integration for the Folder/environment.

   

7. After selecting the Folder, identify the 3DVis Cloud Streaming Service and open the sub-menu using the vertical 3 dots.

8. To apply roles, open the sub-menu using the vertical 3 dots on 3DVis Cloud Streaming Service and select Manage roles.

   

9. After selecting Manage roles, the Roles screen will open. Use Assign role to create any new role assignments as follows:

   Type= Service role

   Service = 3DVis Cloud Streaming Service

   Folder = <The folder associated to the AIM instance>

   Role = Render User

   Models The access tags = Any 

   Groups = <Your CONNECT group you may wish to apply, for example, Power User> 

   Users = <specific usernames outside of groups> 

10. Select Save.

On-Prem Configuration

The customer administrator must perform the following steps to get the on-prem AVEVA AIM system ready to communicate with the cloud 3D Visualization service.

Deployment of AIM3DViewer

To deploy the AIM3DViewer with AIM:

11. Navigate to the AIM3DViewer folder that can be found under the installation folder.

    For example: C:\Program Files\AVEVA\AVEVA NET\Dashboard\AIM3DViewer

12. Create a folder AIM3DViewer under <site-path>/App/custom and copy the contents of the package to it.

    

Configure Firewall

Ensure your firewall is configured to allow the following setting:

inbound port 443 for source gnrl-3dvis-wps-ems2stllztel6.webpubsub.azure.com

Configure Settings

To enable caching of 3D models, so that models do not have to be reloaded when switching back to a tab containing a 3D model (as long as the return is within 10 mins), then add the MIME type application/rfc2 to the Memory Tab Types setting in the Site Settings. For more information, see Dashboard Settings.

Update the web.config file

After the deployment is done and the configuration settings have been received from AVEVA (as per the service request), some configurations need to be made to allow the on-prem AIM installation to connect with the cloud 3D Visualization service.

13. Open the AIM web.config file.

14. In the configSections section, insert the specified lines as indicated below:

    <section name="system.identityModel" type="System.IdentityModel.Configuration.SystemIdentityModelSection, System.IdentityModel, Version=4.0.0.0, Culture=neutral,PublicKeyToken=B77A5C561934E089" />
    <section name="system.identityModel.services" type="System.IdentityModel.Services.Configuration.SystemIdentityModelServicesSection, System.IdentityModel.Services, Version=4.0.0.0,Culture=neutral, PublicKeyToken=B77A5C561934E089" />

15. Proceed to the appSettings section and include the provided configurations:

    Key	Needs Modification?	Value	Additional Description
    avevanet:authenticationProvider	No	AIMHybrid	Fixed value, no changes required. The value will be AIMHybrid.
    avevanet:applicationRootUri	Yes	The HTTPS URL configured for the on-prem setup.	The value must be allowlisted by AVEVA.
    avevanet:authorityUri	Yes	https://signin.connect.aveva.com	CONNECT authority URI path.
    avevanet:dashboardClientId	Yes	As received from AVEVA.	Fixed value, no changes required (in prod-connect).
    avevanet:capabilityDefinitionName	Yes	Asset Information Management - hybrid	CONNECT capability definition name.
    avevanet:accountId	Yes	As received from AVEVA.	CONNECT account ID for the deployment.
    avevanet:workhubClientId	No	xyz	For an AIM-hybrid configuration, this value should be non-empty, but can have any string, for example, xyz.
    avevanet:auth0Authority	Yes	https://signin.connect.aveva.com	For Auth0 authentication.
    avevanet:serviceUAMUrl	Yes	https://services.connect.aveva.com/uam/v2/	For Auth0 authentication.
    avevanet:serviceSCMUrl	Yes	https://api.connect.aveva.com/scm/	For Auth0 authentication.
    avevanet:serviceAMUrl	Yes	https://api.connect.aveva.com/am/	For Auth0 authentication.
    avevanet:serviceAssetsUrl	Yes	https://api.connect.aveva.com/assets/v1/	For Auth0 authentication.
    avevanet:serviceAudience	Yes	https://services.connect.aveva.com	For Auth0 authentication.
    avevanet:resourceAudience	Yes	https://api.aimh.av.connect.aveva.com	For Auth0 authentication.
    avevanet:accessTokenCacheDuration	No	10	For Auth0 authentication.
    avevanet:serviceScopes	No	uam:read am:read scm:read ac_assets	For Auth0 authentication.
    avevanet:visApiUrl	Yes	https://services.connect.aveva.com/3dviscloud/v1
    avevanet:aim3DVisMaxCachedTabs	No	5	Used to define the min and max number of 3DVis tabs that can be cached. Max value is 7.
    avevanet:auth0SingleSignOutUrl	Yes	https://profile.connect.aveva.com/singlesignout	Logout Url for connect

    

16. Configure the authentication under <system.webServer> to use anonymousAuthentication exclusively. Remove any references to Windows Authentication. Ensure that the locally hosted AIM site authentication is also set to anonymous.

    <authentication>

    <anonymousAuthentication enable="true" />

    </authentication>

    

17. In the web.config file, locate each PortalID section where the 3D Visualization service is required and specify an Account Value and a Folder. For example:

    <portals>

    <portal id="Default">

    <Account Value="123XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" />

    <Folder Value="456XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" />

18. Append the following section towards the end of the web.config file.

    <system.identityModel>
    <identityConfiguration>
    <claimsAuthenticationManager type="AVEVA.NET.Dashboard.Infrastructure.DashboardClaimsAuthenticationManager, AVEVA.NET.Dashboard" />
    </identityConfiguration>
    </system.identityModel>

    

    When this configuration is completed, the on-prem AIM setup will be able to connect to AIM-Integration Services.

19. Ensure that the following entry is in the web.config file under <system.webServer> -> <staticContent>:

    <mimeMap fileExtension=".proto" mimeType="application/protobuf" />

Managing Users

For general user management in CONNECT, please refer to https://docs.aveva.com/bundle/aveva-connect/page/885352.html.

For a User Visualizing 3D models in the AIM Dashboard

Detailed users’ access and rights are still managed and configured through the AIM on-prem installation via the web.config file. However, for the AIM-Integration Services solution, users also need to be declared in CONNECT to allow them to access the 3D Visualization Service.

When a user logs in to the AIM Dashboard, the system will check if the user can access the cloud service using the CONNECT users' permission, and then check the permission and data access rights that have been setup on-prem for the given user.

Users created in CONNECT for AIM-Integration Services will need to have the default user role available under the Asset Information Management hybrid service role for the given folder.

For a User Loading into the AVEVA Data Pipeline

The user responsible for loading 3D models can use the Load Reporting component to be able to monitor the upload and import status in the 3D visualization service. To do so, the user needs to have the Data Pipeline user and Load reporting user roles. For more information, see https://docs.aveva.com/bundle/asset-information-management/page/1093967.html.

Upload and Process 3D Models

The cloud 3D Visualization service is only processing the 3D model files, the EIWM information remains on-prem. To view 3D models in AIM that are streamed from AIM-Integration Services perform these steps:

20. Process the associated EIWM files on-prem using the AVEVA Import Controller.

21. Upload the 3D Model files to the AVEVA Data Pipeline using the Ingestion API. This can be done using a tool such as Postman or the AVEVA Gateway Data Publisher (GDP).

Uploading 3D Models into the Cloud

To be able to upload data into the cloud you will need to have a CONNECT token defined. For more information, see https://docs.aveva.com/bundle/asset-information-management/page/1252243.html

Before configuring the 3D model upload, ensure you have the following information:

• Account Name (assetId) – if your AIM-Integration Services solution is enabled at an account level.

• Folder Name - if your AIM-Integration Services solution is enabled at a folder level.

The uploading of 3D model files to the AVEVA Data Pipeline can now be defined using the Ingestion API. To do this, use a tool such as PostMan or the AVEVA GDP.

• For more information on Loading Data using the Ingestion API, see: https://docs.aveva.com/bundle/asset-information-management/page/1174972.html

• For details on the Ingestion API Request Parameters, see: https://docs.aveva.com/bundle/asset-information-management/page/1174973.html

• For details on monitoring loads of 3D models to the cloud, see: https://docs.aveva.com/bundle/asset-information-management/page/1047888.html

• If you want to use the GDP, see: https://docs.aveva.com/bundle/asset-information-management/page/1232722.html

Example of 3D GDP Configuration File

{

"Version": "1.2.0",

"Logger": {

"OutputPath": "C:\\temp\\staging area\\logs",

"LogLevel": "Trace"

},

"Processor": {

"Tables": [],

"Rules": [

{

"FilterId": "3D",

"Actions": [

"SetValue('Target', 'Model')",

"SetValue('Source', '3DModel')",

"SetValue('Context', '')"

]

}

]

},

"Publisher": {

"TokenName": "<Name of the Token identifier used when saving Service Token (saved as)>",

"BatchFilesUploadLimit": 100,

"DelayBetweenRetries": "0:00:00:01.00",

"ConnectionRetries": 6,

"DefaultEndPointUrl": "<api endpoint as provided>",

"DefaultAssetId": "<name of the CONNECT folder>"

}

}

Example of GDP Initialization File

{

"Version": "1.2.0",

"InitCommands": [

{

"Name": "A Folder Name",

"Args": [

{

"Name": "instance-name",

"Value": " A Folder Name "

},

{

"Name": "logs-location-path",

"Value": "C:\\temp\\staging area\\logs"

},

{

"Name": "config-file-path",

"Value": "C:\\temp\\staging area\\config\\<3D configuration filename.json>"

},

{

"Name": "watched-directory",

"Value": "C:\\temp\\staging area\\models"

}

],

"Options": [

{

"Name": "show-console"

}

]

}

]

}

Example of GDP Filter File

{

"Filters": [

{

"Type": "FileNameFilterCfg",

"Id": "3D",

"PassFiles": [

"*.rvm",

"*.zgl"

]

}

]

}

Additional Considerations:

• Source 3D file names MUST be unique within a folder.

• DefaultAssetId – is determined by AVEVA, as this is a Cloud storage location under the primary account.

• Under the Access Control List (ACL) section, users can be added to restrict access to required portals only, see: https://docs.aveva.com/bundle/asset-information-management/page/999848.html

• AIM-Integration Services will only use a single user email address or email Distribution Lists (DL) and NOT Active Directory User Groups (AD).

Once the 3D model is uploaded you can monitor the progress of the conversion and import via the load reporting component. For information about load reporting, see: https://docs.aveva.com/bundle/asset-information-management/page/1047888.html

Deleting 3D Models

For details on deleting 3D models that have been uploaded to the cloud, see: https://docs.aveva.com/bundle/asset-information-management/page/1393831.html

Uploading EIWM Data

This is done on-prem using the Import Controller, with the following value definitions:

• InfoLocator: <Value>{Model name}.rvm</Value>

• InfoType: <Value>application/rfc2</Value>

A sample EIWM object:

<vl:VNETList xmlns="http://www.aveva.com/VNET/eiwm" xmlns:vl="http://www.aveva.com/VNET/List">

<Template>

<ID>SampleModel::Template</ID>

<Object>

<ID>SampleModel</ID>

<Context>

<ID>SampleModelSub-Context </ID>

<Context>

<ID>SampleModelContext</ID>

</Context>

</Context>

<Name>SampleModel 3D Cloud</Name>

<ClassID>3D MODEL</ClassID>

<Association type="is fulfilled by">

<Object>

<ID>SampleModel.rfc</ID>

<Context>

<ID>SampleModelContext</ID>

</Context>

<ClassID>FILE</ClassID>

<Characteristic>

<Name>InfoLocator</Name>

<Value>SampleModel.rvm</Value>

</Characteristic>

<Characteristic>

<Name>InfoType</Name>

<Value>application/rfc2</Value>

</Characteristic>

</Object>

</Association>

</Object>

</Template>

</vl:VNETList>