# Custom Attributes

**Open custom attributes panel** Custom attributes provide a way to add new attributes to a model without having to rebuild the model with the UDiTH Builder.

If a valid **attributes.xlsx** file is present in the UDiTH data folder, for example `C:\UDiTH\Model\Demoplant\Data\attributes.xlsx`, UDiTH displays all available attributes, including any custom attributes, in the **Custom attributes** menu on the right-hand side of the screen.

> When you use the **Ctrl** key to select multiple objects, their common attributes are displayed directly. ## Custom Attributes Panel > For details on creating and configuring custom attributes, please refer to the **Custom Attributes** section in **[Custom settings](https://help.caxperts.com/UDiTH%20App/Appendix%20-%20Custom%20settings%20files)**. In the **Attributes** tab, **Custom attributes** are shown in a distinct colour. In the standard view, they appear in **yellow** and, unlike regular attributes, can be edited. The editing process depends on the type of custom attribute. - When you select a custom attribute in the **Custom Attributes** panel, the objects are coloured accordingly and the same custom attribute in the **Attributes** tab changes from **yellow** to **red**. - This can also be achieved by double-clicking a custom attribute. When colouring is applied through the **Custom Attributes** panel, it affects **all** objects. When you double-click a custom attribute instead, objects are coloured according to the **CodeList** colour scheme only when they are clicked in the viewport. To edit **FreeText** custom attributes, simply type the required value, in the same way as for the **Comment** attribute described earlier. For **CodeList** attributes, a drop-down menu is available from which you can select the required value.

In addition, CodeList-based custom attributes show not only the selected value, but also the colour assigned to that value in the CodeList colour scheme.

