| Icon | Key | Description |
|---|---|---|
|
| SettingsButton | Hide the **Settings** button. |
|
| TreeToggleButton | Hide the **nTreeToggleButton** button. |
|
| ProjectTreeConfigurationButton | Hide the **Configure the project tree** button. |
|
| FilesTreeAddButton | Hide **Add File** button. |
**Link** - The link can be a web link to a website or web-based database with the required link structure, an absolute path, or a path relative to the model's root directory, which is the directory that contains the `Data` folder.
**Condition** - The condition can be any filter, including wildcards, that relates to an attribute in UDiTH.
**Name** - The name is the display name of the link. This is the text shown in the Attributes panel in UDiTH.
**Colour** - The colour setting can be either a hexadecimal RGB colour definition preceded by a **\#** or one of the Excel default colours in
clear name notation: **black, white, red, green, blue, yellow, magenta, and cyan**.
## Custom Attributes
Custom attributes are user-defined attributes that can be changed before each launch of UDiTH. Their values can also be changed at runtime, except for calculation attributes. The custom attributes for IntelliPID are defined in `intelliPidAttributes.xlsx`. This file can contain four worksheets (tabs):
- **Definition**
- **Codelist**
- **Filter**
- **Meta**
### Worksheet "Definition"
This worksheet defines the custom attributes.
**Id** -- The ID of the custom attribute can be any number. The only requirement is that each ID must be unique throughout the full list of custom attributes. This ID is later used for value assignment.
**Name** -- The name under which the attribute is displayed in UDiTH.
**SourceAttribute** -- The attribute to which the custom attribute attaches itself. For example, `SP_ID` can generate many entries because it attaches itself to every object with the attribute `SP_ID`. This can affect UDiTH performance.
It is strongly recommended to define `SourceAttribute` as specifically as possible.
**Filter** -- Sets a filter so that custom attributes are assigned only to objects covered by that filter. A filter can be entered directly here, and wildcards are supported. Alternatively, a predefined filter can be used from the `Filter` worksheet.
> Filters are applied sequentially. Consider using predefined filters instead. When the same filter is used several times in a definition, the corresponding query is executed several times, which can reduce performance.
**DataType** -- The data type defines which properties an attribute has. There are three basic types:
- **Calculation** -- Defines a value that is calculated when UDiTH starts. This is the only type of custom attribute that cannot be changed at runtime. In IntelliPID, only the `HasLink` calculation is available. `DefaultValue="ThreeD"` is mandatory, and the result is a Boolean value that indicates whether the object exists in 3D.
- **Freetext** -- Defines a freely editable text attribute that can be changed at runtime. All value strings are accepted.
- **Codelist** -- Defines a codelist attribute. In UDiTH, these attributes are displayed as a combo box, allowing you to choose from a predefined list of values. See the `Codelist` worksheet.
**DefaultValue** -- The value that is assigned automatically to the custom attribute without any manual input.
Depending on the `DataType`, different options are available:
- **For Calculation** -- Only `DefaultValue="ThreeD"` is available.
- **For Freetext** -- Can be left blank or contain any string.
- **For Codelist** -- The default value should be one of the values listed in the codelist definition.
**Parameter1** -- This field provides additional parameters depending on the `DataType` of the attribute:
- **For Calculation** -- Only the parameter `HasLink` is available.
- **For Freetext** -- Not used.
- **For Codelist** -- The name of the codelist to use. See the `Codelist` worksheet.
The `Id` field must remain unique throughout the complete custom attributes list.
### Worksheet "Codelist"
This worksheet defines the codelists for custom attributes.
**Name** -- The name of the codelist. This is the same name used in `Parameter1` on the `Definition` worksheet.
**Value** -- Defines all values available for the codelist under the corresponding name.
**Colour** -- Defines the colour in which the respective value is shown in UDiTH. This also affects the colour used in the legend. It can be either a hexadecimal RGB colour definition preceded by `#`, or one of the Excel default colour names: **black, white, red, green, blue, yellow, magenta, and cyan**.
### Worksheet "Filter"
This worksheet is used to define frequently used filters for custom attributes.
Filters entered directly in the `Definition` worksheet are always executed separately, even if the filter strings are identical.
This can slow down the loading of custom attributes when UDiTH starts.
Instead, you can use the `Filter` worksheet to define a referenced filter. Filters defined here are executed only once, no matter how often they are referenced from the `Definition` worksheet. A direct filter runs every time it is used, whereas a predefined filter reuses the result and therefore improves performance when loading custom attributes.
**Name** -- The unique name of the filter to be used as a reference. This name can be chosen freely.
**Filter** -- The actual filter string, as described in the `Definition` worksheet. Wildcards are supported.
### Worksheet "Meta"
This worksheet defines the parameters used for emailing custom attribute changes.
For IntelliPID, two keys are available:
- **WorkcardMail_To** -- The recipient or list of recipients for the list of custom attribute changes.
- **WorkcardMail_Subject** -- The subject that is added automatically to the generated email.
## Report Definitions
To define a report that appears in the report selection list, use the file `intelliPidReportDefinition.xlsx`. There are two ways to create a new report definition:
### Definition by Copy
Create a new report and use **Copy current report definition** in the **Report Results** screen. This copies the current report definition to the clipboard. You can then paste the clipboard contents into the next free row of the report definition file.
### Manual Definition
You can also create a report definition manually by editing the report definition file directly:
The following fields are used to define a custom report. The highlighted fields are optional and can be left empty without affecting functionality:
**Name** -- The name of the report.
**Forbidden** (optional) -- define actions you wish to block for the report: **C** (customise), **F** (filter), or **S** (save).
You can also combine these restrictions with comma or semicolon.
Example: **C,F;S**
**Description** (optional) -- An additional description explaining the purpose of the report.
**Sort Column** -- Defines the column by which the report is sorted. If no prefix is added, the report is sorted in ascending order. Optionally, you can add the prefix `ascending:` or `descending:` before the attribute.
**Filter** (optional) -- All attributes, including custom attributes as well as wildcards can be used for filtering.
**Scope** (optional) -- Defines the scope of the P&IDs. Options are **All**, **All Open**, **CurrentDrawing**, and **Selected**.
**Attributes** -- The attributes to be included in the report. For each additional attribute, add an entry in the next free column to the right. The number of attributes is not limited.
There are two additional special attributes for reporting: **Colour** returns the current colour of the object, and **Count** returns the number of objects contained within that object. For example, a vessel with four nozzles has a count of five.
## Display Styles
### Colour List File
UDiTH uses one central list file, `upvcolorindex.txt`, to define the available display styles. This file is located in the **colourfiles** folder within your model's **Data** folder. It is loaded automatically when UDiTH starts. It contains the names of the colour files that are shown by default in the **Set display style** selection in the **File menu**.
### Colour Files
You can create custom colour files in Excel to define colours, conditions, and colour groups.
**Colour** -- Defines the colours used to colourise the designated items. There are two ways to define a colour:
- Use Excel colours in clear name notation: **black, white, red, green, blue, yellow, magenta, and cyan**.
- Use HTML (hexadecimal) colour codes starting with \# followed by 6 digits for the basic colours plus two optional digits for opacity:
**\#RRGGBBOO**. Please note that the hexadecimal values range from 00 (decimal 0) to FF (decimal 255).
For **Condition**, you can enter a filter for any attribute or custom attribute. Wildcards are supported.
**Aspect** is an option for 3D colouring and is not used for IntelliPID display styles.
**GroupName** is an optional value that allows you to define separate colour groups within one file. This lets you define several different conditions without needing separate colour files. Conditions that belong to the same colour group must use exactly the same group name.
## Sketch Item Index File
To use custom sketching items, you must create a Sketch Item index file named `upvintellipidsketchitemindex.txt`. This file contains the paths to the Sketch Item files that you want to include in your model.
A catalogue item consists of a pair of files: an `.svg` file, which defines the graphics of the symbol itself, and a `.jpg` or `.png` file, which provides the preview shown in the catalogue.
### Adding Objects to the Catalogue
You can add any `.svg` file, together with an optional corresponding `.jpg` or `.png` file, to your catalogue. UDiTH loads it when the model starts if the object is valid and correctly listed, with name and path, in the Sketch Item index file. You can use absolute paths, relative paths, and includes:
**Absolute path** - `C:\temp\Pumps\pump2.svg`
**Relative path** -- `IntelliPidCatalogue\Valves\valve1.svg` (relative to the location of your UDiTH model folder)
**Include** - `#include D:\yourindex.txt` - Include can be used to manage objects for the whole company across as many files as required, rather than adding individual objects to individual models. In this example, `yourindex.txt` refers to a separate Sketch Item index file.
## Deep Linking in IntelliPID
You can include deep links in any document type that supports links, such as Word files, websites, or emails, to open UDiTH and transfer a combination of queries and commands.
Deep linking uses the URL handler `upvapi://`.
**Structure:**
`upvapi://| Condition | Link | Name |
|---|---|---|
| Task=Piping | https://www.caxperts.com/ | Homepage |
| Task=Structure | https://en.wikipedia.org/wiki/Structure | Wikipedia |
| After clicking **Create a report** in **File management**, you can choose a report definition file or create a new report. Report definition files are Excel files that must be stored in the `Data` folder of your UDiTH directory. By default, saved reports follow this naming convention: |
A report definition file can contain the following columns:
| Name | A descriptive name for your report. |
| Description (optional) | Additional description explaining the purpose of the report. |
| Filter (optional) | You can use all attributes including custom attributes. |
| Scope (optional) | Choose "All", "Selected" or "Visible". |
| Column (optional) | The attribute column that should be used for sorting your report. |
| Sort (optional) | You can sort in **ascending (asc)** or **descending (des)** order. If no sorting order is specified, UDiTH sorts in ascending order. Example: `descending:Name` |
| Forbidden (optional) | Enter actions that you do not want to allow for your reports: **C** (customise), **F** (filter), **S** (save). Combine them using a comma or semicolon. Example: `C,F;S` |
| Attributes | The attributes that the report should contain. **Colour** returns the current colour, and **Count** returns the number of objects contained within that object. For example, a vessel with four nozzles has a count of five. |