Integrate APCM with AIM

To integrate AVEVA Point Cloud Manager (APCM) with AIM, follow the steps below:

Prerequisites

Ensure that the following deployments have been successfully completed and tested independently:

• AIM deployed in an on-prem environment using HTTPS.

• APCM deployed in CONNECT.

• An AIM-hybrid service enablement must be requested via your AVEVA account manager. This is for authentication and user management in CONNECT. As part of this activity, the account manager will need to provide the AIM on-prem URL so that it can be whitelisted for the cloud environment. AVEVA enables the requested environment in CONNECT and shares with the customer the required settings for configuring the on-prem part.

• The AIM user should be a user in a CONNECT account where APCM and AIM-h services are enabled. In addition, the user should have appropriate roles in the APCM service to access the project data, see CONNECT Roles.

Integration Steps

1. Obtain the Project ID by opening your APCM project in CONNECT. The Project ID can be seen in the URL, for example:

   

2. The Project ID value should be added directly to the bottom of the NetViewProject_null.xml file created during the AIM Project Publishing event. For example:

   

3. Import the class files, and the NetViewProject_null.xml file from the APCM Server, using the Import Controller.

4. 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 to the AIM-h service.

   1. Open the AIM web.config file.

   2. 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" />

   3. 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.	Owned by the customer.
      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:auth0SingleSignOutUrl	No	https://profile.connect.aveva.com/singlesignout	Logout Url for connect

      

   4. 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>

      

   5. Locate each PortalID section where the AIM-h CONNECT account is required within the web.config.

      <portal id="Default">

      <Account Value="" />

      

   6. 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-hybrid.

5. Deploy the JavaScript files onto the AIM machine.

   As part of the integration, it's necessary to add some JavaScript files to the machine that is hosting AIM. These JavaScript files can be downloaded from the following location (once APCM is updated):

   https://viewer.pointcloudmanager.connect.aveva.com/AVEVANET/LFM.AVEVANET.NetViewDirective.zip

   Note, If you are unable to access these files, please create a case in AVEVA's Global Customer Support (GCS) centre, using Product: Point Cloud Manager.

   • Download a copy of the LFM.AVEVANET.NetViewDirective.zip file and store it in a location that is accessible from the machine that is hosting AIM.

   • Log onto the machine that is hosting AIM.

   • Unzip the file.

   • Navigate to LFM.AVEVANET.NetViewDirective.zip\Content\Dashboard\App\Custom.

   • Copy the LFM NetView folder and place it in <Dashboard Name>\App\custom. Where <Dashboard Name> is the Dashboard site directory.

6. Create a new URL Rewrite rule.

   Add a URL Rewrite rule in IIS on the on-prem machine hosting the AIM project.

   7. Access the existing APCM project in CONNECT and capture the URL component shown below.

      

   8. Run the IIS Manager and navigate to the Dashboard site and select URL Rewrite. If URL Rewrite is not present, download it from the Web and install it.

      

   9. From the Actions section select Add Rule(s).

      

   10. Select Blank rule.

       

   11. Fill in each of the entries as shown below, with the captured URL component being added to the Redirect URL field.

       

   12. Select Apply and restart the Website in IIS. It is not required to add any Conditions or Server Variables.

       

   13. When you select the APCM project in AIM, you should be redirected to the APCM project.

Prevent Browser Tabs Unloading

This setting will make for a better user experience when working with AIM and APCM, and will prevent tabs unloading their cached data when switching tabs.

7. Log in to AIM with the Administrator role

8. Select the Settings icon and then select the Settings link.

   

9. Switch to the Site tab, expand General and select Tab Behaviour. Add the MIME type and save the settings.