Configure Point Cloud Manager on CONNECT and AIM On-Premise integration

To configure AVEVA Point Cloud Manager (APCM) on CONNECT with AVEVA Asset Information Management (AIM) on-prem integration, follow the steps as mentioned in the subsequent sections.

Prerequisites

• APCM on CONNECT (latest version is used automatically).

• AIM on-prem (minimum version 5.1.12).

• AVEVA Gateway for 1D Data (any version).

Required access and permissions

You must have the following access rights to successfully perform the actions described in this section:

• CONNECT

  • Account administrator role

  • Administrators role in APCM include the following:

    • Administrator

    • Administration page user

    • Guest user

• On-prem

  • Full admin access to the AIM on-prem servers

Considerations

Project requirements: The project must have these:

• 3D markups (tags)

• an integrated RVM/FBX/IFC model

• or both

During integration, the AIM tag names are associated with the laser 3D markup (or model if present).

To perform the steps in this topic, you must be familiar with the following:

• administering AIM on-premises and

• importing data into the system.

Base XML files for AIM

Bootstrap (AIM database class definition)

For example, add a document class definition for a laser scan document called LASER SURVEY (or any other name you prefer) to your AIM database bootstrap.

Note: Using the following instructions, you no longer need to use APCM Server or Desktop to publish to AIM on-prem.

<Class>

<ClassID>LASER SURVEY</ClassID>

<ParentClassID>DOCUMENT CONTENT</ParentClassID>

<ClassName>PCM Viewer Project</ClassName>

<PluralName>PCM Viewer Projects</PluralName>

<Visible>true</Visible>

</Class>

Project registration (register an APCM Viewer project in AIM)

To connect your APCM Viewer project to your AIM database, create the following XML file manually.

This <Object> node must be replicated for every PCM project you wish to integrate with.

<?xml version="1.0"?>

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

<Template>

<ID>PCM_#PCMProjectName#_null.xml</ID>

<Object>

<ID>PCM_#PCMProjectName#</ID>

<Context>

<ID>#AIMProjectId#</ID>

</Context>

<ClassID>LASER SURVEY</ClassID>

<Association type="is fulfilled by">

<Object>

<ID>File: PCM_#PCMProjectName#</ID>

<Context>

<ID>#AIMProjectId#</ID>

</Context>

<ClassID>FILE</ClassID>

<Characteristic>

<Name>InfoLocator</Name>

<Value>@#PCMProjectId#</Value>

</Characteristic>

<Characteristic>

<Name>InfoType</Name>

<Value>application/x-lfm</Value>

</Characteristic>

</Object>

</Association>

</Object>

</Template>

</vl:VNETList>

API setup

This section provides details relating to create and store a token.

Create a token (one token per project)

To create a token:

1. Create a SAT (Service Access Token) for the project you are integrating with.

2. Set the expiration as required.

   Guest User is sufficient for integrating with AIM (and limits privileges to what is required).

3. Copy the token and store it securely.

Store a token (one token per project)

The Information for each integrated APCM project is automatically stored in a CSV control file with the following columns:

• AIMProjectId: Name of your AIM database or package matching the APCM project.

• PCMProjectId: Obtained from the APCM admin page.

• PCMProjectName: Project name (for reference).

• PCMSolutionId: Obtained from the APCM admin page.

• APILocation: Depends on the region, you can obtain this from the APCM admin page.

• SAT: The token created in the previous step.

Example

AIMProjectId,PCMProjectId,PCMProjectName,PCMSolutionId,APILocation,SAT

Eaton,42d1ffd1-99e1-4117-b0d6-a129c77cc26b,EATON_EXPERIENCE_CENTRE_R2,e43526ed-ada3-4c56-8fd9-c530206dc8be,services-eu-west-1,***

Tag associations XML files for AIM

Use API

Use APCM API to retrieve the project information. (https://docs.pointcloudmanager.connect.aveva.com/):

With the project information make GET calls to the following endpoints:

• Pointclouds/<Proj_ID>/scans: This returns all the scans in the project.

• Annotations/<Proj_ID>/Markups:This gets all the markups in the project.

• Viewer/<Proj_ID>/Objects: This returns all objects in a project.

• Viewer/<Proj_ID>/Objects/<Model_ID>/Names: This returns all the model names for an Object.

You can export the returned information into a CSV file. For assistance in writing API script, you can create a APCM case through AVEVA software support.

Set up a PowerShell script to run the API

For implementing a single APCM Viewer instance, at minimum, your script must follow these:

• Request Scans, Markups and 3D objects via the APCM API.

• Export results from the two previous calls to an output CSV file.

• Process the output CSV with Gateway for 1D Data to publish results to the AIM Staging Area.

Process manually

To update your tag associations for the PCM project on demand, run the previously created script and update the results via the AIM Import Controller.

AVEVA recommends using the following automation approach to update these tag associations automatically and regularly, without requiring user interaction.

Manage multiple APCM projects

You can extend the API export method to include multiple APCM projects. This can happen by using multiple single project Tokens and creating a Projects csv file for the script to read.

Another option is to use long-lived access tokens, provided the APCM account has access to Project Management. For details on token availability, configuration and usage contact AVEVA support.

Automation

Automate updates with Windows Task Scheduler

These associations must be updated automatically. Ensure that every change made in APCM Viewer is also updated in AIM on-premises.

To automate the setup, create a Windows Task Scheduler task that runs the PowerShell script based on your desired schedule.