Show only results for:











Builder

Introduction

The 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 of CAXperts Adapters. It can apply colour files, Excel data and create 3D PDFs.

The Builder cannot be used without the output files of the Adapters. Please refer to the adapters manuals on how to create the output files.

A connection to 20.126.54.190 (api365.slascone.com) on port 443 is required. See: https://www.caxperts.com/help/Licensing/Licence%20upgrade%20and%20installation

Model creation

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.

File ending Meaning
.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.

Generate output

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

Output type

Creates either an UniversalPlantViewer model or a 3D PDF document.

Settings

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.

UniversalPlantViewer settings

These settings are only available if the output type is “UniversalPlantViewer”.

Display styles

“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 AdapterForSpid 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.

Reuse 2D/3D projections

“2D <-> 3D mapping" source directory defines the location of .upvf file(s) containing picture 2D/3D projections which should be available in the new UPV model again. Images of 2D/3D projections which are stored in the .upvf file(s) will be converted directly in the UPV model.

When checked, the user authentication is required for downloaded models.

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.

Tools settings

The Tools Settings offer many advanced configurations for the generated output.

General

Export caching

The “Export Caching” option enables the programm the re-utilize already calculated Laserscan data. If the same Laserscan model is exported over and over again, the programm saves time in reuseing already calculated Information. Primarily changes will have to be newly calculated.

Be aware that this option works best with Laserscan data but 3D Data is also accepted.

This option resultes in significantly larger data files. (Faster speed in exchange for larger files)

Configuration file

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.

Aspects

Select or deselect if a specified aspect should be part of the 3D model.

Tree

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 → …

Attributes


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.

Mapping

Mapping allows the transformation, rotation and scaling of multiple models.

  1. These options are for Rotation/Scaling. First, the system processes this action.
    Here Model1.upvc rotates around -100,50,0 meters. Always use meters as the unit.

  2. In a second step, the model is moved by the distances to its destination.

“Use as catalog” is not applicable yet.

Advanced

Document databases

Document databases are .upvd files. Add or remove necessary files. Refer to the AdapterForDocuments on how to create document database files.

Include all drawings: All drawings - regardless of whether they have a reference to an object in the model - are included in the model.

Disable pdf cache: The pdf files can be cached for faster display in the UPV. Selecting this option turns this off. This can only be recommended for very simple pdf files.

Max cached DPI: 128 - bad resolution for displaying the cached documents. This can only be recommended for the display on exclusively non-powerful end devices. 512 - good resolution for displaying the cached documents (Default). 1024 - best resolution for displaying the cached documents, but it requires a powerful device and more storage for the UPV model.

IntelliPID database

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

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.

Command-Line Parameter Guide

  1. Prepare Your Files - Ensure you have the necessary input files ready.

  2. Choose Output Options - Decide whether you want to generate a 3D PDF file, UPV files, or both.

    Parameter

    Example

    -input:

    C:\Input\Example.upvc

    Path to the file or directory you want to convert into a 3D PDF or UPV file.

    -pdf:

    C:\Output\Example.pdf

    Path where the 3D PDF file will be saved.

    -pdfpassword:

    password123

    Password to protect the exported PDF.

    -expirationdate:

    "2099-31-12T23:59:59.9999999" OR "+30"

    Sets an expiration date for the exported file. You can either specify a specific date or a duration in days.

  3. Configure Additional Settings - Customize colour configurations, configuration files, IntelliPID mapping files, etc.

    Parameter

    Example

    -upv:

    C:\Output\Example\UPV

    Path where the UPV files will be saved.

    -color:

    C:\Settings\Color.xls

    Path of a file that contains color configurations.

    -config:

    C:\Settings\Example.ini

    Path of the configuration file used for processing.

    -intellipidmapping:

    C:\Settings\IntelliPidMapping.xlsx

    Path of a file used for IntelliPID mapping.

    -package:

    C:\Input\PackagesDefinitionFile.xlsx

    Path of a file defining package definitions.

    -disablesearchindex:

    Disables the creation of a search index file.

    -outputplugins:

    Outputs registered plugin names to the result.

    -disablepdfcache:

    Disables the creation of PDF cache entries.

    -pdfcachemaxdp:

    512

    Determines the highest DPI used for PDF caching. Allowed values are 128, 512 and 1024.

    -includealldrawings:

    Specifies whether to include all drawings or only linked drawings.

    -plugin:

    ExamplePluginName

    Enables a specific plugin.

    -drawing:

    C:\Input\Example.upvd

    Path of a drawing file.

    -intellipiddatabase:

    :\Settings\IntelliPidDatabase.upvp

    Path of an IntelliPID database file.

  4. Execute the Command - Open your command prompt or terminal. Navigate to the directory where the Universal Plant Viewer Builder executable is located.

  5. Run the Command - Use the Universal Plant Viewer Builder command followed by the desired parameters.

  6. Monitor Progress - Keep an eye on the progress in the command prompt or terminal.

  7. Review Output - Check the output directories for your generated files. Optionally, review the log file for any error messages or additional information.

  8. Optional Steps >- Activate a license key using the -licensekey parameter. >- Specify a custom log file path using the -log parameter.