- Quick start guide
- Selecting, clipping, colouring and highlighting
- Line tracking
- Custom attributes
- Colouring Options
- File management
- Linking and API
- Advanced options
- Configuration file
- 360° panorama
- IntelliPID Module
- 2D to 3D Projection
- UPV WebServices Overview
- Appendix - How to use 3D PDF files
- Appendix - Performance optimisation
- Command line parameters
- UPV WebServices Overview
- UPV WebServices Installation
- UniversalPlantViewer Builder
- Model creation
- Tools settings
- Quick Start Guide
- UniversalPlantViewer Server
- Adapter for Intergraph SmartPlant Review
- Adapter for Autodesk Navisworks
- Adapter for AVEVA PDMS
- Adapter for Laserscans
- Adapter for Documents
- Adapter for Industry Foundation Classes (IFC)
- Software Development Kit (SDK)
- SDK - UniversalPlantViewerBuilderPlugin Namespace
- Appendix - SSO with IIS on Windows
- Appendix - OpenID Connect with Azure Blob Storage
UniversalReporter for SmartPlant
Products for Intergraph PDS
UniversalPlantViewer Builder creates UniversalPlantViewer 3D model-data, PDF documents and PID models, including attributes, project hierarchy and 2D Drawings (Isos) from various sources using the input from CAXperts Adapters.
Without these adapters output files, UPV Builder cannot be used. Refer to the adapters manuals on how to create the output files.
Intergraph/Hexagon PDS, Smart 3D (.vue, .xml, .mdb2, .svf)
AVEVA PDMS, E3D
UniversalPlantViewer version 4 or newer uses a new file format (.upvc) for adapters and generated models. Older models must be re-captured to be compatible.
- Intergraph/Hexagon SmartPlant P&ID
Smart 3D Isometrics created from Smart 3D: IFC input, PDS (.dri), PDMS (.rvm, .att), BMI (.ifc)
Different adapters for UniversalPlantViewer Builder handle different kinds of input files and convert them to UPVC files:
|ReviewAdapter:||SmartPlant Review (.vue, .xml, .svf), SPRDirect (.vue, .mdb2, .svf), PDS (.dri, .dgn, drv), 3D ReportAdapter (.db)|
|PDMS Adapter:||PDMS (.rvm, .att)|
|IFC Adapter:||BIM (.ifc)|
|DocumentAdapter:||S3D isometrics, PDF files|
UniversalPlantViewer Builder generates the streaming output format for viewing with UniversalPlantViewer. It can apply colour files, Excel data and create 3D PDFs.
If you update a model that you already have converted in the past the system will automatically detect modified parts and only capture those objects. Converting 1 GB of .vue file normally will take approximately 1 hour but due to this selection processing time can be sped up considerably.
In order to use UPV Builder, license files are required. Without any valid licenses, UPV will run the model in demo mode.
To change license file locations, UPV Builder must be started as an administrator.
To add a license, press “Help” and “Update License”:
Press “Change” to add locations of licenses:
Add a folder on your local machine or a network-folder containing license files by clicking “Add folder” or “Add Server” if the files are stored on e.g. a flexnetserver. If the location does not contain any, or no valid, license files, it will be marked with a red X.
If the licence key file location is not defined, “C:\Program Files (x86)\CAXperts\Licensing\” is used. The licence key file may be renamed (including the extension). The CAXperts product will check the content of all files in the licence folder(s) for valid keys. Changes to the key path (in the environment variable or registry key) are read during the next start of the UPV Builder.
Site License (Local)
Domain based licences are restricted to machines within a 5 miles (8 kilometres) radius at a specific geographic location (building) for which the licence key file was issued for. There is no limitation regarding the number of users or machines. The licence file can be stored on a local or network location accessible by the machine running the CAXperts product, but a licence server is not required.
Floating (server) license
Floating licences require a FlexNET server (lmadmin or lmgrd) accessible by the machine running the CAXperts product. The licence key file is typically located on the FlexNET server machine. The licence key file defines the maximum number of seats which can be used at the same time. New instances can only be started if seats are available and the FlexNET server is accessible.
Every running instance of the CAXperts software product will require one seat, no matter if the application is running multiple times on the same or different machine(s).
Licence seats can be borrowed for a period from the server and saved to the local machine. Once the seat has been borrowed, the CAXperts application can be used without any connection to the FlexNET server, but a valid server-location must be reachable while borrowing the license.
To borrow a licence seat press the “Borrow seat” button in the lower left corner, define the loan period (up to 7 days) and press OK. When the borrowed seat expires it gets automatically returned to the FlexNET server.
The seat can be returned earlier by pressing the Return borrowed seat button.
To uninstall the software, select Control panel from the start menu. Then on large or small icon view, click Programs and features. If you are using category view, under Programs, click Uninstall a program.
Select the program you want to remove, and click Uninstall/Remove. Alternatively, right-click the program and select Uninstall.
The following command line options are supported by the installer:
/S:<<optional ini file>>
Allow an install to be run in silent mode. As a result, no screens or dialogs will be shown.This command line option also has an optional INI file that can be passed containing session variable values. For example:
This will cause the session variables in the INI file to be used for the setup. The INI file should be in the format:
/U:<<XML config file>>
This command line option must be used when calling the uninstall program from the command line. An optional XML file can be passed containing session variable values. For example:
"C:\Program Files\MyProduct\uninstall.exe""/U:C:\Program Files\MyProduct\irunin.xml"
This chapter will provide a guide on how to create a 3D model or PDF file
Input file /folder
Select the browse button to the right of the “Input file” and look for files in the following table. At least one valid file, or a folder containing a valid file must be selected to continue.
|.upvc||A regular UPV database (3D objects)|
|.upvm||A merged UPV database from multiple .upvc files|
Select “Without 3D data” if you do not wish any 3D model to be created, just pure PDF/IntelliPID models.
While browsing, press and hold Ctrl to select multiple .upvc or .upvm files. The result will be a joined model consisting of all the selected sub-models.
Packages definition file
Select the browse button to the right of “Package definition file (optional)”. Press clear to clear the input box. You do not have to select a package definition file to create any models. To learn how to create and use packages, please refer to the documentation of the UniversalPlantViewer, chapter Packages.
Selecting “Complete model” will create the full model.
Selecting “Packages” will result in a UPV model for every package in the package definition file, containing only the objects defined in the packages.
Any .xlsx file can be selected when browsing for package files, but only files as described in the Packages chapter of the UniversalPlantViewer documentation will work as intended.
|After selecting the model files and additional packages, pressing the “Generate output” button on the bottom right corner of the builder window will open the “Output configuration”.|
Creates either an UniversalPlantViewer model or a 3D PDF document.
The output folder is where the model or PDF will be generated.
The colour configuration file can be any -xlsx or .txt file.
The expiration date will lock the output generated after the set date.
Any .xlsx file can be selected when browsing for colour files, but only files as described in the Colour Files chapter of the UniversalPlantViewer documentation will work as intended.
These settings are only available if the output type is “UniversalPlantViewer”.
“Display Styles Directory” will result in the model having all the colour schemes contained in the folder available as default styles, without selecting the colour files again.
“Link mapping file” creates links to external documents in the objects attributes as defined in the mapping file. Refer to the chapter Linking in the UPV documentation on how to create a link mapping file.
PID 3D mapping
“PID <-> 3D mapping" file creates links between PID and objects and their 3D counterparts. Refer to the PID Adapter documentation on how to create a PID 3D mapping file. A database must be selected in IntelliPID database for the mapping file to work. To create a PID 3D mapping file, an Excel sheet must be created containing the following cells:
IntelliPidAttribute and 3DAttribute need to contain the names of the attributes to be mapped. IntelliPidRegEx and 3DRegEx need to contain the Regex commands to make the values of the IntelliPid and 3D attributes equal. Only character deletion is allowed, no characters may be added with the Regex command.
Any .xlsx file can be selected when browsing for Link or PID mapping files, but only files as described in the specified documentations will work as intended.
When allow download is selected, a user may download the model to his local machine, instead of working on a server-based variant only.
When checked, the views cube in UPV will show XYZ coordinates instead of compass directions. This is just the default view-mode and can be changed in the UPV settings.
3D PDF settings
3D PDF documents may be locked with a password.
The Tools Settings offer many advanced configurations for the generated output.
Select the initial configuration file for the UniversalPlantViewer Model. This can be changed in the UPV itself.
Any .ini file can be selected when browsing for a configuration file, but only files as described in the Configuration File chapter of the UniversalPlantViewer will work as intended.
Select or deselect if a specified aspect should be part of the 3D model.
The tree hierarchy as shown in the UPV can be edited. Select attributes by clicking the checkbox next to them and press the right arrow button to add them to the list or left to remove them. Objects with the specified attributes will show these attributes in the order they were added in the Treebar.
This functionality is available only for 3D PDF. If enabled, the attribute name is displayed in front of the value in the tree: e.g.
Area Name: Refining Area → Unit System: Distillation → …
Drag&Drop to/from the “used attributes” if they are to be shown in UPV when selecting an object that has the specified attribute. Multiple attributes can be moved by clicking the checkbox next to them and using the arrows in between the lists.
Document databases are .upvd files. Add or remove necessary files. Refer to the DocumentAdapter on how to create document database files.
IntelliPID databases are .upvp files. Add a single file. To connect PID and 3D objects, add a PID 3D mapping file as described in build settings.
Plugins are C# libraries created with the CAXperts plugin API. In order to move plugins to used plugins or back, select the checkbox on the plugin and use the arrow buttons between the lists to move them.
The plugins themselves, together with their config-files if necessary, must be in the local %AppData% folder of the machine running UPVBuilder.