Import Viewpoint into AIM On-prem

The Viewpoint feature enables you to save and restore specific views and states of 3D models within the 3D Viewer.

• This feature allows you to capture important perspectives, configurations, and visual states of your 3D models for future reference and collaboration.

• This feature enables importing viewpoints from Navisworks Gateway into AVEVA AIM On-prem via JSON files, through Import Controller mirroring the 3D model import workflow.

Prerequisites

• A new version of the 3D gateway that generates viewpoint JSON files.

• A 3D model must already exist in AIM before viewpoints can be created for the 3D model.

• The gateway outputs viewpoint data in a JSON file that ends with _viewpoint.json.

• A staging area (a folder accessible to the Import Server) must be identified and used as the output location for the gateway.

Feature highlights

This feature enables importing viewpoints created in an external system such as Navisworks into the AIM On-prem and apply and view the viewpoints.

The 3D gateway is used to transform viewpoints from Navisworks into a JSON file.

The import is enhanced with the capability to process a JSON file, extract the viewpoint information and create them in the AIM application.

Import the JSON using Import Controller

A staging area is a network-accessible folder that stores documents and subfolders for import into AIM On-prem. The staging area can reside in any location that is accessible to the Import Server.

1. Identify the appropriate staging area and configure it as the output directory for the 3D Gateway.

2. Run the 3D Gateway. The gateway generates:

   • A .zgl file for the 3D model.

   • A JSON file with the suffix _viewpoint.json.

3. Open Import Controller and navigate to the output directory.

4. Locate the _viewpoint.json file. The file status is displayed as New.

5. Right-click the file and select Update File or Force Update File.

   Wait for Import Controller to process the file.

6. Verify that the file status changes from New to Existing.

   Monitor the import progress in the Log pane. The displayed messages are similar to those shown in the following example.

   

Input format JSON

Below is the high level JSON format and contents.

• The gateway JSON payload must include:

  • ModelFullId: The full path of the 3D model in AIM, used to associate the viewpoints with the correct model.

  • Viewpoints: An array containing one or more viewpoints. Each viewpoint includes:

    • ViewpointName: The display name in AIM for the viewpoint (must be unique for the model).

    • ViewState: A JSON object with the viewpoint configuration, including at minimum the camera information (position and orientation). It may also include highlights, clipping, isolation, rendering settings, and other view-related properties. The structure must align with the ViewState format used by AIM’s 3D viewer.

• The key elements are:

  • ViewpointName: unique per model

  • ViewState: includes camera (position and orientation) plus other optional view settings

  • The entire payload must be valid JSON and conform to the expected schema so the Import Controller can process the JSON correctly.

• File naming: The viewpoint JSON file name must end with _viewpoint.json so the Import Controller can route it to the correct processor.

  {

  "ModelFullId": "{Contains the complete context of the 3D Model}",

  "Viewpoints": [

  {

  "ViewpointName": "Import_Multiple_1",

  "ViewState": {

  "camera": {

  "position": {"x": 1534.62, "y": 164.58, "z": 789.43},

  "orientation": {"x": 0.142, "y": -1.560}

  },

  "currentlyHighlighted": {"selectedTags": {"348554": []}, "position": {"x": 0, "y": 0, "z": 0}},

  "clip": {"active": false},

  "section": {"active": false},

  "navigationMode": {"mode": "orbit"},

  "measureInfo": {"measures": []},

  "views": {"isXrayEnabled": false, "isShadowsEnabled": false, "isInsObstEnabled": false},

  "materialChanges": {},

  "hide": {"tags": {}},

  "isolate": {"tags": {}},

  "settings": {"dome": "04", "renderQuality": "MID", "triangleDecimation": "false"}

  }

  }

  ]

  }

View the imported Viewpoint

Once Import Controller has successfully processed the JSON file, perform the following steps:

7. Open the target 3D model in the AIM OnPrem 3D viewer.

8. Open the Tools menu and select Viewpoint to display the imported viewpoints.

   The usual AIM access rights apply.

Considerations and limitations

• 3D model must exist prior to viewpoint import; viewpoints cannot be created for non-existent models

• No support for modal composition in initial design

• The viewpoint file must end with _viewpoint.json suffix.

• Imported viewpoints visible in AIM portal 3D viewer are subject to normal access rights