### Custom Attribute Tool Bar

	Export all changes This option saves all data entered into custom attributes in a single `.xlsx` file together with the relevant information for the items to which the values are linked.
	Import all changes This loads previously saved custom attribute values from an `.xlsx` file back into the custom attributes.
	Send email Custom attribute changes are logged during the session. Clicking this button generates a summary of the changes, copies it to the clipboard, and opens an email in your default email client. The default recipient and subject are configured in the `Meta` tab of `IntelliPIDattributes.xlsx`. For details, see [Custom settings](https://help.caxperts.com/UDiTH%20App/Appendix%20-%20Custom%20settings%20files).
	Show only active Unused custom attributes do not appear in the list of values or in the legend for the currently displayed P&ID.
	Place legend This function displays a legend on the P&ID, showing the corresponding colour keys for custom attributes. The legend can be repositioned by dragging it to any location on the P&ID. For details about custom attribute CodeLists and the legend, refer to the description below.

### Custom Attribute Drop-Down The drop-down menu allows you to select from custom attributes with CodeList definitions. `None` is the default selection and uses the standard colouring for the **P&ID**. If a custom attribute with a CodeList is selected, objects on the **P&ID** are coloured according to their custom attribute value, and the legend appears below. ## Custom Attributes File To use **Custom Attributes**, you must create an Excel file containing the required information. This file, named **attributes.xlsx**, must be placed in the model's data folder. The file contains several tabs, as described in the following sections. ### Definition Tab

Name	Description
Id	Identification for custom attributes.
Name	The name of the custom attribute as displayed in the UDiTH attributes.
SourceAttribute	If the custom attribute is part of an existing attribute, declare the name of the existing attribute here.
Filter	See the section Filter.
DataType	See the section DataType.
DefaultValue	The default value used when the user hasn't made a selection yet.
Parameter1-3	These parameters vary depending on the DataType. See the following sections for details.

> You can create multiple **Custom Attributes** with identical names. To do this, use the same **Id** and **Name**, but assign different **SourceAttributes**. ### DataType

Name	Description	Parameter1	Parameter2	Parameter3
Calculation	Simple predefined calculations. See the section Calculation.	Calculation identifier	-	-
CodeList	A drop-down list with differently coloured options. See the section CodeList.	CodeList identifier	Linked CodeList attribute	-
FreeText	Any text	Character limit for the text box; use 0 for no limit	-	-
Numeric	Any number	Minimum value	Maximum value	Number of decimal places

### Filter The **Filter** tab in the configuration file contains conditions used to group items by specific parameters. Instead of the filter name, the filter condition itself can be written directly in the **Definition** tab, as long as it is entered in a single cell.

**Example** - `filter1` could not be written in the **Definition** tab, while `filter2` would work. - The `filter1` attribute is applied to all objects that meet the following criteria: the pipeline attribute starts with `03-LC-1`, is exactly `02-LC-1001`, or is exactly `Pipeline=PR01-LS-2001`. ### CodeList

	The CodeList tab contains the details for the DataType `CodeList` used in the Definition tab. CodeLists generate drop-down menus in UDiTH for the custom attribute.
	The Name is shown in UDiTH. Each following row without a name belongs to the attribute name specified most recently. For example, after `CS_State`, all values and colours from `B2` to `C6` are part of the `CS_State` attribute.

**Value:** The text for the contents of the custom attribute drop-down in UDiTH. **Color:** The colour of the square next to the values in the attribute drop-down. When filtering by attributes, this colour is also used for the corresponding 3D object in the main view. ### Calculation Calculations are predefined functions that are executed for each element.

Name	Description
TOS	`TOS` (Top Of Steel) returns the elevation in metres at the highest point of the element.
BOS	`BOS` (Bottom Of Steel) returns the elevation in metres at the lowest point of the element.
ElementColor	Returns the element's current primary colour as a hex code.
OriginalColor	Returns the element's original primary colour as a hex code.
VisibleColor	Returns the element's visible colour as a hex code, taking temporary UDiTH features into account, for example CodeList colour, highlighting, or centre of gravity.
StaticText	Displays the value from `DefaultValue`.
Bounds	Returns the bounding coordinates. It uses a format string as `Parameter1` and inserts the values accordingly. The default format is `(%lowX%, %lowY%, %lowZ%) (%centerX%, %centerY%, %centerZ%) (%highX%, %highY%, %highZ%)`.

### Meta The **Meta** worksheet tab is used for general information.

Key	Value
Email_To	Preset value used as the recipient when sending a change-set email
Email_Subject	Preset value used as the subject when sending a change-set email
Workcard_Header	Overrides the work card text header
WorkcardMail_To	Like `Email_To`, but for work cards
WorkcardMail_Subject	Work card email subject; can use special keywords
WorkcardMail_Body	Prefix for the work card email body; can use special keywords

The meta keys **WorkcardMail_Subject** and **WorkcardMail_Body** can use special placeholder values that are filled in automatically when needed.

Placeholder	Description
%workcard%	The `Work` value of the currently selected work card
%devicename%	The user's device identifier
%date%	Current date

## Import / Export All Changes

You can export changes made to custom attributes to an Excel file or import changes made.

The Excel file will contain the following information:

## Email Changes made to **Custom attributes** during the current session are copied to the clipboard and your email software is opened.

	Export all changes This option saves all data entered into custom attributes in a single `.xlsx` file together with the relevant information for the items to which the values are linked.
	Import all changes This loads previously saved custom attribute values from an `.xlsx` file back into the custom attributes.
	Send email Custom attribute changes are logged during the session. Clicking this button generates a summary of the changes, copies it to the clipboard, and opens an email in your default email client. The default recipient and subject are configured in the `Meta` tab of `IntelliPIDattributes.xlsx`. For details, see [Custom settings](https://help.caxperts.com/UDiTH%20App/Appendix%20-%20Custom%20settings%20files).
	Show only active Unused custom attributes do not appear in the list of values or in the legend for the currently displayed P&ID.
	Place legend This function displays a legend on the P&ID, showing the corresponding colour keys for custom attributes. The legend can be repositioned by dragging it to any location on the P&ID. For details about custom attribute CodeLists and the legend, refer to the description below.