# CAXperts Help Portal

> Product documentation and help for CAXperts products. Each link points to a documentation page; known AI/bot user-agents receive the raw Markdown directly.

## UDiTH

- [Introduction](https://help.caxperts.com/UDiTH/Introduction): The UDiTH infrastructure consists of the following components:
- [Moving from UPV to UDiTH](https://help.caxperts.com/UDiTH/Moving%20from%20UPV%20to%20UDiTH)

## UDiTH App

- [Introduction](https://help.caxperts.com/UDiTH%20App/Introduction): UDiTH is an easy-to-use tool that brings digital twins of your models, such as chemical plants, ships, offshore platforms, and buildings, to any device running…
- [Setup](https://help.caxperts.com/UDiTH%20App/Setup): - Run the .exe created by UDiTH Builder. - Alternatively, download and run the .exe from the CAXperts download page.
- [What's new](https://help.caxperts.com/UDiTH%20App/What%27s%20new): UniversalPlantViewer has been rebranded as UDiTH. This change also applies to the names of the .exe files. Please update any batch files accordingly to ensure…
- [Start Window](https://help.caxperts.com/UDiTH%20App/Start%20Window): After starting UDiTH, you will see a list of projects together with additional information about them.
- [Multi-Window System](https://help.caxperts.com/UDiTH%20App/Multi-Window%20System): The tabs within UDiTH can be customised using drag and drop. The Search, Files, Attributes, and many other tabs can be repositioned easily by clicking and…
- [Navigation](https://help.caxperts.com/UDiTH%20App/Navigation): On touch devices, you can navigate like this:
- [Camera](https://help.caxperts.com/UDiTH%20App/Camera): UDiTH offers three camera modes. After loading a new model, UDiTH starts in Orbit mode by default.
- [Objects](https://help.caxperts.com/UDiTH%20App/Objects): Select one or more objects by clicking the checkbox next to them or their name in the navigation bar (tree view) at the top of the screen.
- [Tools](https://help.caxperts.com/UDiTH%20App/Tools): The Tools menu contains specialised functions and options for working with your model.
- [Additional objects](https://help.caxperts.com/UDiTH%20App/Additional%20objects): Open additonal objects panel
- [Custom attributes](https://help.caxperts.com/UDiTH%20App/Custom%20attributes): Open custom attributes panel
- [Project tree](https://help.caxperts.com/UDiTH%20App/Project%20tree): The tree bar or tree window remains visible even when you open a PDF, P&ID, or isometric.
- [Search tab](https://help.caxperts.com/UDiTH%20App/Search%20tab): UDiTH's search function is designed to work across 3D models, 2D drawings, documents, and IntelliPID:
- [Attributes tab](https://help.caxperts.com/UDiTH%20App/Attributes%20tab): The Attributes tab is displayed by default at start-up. It contains all attribute information for the selected item or items that was provided during the…
- [Files tab](https://help.caxperts.com/UDiTH%20App/Files%20tab): Button Description
- [2D to 3D projection](https://help.caxperts.com/UDiTH%20App/2D%20to%203D%20projection): UDiTH allows you to create custom image projections. 2D images are created with AdapterForDocuments, while 360° panoramas are created with AdapterForLaserScans.
- [Animation](https://help.caxperts.com/UDiTH%20App/Animation): Animations are created from sketches. The required buttons are located in the Files tab. Once you have created a sketch, you can create an animation while the…
- [AppControls](https://help.caxperts.com/UDiTH%20App/AppControls): AppControls are a feature introduced in UDiTH Version 7.0. They allow regular users, power users, and administrators to extend the functionality of UDiTH.…
- [WebSocket Feature](https://help.caxperts.com/UDiTH%20App/WebSocket%20Feature): As of UDiTH 2026.2.0, the API supports WebSocket connections between UDiTH App and AppControl Apps. This allows an AppControl App to run in a separate browser…
- [Comment](https://help.caxperts.com/UDiTH%20App/Comment): 1. Select an object. 2. Go to the Files tab and select Comment from the Add drop-down menu. 3. Enter your text in the box to add a comment to the model.
- [Drawing](https://help.caxperts.com/UDiTH%20App/Drawing): UDiTH can automatically create a technical Drawing from the 3D model.
- [Markup](https://help.caxperts.com/UDiTH%20App/Markup): The Markup tool can be used to create editable screenshots in UDiTH. When you add a Markup, a screenshot is taken from the current camera position.
- [Package](https://help.caxperts.com/UDiTH%20App/Package): Packaging allows you to include or exclude model objects and save the selection in an .xlsx or .json file. This is useful when exporting different versions of…
- [Photo](https://help.caxperts.com/UDiTH%20App/Photo): Allows the user to take photos if the current device has an available camera.
- [Point of Interest](https://help.caxperts.com/UDiTH%20App/Point%20of%20Interest): With the Point of Interest (POI) feature, you can easily mark and find specific locations and objects in the model.
- [Report](https://help.caxperts.com/UDiTH%20App/Report): UDiTH includes a powerful yet easy-to-use reporting engine. To create a report, click Add in the Files tab and then select Report.
- [Screenshot](https://help.caxperts.com/UDiTH%20App/Screenshot): You can capture and save your current viewing perspective as a screenshot. Click Add in the Files menu and select Screenshot. Your current view is saved as an…
- [Sketch](https://help.caxperts.com/UDiTH%20App/Sketch): Click Files, then Add, and then select Sketch.
- [Spraying](https://help.caxperts.com/UDiTH%20App/Spraying): The Spraying feature allows you to select segments within a 3D laser scan object in detail and either export or remove the selected parts from the model.
- [View](https://help.caxperts.com/UDiTH%20App/View): Views can be saved via File management Save configuration. If you do not save your views, they will be lost when UDiTH is closed or when you click Reset view.
- [Settings](https://help.caxperts.com/UDiTH%20App/Settings): UDiTH Settings offer a wide range of configuration options and allow you to customise many aspects of the application.
- [Advanced options](https://help.caxperts.com/UDiTH%20App/Advanced%20options): When you prepare a model in UDiTH Builder, you can allow or prohibit downloads in the Output configuration and set the default type of Common views cube…
- [IntelliPID Module](https://help.caxperts.com/UDiTH%20App/IntelliPID%20Module): IntelliPID is a module for UDiTH (Universal Digital Twin Hub) that displays P&ID content, including attributes and project hierarchy. The content is created in…
- [Linking and API](https://help.caxperts.com/UDiTH%20App/Linking%20and%20API): ℹ️ If you use UDiTH Portal, do not build links manually. The recommended way to create a shareable link or a deep link to a model is a Portal model link:…
- [Appendix - Custom settings files](https://help.caxperts.com/UDiTH%20App/Appendix%20-%20Custom%20settings%20files): UDiTH uses a range of files that can be used to customise both the content and the options available in the software. This appendix provides an overview of the…
- [Appendix - Command line parameters](https://help.caxperts.com/UDiTH%20App/Appendix%20-%20Command%20line%20parameters): Command Description
- [Appendix - Performance optimisation](https://help.caxperts.com/UDiTH%20App/Appendix%20-%20Performance%20optimisation): There are several ways to optimise performance in UDiTH. This document is intended to help you find the best solution for your specific needs.
- [Appendix - How to use 3D PDF files](https://help.caxperts.com/UDiTH%20App/Appendix%20-%20How%20to%20use%203D%20PDF%20files): The 3D PDF file created by UDiTH Builder can be opened with Adobe Reader.

## UDiTH Capture Station

- [Introduction](https://help.caxperts.com/UDiTH%20Capture%20Station/Introduction): UDiTH Builder uses 2D data, 3D data, and metadata prepared by the following adapters and the SDK to create UDiTH models:
- [Builder](https://help.caxperts.com/UDiTH%20Capture%20Station/Builder): The Builder creates UDiTH 3D model data, PDF documents, and PID models, including attributes, project hierarchy, and 2D drawings (ISOs), from various sources…
- [UniversalPlantCreator](https://help.caxperts.com/UDiTH%20Capture%20Station/UniversalPlantCreator): UniversalPlantCreator is a tool designed to generate models for UDiTH efficiently.
- [AdapterForSmartReview](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForSmartReview): AdapterForSmartReview captures 3D graphics and attributes from Intergraph Smart Review and stores them in a .upvc file. This file is then used as input for…
- [AdapterForNavisworks](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForNavisworks): AdapterForNavisworks captures 3D graphics and attributes from Autodesk Navisworks sessions and stores them in a UPVC file. This file is then used as input for…
- [AdapterForE3d](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForE3d): AdapterForE3d captures 3D graphics and attributes from AVEVA PDMS sessions, for example .rvm and .att files, and stores them in a .upvc file. This file is then…
- [AdapterForIfc](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForIfc): AdapterForIfc extracts graphics and attributes from Industry Foundation Classes (IFC) files and saves them in a .upvc file. This file is then used as input for…
- [AdapterForLaserScans](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForLaserScans): AdapterForLaserScans captures point data from E57 files and saves it as a .upvc file.
- [AdapterForDocuments](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForDocuments): AdapterForDocuments captures 2D graphics and attributes from Intergraph SmartPlant SmartSketch and stores them in a .upvd file. This file is then used as input…
- [AdapterForSpid](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForSpid): The purpose of AdapterForSpid is to extract data used by Intergraph Smart® P&ID (SPID) into a local UPVP database for use with UDiTH.
- [AdapterForPdfPid](https://help.caxperts.com/UDiTH%20Capture%20Station/AdapterForPdfPid): The purpose of AdapterForPdfPid is to extract data from different PDF files into a local UPVP database. AdapterForPdfPid scans PDFs and creates a…
- [SDK](https://help.caxperts.com/UDiTH%20Capture%20Station/SDK): The SDK for UDiTH Builder allows you to create custom plugins that are executed by UDiTH Builder. With these plugins, you can create new attributes and…
- [SDK - UniversalPlantViewerBuilderPlugin Namespace](https://help.caxperts.com/UDiTH%20Capture%20Station/SDK%20-%20UniversalPlantViewerBuilderPlugin%20Namespace): UniversalPlantViewerBuilderPlugin.Version1 Namespace
- [LaserscanClippingPlugin](https://help.caxperts.com/UDiTH%20Capture%20Station/LaserscanClippingPlugin): LaserscanClippingPlugin is a plugin used in UniversalPlantViewer Builder to manipulate laser scan data for UniversalPlantViewer. It uses UPV session files…
- [ExcelImportPlugin](https://help.caxperts.com/UDiTH%20Capture%20Station/ExcelImportPlugin): The ExcelImportPlugin is used to sideload additional attribute data not included in the initial source files. This feature helps to implement data from sources…

## UDiTH Portal

- [Overview](https://help.caxperts.com/UDiTH%20Portal/Overview): UDiTH Portal is a server-based centralised platform that contains multiple optional submodules:
- [Migration Guide](https://help.caxperts.com/UDiTH%20Portal/Migration%20Guide): This guide walks you through upgrading from UPV Webservices to the new UDiTH Portal. Alternatively, you can set up a fresh instance.
- [Requirements](https://help.caxperts.com/UDiTH%20Portal/Requirements): This page consolidates the requirements for all UDiTH Portal components. Please review the sections relevant to the components you intend to deploy.
- [Setup Keycloak](https://help.caxperts.com/UDiTH%20Portal/Setup%20Keycloak): UDiTH Portal now uses Keycloak as an identity provider.
- [Setup Portal Window](https://help.caxperts.com/UDiTH%20Portal/Setup%20Portal%20Window): See the Portal section on the Requirements page, including Software (Windows).
- [Setup Portal Linux](https://help.caxperts.com/UDiTH%20Portal/Setup%20Portal%20Linux): See the Portal section on the Requirements page, including Software (Linux).
- [Portal Configuration](https://help.caxperts.com/UDiTH%20Portal/Portal%20Configuration): This page describes how UDiTH Portal is configured and lists all available settings.
- [Breaking Changes](https://help.caxperts.com/UDiTH%20Portal/Breaking%20Changes): This page lists changes that require attention when updating an existing UDiTH Portal installation. Changes are grouped by the release that introduced them;…
- [Adding Custom CA Certificates](https://help.caxperts.com/UDiTH%20Portal/Adding%20Custom%20CA%20Certificates): When UDiTH Portal needs to communicate over HTTPS with keycloak or a database that use a certificate issued by a company-internal Certificate Authority (CA),…
- [Setup Renderserver](https://help.caxperts.com/UDiTH%20Portal/Setup%20Renderserver): See the Requirements page for the render server hardware and operating system requirements.
- [Setup ICE Server](https://help.caxperts.com/UDiTH%20Portal/Setup%20ICE%20Server): The ICE server helps the client connect to the render server. This is done by setting up a TURN/STUN server for address and port resolution, as well as…
- [Central Model Repository](https://help.caxperts.com/UDiTH%20Portal/Central%20Model%20Repository): The Central Model Repository (CMR) was introduced with Portal and replaces both the model hosting folder and the model folder on the render server with a…
- [Linking](https://help.caxperts.com/UDiTH%20Portal/Linking): Model links are the recommended way to create shareable links and deep links to a model in UDiTH. UDiTH Portal generates and manages these URLs for you: it…
- [Permission Management](https://help.caxperts.com/UDiTH%20Portal/Permission%20Management): UDiTH Portal uses a role-based and folder-based permission system. Users are managed through Keycloak and synchronised into Portal. Access to models and…
- [UI Settings](https://help.caxperts.com/UDiTH%20Portal/UI%20Settings): The UI Settings page allows administrators to customise the appearance and behaviour of the Portal. It is accessible under Administration → Settings.
- [Observability](https://help.caxperts.com/UDiTH%20Portal/Observability): UDiTH Portal and the render server export metrics and log output over OpenTelemetry (OTLP). This page describes how to enable the export and documents every…
- [Using federated accounts](https://help.caxperts.com/UDiTH%20Portal/Using%20federated%20accounts): You can configure UDiTH Portal account management to use an external authentication provider, for example ADFS, through one of the authentication protocols…
- [Advanced integration options](https://help.caxperts.com/UDiTH%20Portal/Advanced%20integration%20options): There are multiple flexible options for integrating your product with UDiTH Portal.
- [Secure Setup Guidelines](https://help.caxperts.com/UDiTH%20Portal/Secure%20Setup%20Guidelines): This page describes the recommended way to operate UDiTH Portal with a small attack surface. It is a hardening guide, not an installation guide. For the…

## Toolkit App for UDiTH

- [Toolkit Administration Guide](https://help.caxperts.com/Toolkit%20App%20for%20UDiTH/Toolkit%20Administration%20Guide): Welcome to the administration guide for UDiTH App Toolkit. This guide provides detailed instructions for managing the application efficiently.
- [Toolkit User Guide](https://help.caxperts.com/Toolkit%20App%20for%20UDiTH/Toolkit%20User%20Guide): Welcome to the user guide for UDiTH Toolkit App.
- [Toolkit Group And Role Mapping](https://help.caxperts.com/Toolkit%20App%20for%20UDiTH/Toolkit%20Group%20And%20Role%20Mapping): Action: On Keycloak's side, the user is removed from a defined group.
- [Toolkit Deployment Guide](https://help.caxperts.com/Toolkit%20App%20for%20UDiTH/Toolkit%20Deployment%20Guide): Docker or Podman (to run the Toolkit Docker image) SQL Server (to host the database) (with SQLLatin1GeneralCP1CIAS Collation (see Database Section)) Keycloak…
- [Custom Code and Macro Reference](https://help.caxperts.com/Toolkit%20App%20for%20UDiTH/Custom%20Code%20and%20Macro%20Reference): This document provides a complete reference for the ExecutorCustomCode macro system, including workflow step macros, event listeners, and field validators. It…

## UDiTH Companion

- [UDiTH Companion](https://help.caxperts.com/UDiTH%20Companion/UDiTH%20Companion): UDiTH Companion is an AI-assistant add-on for the UDiTH viewer. It's source code is available on request, source usage limitations might apply. A .NET backend…

## 3D SymbolDesigner

- [Introduction](https://help.caxperts.com/3D%20SymbolDesigner/Introduction): 3D SymbolDesigner enables customers to create symbols graphically for plant design software such as Intergraph® SmartPlant® 3D, without requiring programming…
- [Installation](https://help.caxperts.com/3D%20SymbolDesigner/Installation): Requirements:
- [Usage](https://help.caxperts.com/3D%20SymbolDesigner/Usage): 3D SymbolDesigner is a high-level symbol definition modeller. Graphical primitives can be parameterised, and dimensions, position, and rotation in space can be…
- [Tutorial 1 - Tank with nozzles](https://help.caxperts.com/3D%20SymbolDesigner/Tutorial%201%20-%20Tank%20with%20nozzles): This tutorial explains how to build and bulkload a storage tank symbol for SmartPlant 3D.
- [Tutorial 2 - Simple custom instrument](https://help.caxperts.com/3D%20SymbolDesigner/Tutorial%202%20-%20Simple%20custom%20instrument): Please read the tank tutorial first in order to understand the basic functions of 3D SymbolDesigner, especially how to add, rename, and edit nodes.
- [Tutorial 3 - Piping spec part](https://help.caxperts.com/3D%20SymbolDesigner/Tutorial%203%20-%20Piping%20spec%20part): Start with the symbol project created in the second tutorial.
- [On-the-fly and stock parts](https://help.caxperts.com/3D%20SymbolDesigner/On-the-fly%20and%20stock%20parts): 1. On-the-fly parts require ports that can be modified by the user after placement. The second tutorial, see above, shows how to create a piping instrument…
- [Usages](https://help.caxperts.com/3D%20SymbolDesigner/Usages): New ( ) creates a new 3D SymbolDesigner symbol project.
- [Mathematics](https://help.caxperts.com/3D%20SymbolDesigner/Mathematics): Angles are interpreted in radians if they are not followed by a degree sign (°). You can enter PI or 180° for an angle of 180°.
- [VBNET symbols](https://help.caxperts.com/3D%20SymbolDesigner/VBNET%20symbols): 1. Create the symbol as described in the tutorials above.
- [Piping nozzles](https://help.caxperts.com/3D%20SymbolDesigner/Piping%20nozzles): Starting with version 8.0 of 3D SymbolDesigner, value sets for piping nozzle parameters can be defined in Config.xls. These sets can be used as follows:
- [Custom forms](https://help.caxperts.com/3D%20SymbolDesigner/Custom%20forms): Since version 07.00.1602.1704, 3D SymbolDesigner creates a form definition project template in the export folder of the symbol. The solution or project file…

## SystemFor4d

- [Introduction](https://help.caxperts.com/SystemFor4d/Introduction): CAXperts 4D System converts Excel files containing 4D/5D data (e.g. from Oracle Primavera P6 or Microsoft Project) directly into UPV animation files.
- [Usage](https://help.caxperts.com/SystemFor4d/Usage): 1. Place 4D System.exe in the same folder as UDiTH.exe. 2. Run the executable by using a command such as the following:

## DrawingXpert

- [DrawingXpert](https://help.caxperts.com/DrawingXpert/DrawingXpert): DrawingXpert is a highly automated and flexible tool for modifying the content of SmartSketch drawings based on various rules. The tool can process individual…

## Setup and Licensing

- [Standard Setup of CAXperts Software](https://help.caxperts.com/Setup%20and%20Licensing/Standard%20Setup%20of%20CAXperts%20Software): This chapter explains the installation process for most CAXperts products.
- [Licence Installation and Upgrade](https://help.caxperts.com/Setup%20and%20Licensing/Licence%20Installation%20and%20Upgrade): The endpoint used during licensing is https://api365.slascone.com:443. A connection to 20.126.54.190 (api365.slascone.com) on port 443 is required.

## SpecXpert

- [Introduction](https://help.caxperts.com/SpecXpert/Introduction): - SpecXpert places all components in user-selected Intergraph Smart 3D piping specifications and reports errors through Smart 3D to-do list entries and…
- [Prerequisites](https://help.caxperts.com/SpecXpert/Prerequisites): - Supported operating systems: - Microsoft Windows XP - Microsoft Windows Server 2003 - Microsoft Windows Vista - Microsoft Windows 7 or later - Intergraph…
- [Usage](https://help.caxperts.com/SpecXpert/Usage): When you run the software, the main window shows a drop-down list of available plants on your current Smart 3D site.
- [Templates](https://help.caxperts.com/SpecXpert/Templates): The resulting Access database can be configured by using a template. The template file is usually located in:
- [Command line mode](https://help.caxperts.com/SpecXpert/Command%20line%20mode): SpecXpert also works in command-line mode.
- [Examples](https://help.caxperts.com/SpecXpert/Examples): 1. Example 1:
- [Troubleshooting](https://help.caxperts.com/SpecXpert/Troubleshooting): In the current version of SpecXpert, only existing catalogue parts are tested. SpecXpert does not provide detailed information about what went wrong during…

## UniversalReporter

- [UniversalReporter for SmartPlant](https://help.caxperts.com/UniversalReporter/UniversalReporter%20for%20SmartPlant): UniversalReporterSuite enables customers to extract, consolidate, review, report on, and edit data from different Intergraph® applications.
- [S3D2PDS](https://help.caxperts.com/UniversalReporter/S3D2PDS): S3D2PDS is an add-on for CAXperts 3D ReportAdapter used to create PDXPDA backup files containing models and metadata.
- [QualityAssuranceModule](https://help.caxperts.com/UniversalReporter/QualityAssuranceModule): QualityAssuranceModule is designed to configure and apply quality checks that help ensure the quality of project data. The QualityAssuranceModule is used to…
- [ReportAdapter for Microsoft Excel](https://help.caxperts.com/UniversalReporter/ReportAdapter%20for%20Microsoft%20Excel): The ReportAdapter for Microsoft® Excel® is used to extract data from an existing Excel® file. The resulting Access file can be used with UniversalReporter or…
- [ReportAdapter for SmartPlant 3D](https://help.caxperts.com/UniversalReporter/ReportAdapter%20for%20SmartPlant%203D): ReportAdapter for Smart® 3D is designed to export Smart 3D attributes and graphics into a SQLite database containing one table per task. The resulting records…
- [ReportAdapter for SmartPlant PID](https://help.caxperts.com/UniversalReporter/ReportAdapter%20for%20SmartPlant%20PID): ReportAdapter for SmartPlant® P&ID is designed to extract data from Intergraph SmartPlant® P&ID (SPPID) into a local project database in Microsoft Access…

## Distribution Server

- [OpenID Connect with Azure Blob Storage](https://help.caxperts.com/Distribution%20Server/OpenID%20Connect%20with%20Azure%20Blob%20Storage): This approach is not recommended by CAXperts. Please use UDiTH Portal instead. This website will not be updated and potentially removed in future

## CAXperts Licence Portal

- [CAXperts Licence Portal](https://help.caxperts.com/CAXperts%20Licence%20Portal/CAXperts%20Licence%20Portal): To request access, please contact CAXperts at .

