> A connection to `20.126.54.190` (`api365.slascone.com`) on port `443` is required. See [Licence upgrade and installation](https://help.caxperts.com/Licensing/Licence%20upgrade%20and%20installation).
## Model creation
This chapter explains how to create a 3D model or PDF file.
### Input file / folder
Select the browse button to the right of **Input file** and choose one of the file types listed in the following table. To continue, you must select at least one valid file or a folder containing a valid file.
| File ending | Meaning |
|---|---|
| .upvc | A regular UPV database containing 3D objects. |
| .upvm | A merged UPV database created from multiple `.upvc` files. |
After selecting the model files and any additional packages, click **Generate output** in the bottom-right corner of the Builder window to open **Output configuration**.
### Output type
Creates either a UDiTH model or a 3D PDF document.
### Settings
The output folder is the location in which the model or PDF is generated.
The colour configuration file can be any `.xlsx` or `.txt` file.
The expiration date prevents the generated output from being used after the specified date.
> Any `.xlsx` file can be selected when browsing for colour files, but only files structured as described in the **Colour Files** chapter of the UDiTH documentation will work as intended.
### UDiTH settings
These settings are available only if the output type is **UDiTH**.
#### Display styles
**Display Styles Directory** makes all colour schemes contained in the selected folder available in the model as default display styles, without needing to select the colour files again.
#### Link mapping
**Link mapping file** creates links to external documents in the object attributes, as defined in the mapping file. Refer to the **Linking** chapter in the UPV documentation for information on how to create a link mapping file.
#### PID 3D mapping
The **PID <-> 3D mapping** file creates links between PID objects and their 3D counterparts. Refer to the AdapterForSpid documentation for information on how to create a PID 3D mapping file. A database must be selected in [IntelliPID database](#intellipid-database) for the mapping file to work. To create a PID 3D mapping file, an Excel sheet must contain the following cells:
`IntelliPidAttribute` and `3DAttribute` must contain the names of the attributes to be mapped. `IntelliPidRegEx` and `3DRegEx` must contain the regular expression commands required to make the values of the IntelliPid and 3D attributes match. Only character deletion is allowed; no characters may be added with the regular expression command.
> Any `.xlsx` file can be selected when browsing for link or PID mapping files, but only files structured as described in the relevant documentation will work as intended.
#### Reuse 2D/3D projections
The **2D <-> 3D mapping** source directory defines the location of `.upvf` file or files containing picture-based 2D/3D projections that should be made available again in the new UPV model. Images from 2D/3D projections stored in those `.upvf` files are converted directly into the UPV model.
When selected, user authentication is required for downloaded models.
When **Allow download** is selected, a user can download the model to a local machine instead of working only with a server-based version.
When selected, the view cube in UPV shows XYZ coordinates instead of compass directions. This is only the default view mode and can be changed later in the UPV settings.
### 3D PDF settings
3D PDF documents can be protected with a password.
## Tools settings
The **Tools Settings** provide many advanced configuration options for the generated output.
### General
#### Export caching
The **Export Caching** option enables the program to reuse already calculated laser scan data. If the same laser scan model is exported repeatedly, the program saves time by reusing already calculated information. Only changes generally need to be recalculated.
> This option works best with laser scan data, but 3D data is also supported.
> This option results in significantly larger data files in exchange for faster processing.
#### Configuration file
Select the initial configuration file for the UDiTH model. This can later be changed in UPV itself.
> Any `.ini` file can be selected when browsing for a configuration file, but only files structured as described in the **Configuration File** chapter of the UDiTH documentation will work as intended.
#### Aspects
Select or deselect if a specified aspect should be part of the 3D model.
### Tree
The tree hierarchy shown in UPV can be edited. Select attributes by clicking the checkbox next to them and then use the right arrow button to add them to the list, or the left arrow button to remove them. Objects with those attributes show them in the order in which they were added to the tree bar.
This functionality is available only for 3D PDF. If enabled, the attribute name is displayed before the value in the tree, for example:
Area Name: Refining Area → Unit System: Distillation → ...
### Attributes
Drag and drop attributes to or from **Used attributes** if they are to be shown in UPV when an object with the specified attribute is selected.
Multiple attributes can be moved by selecting the checkbox next to them and using the arrows between the lists.
### Mapping
Mapping allows the transformation, rotation, and scaling of multiple models.
1. These options are used for rotation and scaling. This step is always processed first.
In this example, `Model1.upvc` rotates around `-100,50,0` metres. Always use metres as the unit.
2. In the second step, the model is moved by the specified distances to its destination.
>
**Use as catalog** is not applicable yet.
### Advanced
#### Document databases
Document databases are `.upvd` files. Add or remove the required files as needed. Refer to the AdapterForDocuments documentation for information on how to create document database files.
**Include all drawings:** All drawings are included in the model, regardless of whether they contain a reference to an object in the model.
**Disable PDF cache:**
PDF files can be cached for faster display in UPV. Selecting this option disables that cache. This is recommended only for very simple PDF files.
**Max cached DPI:**
- `128` - low resolution for displaying cached documents. Recommended only for less powerful end devices.
- `512` - good resolution for displaying cached documents. This is the default value.
- `1024` - best resolution for displaying cached documents, but it requires a more 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, also add a PID 3D mapping file as described in [PID 3D mapping](#pid-3d-mapping).
### Plugins
Plugins are C# libraries created with the CAXperts plugin API. To move plugins into or out of **Used plugins**, select the checkbox next to the plugin and use the arrow buttons between the lists.
The plugins themselves, together with their config files if required, must be stored in the local `%AppData%` folder of the machine running UPVBuilder.
### Command-Line Parameter Guide
1. **Prepare your files** - Ensure that you have the required 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 that 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 used to protect the exported PDF. |
| ```-expirationdate:``` | ```"2099-31-12T23:59:59.9999999" OR "+30"``` | Sets an expiration date for the exported file. You can specify either a fixed date or a duration in days. |
| Parameter | Example | |
|---|---|---|
| ```-output:``` | ```C:\Output\Example\Output``` | Path where the model files are saved. |
| ```-color:``` | ```C:\Settings\Color.xls``` | Path to a file that contains colour configurations. |
| ```-config:``` | ```C:\Settings\Example.ini``` | Path to the configuration file used for processing. |
| ```-intellipidmapping:``` | ```C:\Settings\IntelliPidMapping.xlsx``` | Path to a file used for IntelliPID mapping. |
| ```-package:``` | ```C:\Input\PackagesDefinitionFile.xlsx``` | Path to a file defining package definitions. |
| ```-disablesearchindex:``` | Disables creation of a search index file. | |
| ```-outputplugins:``` | Outputs registered plugin names in the result. | |
| ```-disablepdfcache:``` | Disables 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 all drawings or only linked drawings should be included. | |
| ```-plugin:``` | ```ExamplePluginName``` | Enables a specific plugin. |
| ```-drawing:``` | ```C:\Input\Example.upvd``` | Path to a drawing file. |
| ```-intellipiddatabase:``` | ```C:\Settings\IntelliPidDatabase.upvp``` | Path of an IntelliPID database file. |