> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/hypersim/model-and-simulation/edit-a-model-schematic/create-and-manage-designs/manage-attributes.md).

# Manage Attributes

## Overview

**Attributes** are named pieces of information associated with devices, signals, pins, or the design itself. They are used throughout HYPERSIM to store and manage data.

Common uses of attributes include:

* Displaying information such as device names, values, and part types on schematics.
* Storing parameters used by HYPERSIM models.
* Maintaining device, signal, and design metadata required by HYPERSIM.
* Storing user-defined information for documentation, automation, and design management purposes.

Attributes can also be used with HYPERSIM's scripting and report-generation features to support customization, data extraction, validation, and automation tasks. Users can define additional attribute fields as needed to store application-specific information.

Many HYPERSIM functions rely on attributes to store internal data. For example, devices maintain information about the library from which they were imported, enabling efficient tracking and updating of library components.

{% hint style="danger" %}

## **Important**

Directly modifying attributes should be done only by experienced users. Incorrect changes may corrupt device or design data and can lead to unexpected behavior. A good understanding of the attribute system is recommended before making advanced modifications.
{% endhint %}

### Attribute Fields

Attributes are organized into **named fields**. The list of available fields is stored in the design's **Attribute Definition Table**. For each field, the table defines:

* The field name (up to 16 characters).
* The object types to which the field can be assigned (devices, signals, pins or the design).
* Data-entry constraints, such as maximum length and allowed formatting.
* Default settings, including whether the field is displayed on the schematic.

Once a field has been defined, users select it from a list of available fields rather than entering its name manually. This ensures consistency throughout the design and eliminates errors caused by misspelled field names.

<table data-header-hidden><thead><tr><th width="199.77777099609375" valign="top"></th><th></th></tr></thead><tbody><tr><td valign="top"><strong>Predefined Fields</strong></td><td>When a new design is created, a <strong>default attribute definition table</strong> is created with the standard, predefined fields.<br>Predefined fields cannot be deleted from the design since many of them have specific internal functions in HYPERSIM.<br>See Predefined Attribute Fields table for a complete listing of built-in fields.</td></tr><tr><td valign="top"><strong>User-defined Fields</strong></td><td>You can add more fields to a design at any time using the <strong>Define Attribute Fields</strong> command in the Options ribbon.</td></tr></tbody></table>

<details>

<summary><strong>Predefined Attribute Fields</strong></summary>

For additional information on the use of these fields, and on how individual device types store and manage data through attributes, refer to the documentation for the specific device.

<table><thead><tr><th width="220.3333740234375">Field Name</th><th width="130.66668701171875">Used In</th><th>Description</th></tr></thead><tbody><tr><td><strong>ABELSrcName</strong></td><td>Devices</td><td>Only in the symbol editor. Internal usage.</td></tr><tr><td><strong>AltPicName.Dev</strong></td><td>Devices</td><td>Used for the addAltPic method for DWType objects.</td></tr><tr><td><strong>AutoSym.Bottom</strong></td><td>Devices</td><td>The string used in the bottom pins box in the Auto Create Symbol command in the device symbol editor. See Auto Create Symbol.</td></tr><tr><td><strong>AutoSym.Left</strong></td><td>Devices</td><td>The string used in the left pins box in the Auto Create Symbol command in the device symbol editor. See Auto Create Symbol.</td></tr><tr><td><strong>AutoSym.Right</strong></td><td>Devices</td><td>The string used in the right pins box in the Auto Create Symbol command in the device symbol editor. See Auto Create Symbol.</td></tr><tr><td><strong>AutoSym.Top</strong></td><td>Devices</td><td>The string used in the top pins box in the Auto Create Symbol command in the device symbol editor. See Auto Create Symbol.</td></tr><tr><td><strong>Bname</strong></td><td>Signals</td><td>Not used, kept for future needs.</td></tr><tr><td><strong>Browse.DEV</strong></td><td>Design</td><td>Internal usage for the configuration of the Browser tool.</td></tr><tr><td><strong>Brows.PIN</strong></td><td>Design</td><td>Internal usage for the configuration of the Browser tool.</td></tr><tr><td><strong>Brows.SIG</strong></td><td>Design</td><td>Internal usage for the configuration of the Browser tool.</td></tr><tr><td><strong>Bus3Prefix</strong></td><td>Design</td><td>Internal usage for setting the 3-phase bus default prefix.</td></tr><tr><td><strong>Category</strong></td><td>Devices</td><td>Allows categorizing devices. Available to the user. Can be used as an alternate device prefix by entering the name of this field in PrefixField. Not used internally.</td></tr><tr><td><strong>CalculateModelData</strong></td><td>Devices</td><td>Used by some devices for providing a function for calculating model data.</td></tr><tr><td><strong>CctName</strong></td><td>Design</td><td>Design file name. Sets the window title and name of next saved file. Normally only set by the Open and Save commands.</td></tr><tr><td><strong>CctOS</strong></td><td>Design</td><td>The system (Windows) that was used to create the design file. Normally only set by the Open and Save commands.</td></tr><tr><td><strong>CctPath</strong></td><td>Design</td><td>The directory path name for the design file. Normally only set by the Open and Save commands.</td></tr><tr><td><strong>ColorCode</strong></td><td>Devices</td><td>Used for color coding devices based on some data criteria. Holds the color code number.</td></tr><tr><td><strong>DateStamp.Cct</strong></td><td>Design</td><td>This field is set by the program to the current date and time each time the circuit is modified. This is intended to allow scripts to determine if a design has been modified since the last time the script was run.</td></tr><tr><td><strong>DateStamp.Dev</strong></td><td>Devices</td><td>This field is set by the program to the current date and time when a device is placed in the circuit and not modified thereafter. See Device Date Stamping.</td></tr><tr><td><strong>DateStamp.Last</strong></td><td>Design</td><td>This field is used by the program as part of the date stamping process. See Device Date Stamping.</td></tr><tr><td><strong>DateStamp.Symbol</strong></td><td>Devices</td><td>This field is set by the program when a symbol (part definition) in a library is modified. See Device Date Stamping.</td></tr><tr><td><strong>Delay</strong></td><td>Devices</td><td>Internal usage, only in the Symbol Editor.</td></tr><tr><td><strong>Depth</strong></td><td>Devices</td><td>Indicates nesting depth of device sub-circuit. Only used temporarily by the Report tool while generating hierarchical reports. This value is not maintained during editing operations.</td></tr><tr><td><strong>Description</strong></td><td>Devices</td><td>Used for saving and making visible device scope requests or initialization options.</td></tr><tr><td><strong>Description.Pt</strong></td><td>Devices</td><td>Provides attribute position, scriptable.</td></tr><tr><td><strong>Designer</strong></td><td>Design</td><td>Intended to be used to display the designer’s name on the sheet. See Creating a Title Block.</td></tr><tr><td><strong>DesignGlobalData</strong></td><td>Design</td><td>Internal usage for global data transmission between devices</td></tr><tr><td><strong>DesignGlobalDataOption</strong></td><td>Design</td><td>Internal usage for global data transmission between devices.</td></tr><tr><td><strong>DesignType</strong></td><td>Design</td><td>A value used to distinguish which design template was used to create the design.</td></tr><tr><td><strong>DeviceDoc</strong></td><td>Design</td><td>Used for setting device documentation location in some user-defined device masks.</td></tr><tr><td><strong>DeviceVersion</strong></td><td>Device</td><td>Provides a model version number.</td></tr><tr><td><strong>DevPrefix</strong></td><td>Design</td><td>Default prefix for auto-assigned device names. Normally set using the Device Naming Options command. See Device Naming Options.</td></tr><tr><td><strong>DevScript.Dev</strong></td><td>Devices</td><td>Starts the specified script when a double-click occurs on the device. It is also possible to specify a ondblclick method in that script:<br>function ondblclick(dblClickDevice, x, y)<br>{<br>// dblClickDevice is the device<br>// x and y are device coordinates<br>}</td></tr><tr><td><strong>DrawingData</strong></td><td>Devices</td><td>Used by some devices to keep specific symbol drawing data.</td></tr><tr><td><strong>DWLSrcName</strong></td><td>Devices</td><td>Internal usage, only in the Symbol Editor.</td></tr><tr><td><strong>DWLSrcOS</strong></td><td>Devices</td><td>Internal usage, only in the Symbol Editor.</td></tr><tr><td><strong>DWLSrcPath</strong></td><td>Devices</td><td>Internal usage, only in the Symbol Editor.</td></tr><tr><td><strong>EMTP_lastRun_status</strong></td><td>Devices</td><td>Used for parametric studies.</td></tr><tr><td><strong>EMTPPhaseLabelA</strong></td><td>Signals</td><td>Holds the phase label when a signal is 3-phase. Internal usage. The phase label is usually shown near the bus.</td></tr><tr><td><strong>EMTPPhaseLabelB</strong></td><td>Signals</td><td>Holds the phase label when a signal is 3-phase. Internal usage. The phase label is usually shown near the bus.</td></tr><tr><td><strong>EMTPPhaseLabelC</strong></td><td>Signals</td><td>Holds the phase label when a signal is 3-phase. Internal usage. The phase label is usually shown near the bus.</td></tr><tr><td><strong>Exclude</strong></td><td>Devices</td><td>Indicates if the device is excluded from the Netlist (from the simulation data). Available values are Ex and 2.<br>Ex means that the device is temporarily excluded.<br>2 means that the device is permanently excluded. This value is used, for example, for devices that are setting simulation options and should not appear as parts in the Netlist.</td></tr><tr><td><strong>Exclude.Script</strong></td><td>Design</td><td>Names the script called when the Exclude value changes. It is held by the design for all devices.</td></tr><tr><td><strong>ExtCctDate</strong></td><td>Devices</td><td>Modified date of external design file containing device internal circuit. Normally set by the device Symbol Editor.</td></tr><tr><td><strong>ExtCctLib</strong></td><td>Devices</td><td>Name of library to search for an internal circuit. Used only by the Symbol Editor.</td></tr><tr><td><strong>ExtCctName</strong></td><td>Devices</td><td>Name of external design file containing device internal circuit. Normally set by the device Symbol Editor.</td></tr><tr><td><strong>ExtCctOS</strong></td><td>Devices</td><td>Source system type for design file containing device internal circuit. Normally set by the device Symbol Editor.</td></tr><tr><td><strong>ExtCctPath</strong></td><td>Devices</td><td>Directory path for the design file containing the device internal circuit. Normally set by the device Symbol Editor.</td></tr><tr><td><strong>FormData</strong></td><td>Devices</td><td>Used for saving device data that is not necessarily sent to the Netlist.</td></tr><tr><td><strong>Function</strong></td><td>Devices</td><td>This device attribute can be set to OPTION or DataFile.<br>When it is set to OPTION: the device data in ParamsA and/or ModelData attributes will appear at beginning of the Netlist. It is used for devices that are setting simulation options. Such devices can appear only at the top level of a design and not in subcircuits.<br>When it is set to DataFile, then the ModelData attribute is used to provide the name of an external file. The contents of the external file are inserted directly into the Netlist file after the simulation options. Such a file can contain generic subcircuit definitions and include calls to other subcircuits. It can also contain the definition of simulation parameters. The simulation parameters must be always defined at the top of the Netlist file.<br>It is allowed to use one or more devices with the Function attribute set to DataFile in a given design. Such devices can appear only at the top level of a design and not in subcircuits.</td></tr><tr><td><strong>Ground</strong></td><td>Devices</td><td>List of pins to be hooked to ground in the Netlist. Available in the Symbol Editor.</td></tr><tr><td><strong>GlobalData</strong></td><td>Devices</td><td>When this value is 1, it means that this device uses Global Data and needs automatic updating.</td></tr><tr><td><strong>GlobalDataTag</strong></td><td>Design</td><td>Internal usage for global data transmission between devices.</td></tr><tr><td><strong>HideSBBRules</strong></td><td>Devices</td><td>Internal usage. EMTP.</td></tr><tr><td><strong>HierNameSep</strong></td><td>Design</td><td>Contains the separator string used in generating hierarchical device and signal names for Report output. Normally set only by commands in a report script file. See the entry for the $HIERNAMESEPARATOR command in Export Script Language</td></tr><tr><td><strong>InstName</strong></td><td>Devices<br>Signals</td><td>Reserved for future use.</td></tr><tr><td><strong>LibDate</strong></td><td>Devices</td><td>Last Modified Date of the library the device was read or updated from, stored in encoded form. This is used by the Update from Lib command. See Update from Lib.</td></tr><tr><td><strong>LibName</strong></td><td>Devices</td><td>Name of the library the device was read or updated from. This is used by the Update from Lib command. See Update from Lib.</td></tr><tr><td><strong>LibPath</strong></td><td>Devices</td><td>Directory path of the library the device was read or updated from. This is used by the Update from Lib command.</td></tr><tr><td><strong>LibOS</strong></td><td>Devices</td><td>Source system of the library the device was read or updated from. This is used by the Update from Lib command.</td></tr><tr><td><strong>LibType</strong></td><td>Devices</td><td>The original name of the part when it was read from a library. This is used by the Update from Lib command.</td></tr><tr><td><strong>Mask.Dev</strong></td><td>Devices</td><td>Becomes 1 when the device (subnetwork) is masked with the default properties script.<br>Becomes 2 when the device (subnetwork) is masked with a user specified script.</td></tr><tr><td><strong>Mask.Dev.Script</strong></td><td>Design<br>Devices</td><td>Names the script called when Mask.Dev changes. This is used to optionally clear mask data when unmasking.</td></tr><tr><td><strong>ModelData</strong></td><td>Devices</td><td>Used for saving device simulation data into the design and sending into the Netlist file.</td></tr><tr><td><strong>ModelData1</strong></td><td>Devices</td><td>Extra data for some devices.</td></tr><tr><td><strong>ModelDataError</strong></td><td>Devices</td><td>Set to 1 when the device has a data error. Can be used in search functions.</td></tr><tr><td><strong>MPLevel</strong></td><td>Devices</td><td>Device patch version number.</td></tr><tr><td><strong>Name</strong></td><td>Devices, signals</td><td>Device or signal name, (sometimes called reference designator). See Device Naming Options.</td></tr><tr><td><strong>Name.Pt</strong></td><td>Devices</td><td>Name attribute position, scriptable.</td></tr><tr><td><strong>Name.Prefix</strong></td><td>Devices</td><td>Prefix used to create default Name value. Used by Auto-name options. See Setting the Auto-Generated Name Format.</td></tr><tr><td><strong>Name.Spice</strong></td><td>Device</td><td>Reserved for future usage.</td></tr><tr><td><strong>OKErrors</strong></td><td>Devices, Signals, Pins</td><td>Used by the Find tool to mark errors set as OK by user. Should not be set manually.</td></tr><tr><td><strong>Package</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>PageRef</strong></td><td>Devices</td><td>Used in Page Connector pseudo-devices only. Contains the auto-generated page references. See Automatic Display of Page References.</td></tr><tr><td><strong>PageRefFormat</strong></td><td>Design</td><td>Format string for page references. Normally modified only using the Design Preferences command. See Automatic Display of Page References.</td></tr><tr><td><strong>PageRefWidth</strong></td><td>Design</td><td>Maximum number of items per line in page references. Normally modified only using the Design Preferences command. See Automatic Display of Page References.</td></tr><tr><td><strong>ParamsA</strong></td><td>Devices</td><td>Used for saving device simulation data into the design and sending into the Netlist file.</td></tr><tr><td><strong>ParamsB</strong></td><td>Devices</td><td>Used for saving device simulation data into the design and sending into the Netlist file.</td></tr><tr><td><strong>ParamsC</strong></td><td>Devices</td><td>Used for saving device simulation data into the design and sending into the Netlist file.</td></tr><tr><td><strong>ParamsEMTP</strong></td><td>Design</td><td>Holds main simulation parameters, such as time-step and maximum simulation time.</td></tr><tr><td><strong>Part</strong></td><td>Devices</td><td>Part type code. Used in the Netlist to identify the device. HYPERSIM uses this name to identify the device in its list of built-in models.</td></tr><tr><td><strong>Part.List</strong></td><td>Devices</td><td>List of part types possible for this symbol.</td></tr><tr><td><strong>PartTemp</strong></td><td>Devices</td><td>Holds a unique part name for subcircuits. Avoids user errors when the user does not maintain unique part types correctly.</td></tr><tr><td><strong>PatchLevel</strong></td><td>Design</td><td>Design patch level.</td></tr><tr><td><strong>Permutable</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>Phase</strong></td><td>Devices</td><td>Gives the number of device phases. This number is 3 when the device accepts 3-phase signals.</td></tr><tr><td><strong>PinSequence</strong></td><td>Devices</td><td>This field can be used to determine pin order in Netlist output formats that require specific device pin ordering. This is not defined in the standard HYPERSIM libraries. Not used internally. See the entry for the $DEVPINSEQUENCE command in Export Script Language</td></tr><tr><td><strong>PkgLevel</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>PkgPrefix</strong></td><td>Design</td><td>Reserved for future usage.</td></tr><tr><td><strong>Power</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>PrefixField</strong></td><td>Design</td><td>Contains the name of the field to use as a name prefix for device auto-naming. See Setting the Auto-Generated Name Format.</td></tr><tr><td><strong>ProbeHotPt.Dev</strong></td><td></td><td>Reserved for future usage.</td></tr><tr><td><strong>Restrict</strong></td><td>Devices</td><td>An integer value from 0 to 7 used to set access restrictions for the device’s internal circuit. The value is the sum of the following:<br>1 = Don’t report<br>2 = Don’t package<br>4 = Don’t Push Into<br>Normally set using the Properties command.</td></tr><tr><td><strong>Revision</strong></td><td>Design</td><td>Intended to be used to display the designer’s name on the sheet. Not used internally. See Creating a Title Block.</td></tr><tr><td><strong>Scope_A</strong></td><td>Devices</td><td>Used for holding programmable scope name on phase A or general signal device.</td></tr><tr><td><strong>Scope_B</strong></td><td>Devices</td><td>Used for holding programmable scope name on phase B or general signal device.</td></tr><tr><td><strong>Scope_C</strong></td><td>Devices</td><td>Used for holding programmable scope name on phase C or general signal device.</td></tr><tr><td><strong>Script.Copy.Dev</strong></td><td>Design</td><td>Names the script for copying device data. Called from device right-click Copy/Paste command.</td></tr><tr><td><strong>Script.Edit.Des</strong></td><td>Design</td><td>Reserved for future usage.</td></tr><tr><td><strong>Script.ExInc.Dev</strong></td><td>Design</td><td>Names the script for excluding and including a device.</td></tr><tr><td><strong>Script.Dev</strong></td><td>Design</td><td>The name of a script to run each time a device is placed. Disabled in the current release.</td></tr><tr><td><strong>Script.Info.Dev</strong></td><td>Devices</td><td>Internal usage. EMTP.</td></tr><tr><td><strong>Script.Info.Sig</strong></td><td>Design<br>Signals</td><td>Names a script called when the user right-clicks on a signal and selects Signal Parameters.</td></tr><tr><td><strong>Script.Mask.Dev</strong></td><td>Devices</td><td>Names the mask script called when the subcircuit is double-clicked.</td></tr><tr><td><strong>Script.Open</strong></td><td>Design</td><td>The name of a script to run each time the design file is opened. Disabled in the current release.</td></tr><tr><td><strong>Script.Open.Dev</strong></td><td>Devices</td><td>Names the script called when the device is double-clicked.</td></tr><tr><td><strong>Script.Paste.Dev</strong></td><td>Design</td><td>Names the script for pasting device data. Called from device right-click Copy/Paste command.</td></tr><tr><td><strong>Script.Pin</strong></td><td>Design</td><td>Reserved</td></tr><tr><td><strong>Script.Sig</strong></td><td>Design</td><td>Reserved</td></tr><tr><td><strong>SimModelInfo.Dev</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>SignalType.Pin</strong></td><td></td><td>Internal usage.</td></tr><tr><td><strong>SignalType.Sig</strong></td><td></td><td>Internal usage.</td></tr><tr><td><strong>SignalVoltage</strong></td><td>Signals</td><td>Holds the signal voltage level selected from the Signal Parameters command.</td></tr><tr><td><strong>SignalVoltage.List</strong></td><td>Design<br>Signals</td><td>List currently available voltage values for color coding signals. These values are available in the design attribute, but can be separately saved into the signal attribute. This is a comma separated list of values used in the script named by Script.Info.Sig.</td></tr><tr><td><strong>SignalVoltage.Script</strong></td><td>Design<br>Signals</td><td>This script is called when SignalVoltage changes. It is named in the design.</td></tr><tr><td><strong>SigPrefix</strong></td><td>Design</td><td>Prefix used to generate default signal names. Normally set using the Signal Naming Options command. See Signal Auto-Naming Options.</td></tr><tr><td><strong>SimLoad</strong></td><td></td><td>Internal usage</td></tr><tr><td><strong>simulation_type</strong></td><td>Design</td><td>Holds the simulation type.</td></tr><tr><td><strong>Sniffer</strong></td><td>Devices</td><td>Names the device script called when the device is clicked on.</td></tr><tr><td><strong>Spice</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>Status</strong></td><td>Devices</td><td>Used for updating global data in devices during global data transmission.</td></tr><tr><td><strong>Status.Script</strong></td><td>Devices</td><td>Updating method when Status changes.</td></tr><tr><td><strong>SteppedOut</strong></td><td>Devices</td><td>Becomes 1 when the device is a control device and has the Step option turned on in its solution mode.</td></tr><tr><td><strong>SteppedOut.Script</strong></td><td>Design<br>Devices</td><td>Script called when the SteppedOut attribute changes.<br>Used for control devices and named in the design.</td></tr><tr><td><strong>SubCctCode.Dev</strong></td><td>Devices</td><td><p>Can contain the name of an external Netlist file. This attribute is use to insert external Netlist files through subcircuits. Pin names are used to interface with external Netlist signals.</p><p>This option is only for defining subcircuit Netlists. The subcircuit header for interfacing signals is automatically defined by HYPERSIM.</p></td></tr><tr><td><strong>TestVectors.Dev</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>Timing.Save</strong></td><td></td><td>Reserved for future usage.</td></tr><tr><td><strong>Unit</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>UnusedPins</strong></td><td>Devices</td><td>List of unused pins in this part type. Not used internally.</td></tr><tr><td><strong>user_fill_color</strong></td><td>Devices</td><td>Saves the previous color when color coding is applied.</td></tr><tr><td><strong>user_fill_color1</strong></td><td>Devices</td><td>Saves the previous color when color coding is applied.</td></tr><tr><td><strong>user_line_color</strong></td><td>Devices</td><td>Saves the previous color when color coding is applied.</td></tr><tr><td><strong>user_line_color1</strong></td><td>Devices</td><td>Saves the previous color when color coding is applied.</td></tr><tr><td><strong>Value</strong></td><td>Devices</td><td>Used to keep and show some device data on the design drawing.</td></tr><tr><td><strong>Value1</strong></td><td>Devices</td><td>Used to keep and show some device data on the design drawing.</td></tr><tr><td><strong>Value2</strong></td><td>Devices</td><td>Used to keep and show some device data on the design drawing.</td></tr><tr><td><strong>ValueDisplayOpt</strong></td><td>Devices</td><td>Reserved for future usage. Available in the Symbol Editor.</td></tr><tr><td><strong>Visual.Dev</strong></td><td>Devices</td><td>Becomes 1 when the subcircuit is set to be visual.</td></tr></tbody></table>

</details>

### Attribute Limitations

Attribute fields are subject to the following limitations:

* **Maximum field name length:** 16 characters.
* **Maximum attribute value length:** 200,000,000 characters.
  * Although binary data can technically be stored in an attribute field, this is not recommended because HYPERSIM does not provide tools for displaying or editing such data.
* **Maximum number of user-defined attribute fields:** 900.
* **Maximum number of displayed instances of a single attribute:** 100.

{% hint style="info" %}
As with all design data, the total amount of attribute information that can be stored is ultimately limited by the available system memory.
{% endhint %}

## Edit attribute data

### Device, pin, and signal attributes

To edit the attributes associated with a device, pin, or signal, use any of the following methods:

* Select the object on the schematic, right-click, and choose **Attributes**.
* Select the object and press **Ctrl+I**.

Each of these methods opens the **Attribute Editor**, which allows you to view, add, modify, or delete attribute information for the selected object.

By default, the field list on the left side of the dialog displays only the **primary fields** available for the selected object type. To view the complete set of available fields, click **All Fields**. This expands the list to include both standard and advanced fields that can be used with the selected device, pin, signal, or design object.

If the selected attribute field has an associated list of predefined values, a drop-down menu is displayed next to the **Use Default Value** button. Selecting an item from this menu automatically updates the value in the text box. You can still edit the value manually if required.

For attributes that support multiple valid values, the available options are presented in these menus. For example, if a **Part** submenu is available, the device contains multiple part definitions. Selecting a different part from the submenu updates the **Part** attribute for the device accordingly.

To edit a field, select its name from the field list. The current value is displayed in the editable text box, where it can be modified using standard text-editing operations.

When you finish editing a field, either:

* Click **Done**, or
* Select another field.

Switching to another field automatically saves the changes made to the previous field. If the entered value exceeds the field's maximum length or contains invalid characters, you will be prompted to correct the entry before continuing.

You may view and edit as many fields as needed while the dialog remains open. Changes are not applied to the design until you click **Done**. Clicking **Cancel** closes the dialog and discards all changes made during the current editing session.

### Design attributes

To edit **design attributes**, choose **Design Attributes** from the **Options** ribbon. The **Attribute Editor** allows you to view, add, modify, or delete attribute information for the selected design.

## Add custom field

In the **Options** ribbon, click on **Define Attributes Fields..** top open the dialog box and add custom attributes for your design.

* Select the \*New Field\* item in the list, if it is not already.
* Type the name of the field in the Field Name box.
* Select one or more of the boxes under Allowed in object types.
* Optionally enter a maximum length.
* Optionally enable any of the other field options.
* Click OK. The new field will now appear in the attribute data entry box for the selected object types.

You should not modify already defined fields for the HYPERSIM template as this may have dangerous consequences and corrupt design data.

<table data-header-hidden data-search="false"><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>Field Name</strong></td><td>The Field Name box allows you to enter the name of a new field or rename an existing user-defined one. If you rename a field so that it has the same name as another existing field, this becomes a Merge operation described in Merging Two Existing Attribute Fields. You will be prompted to confirm a merge before proceeding.</td></tr><tr><td><strong>Keep with instance</strong></td><td>This option is not used in the current version of HYPERSIM.</td></tr><tr><td><strong>Group with Name</strong></td><td>When this switch is checked, any value entered for this field will be displayed beneath the Name field by default. When the Name is moved, this field will also be moved.<br>This option can be used for fields that are typically shown with the name on a schematic.</td></tr><tr><td><strong>Show Field Name</strong></td><td>When this switch is checked, the field name will be shown with the value on the schematic.<br>The Show Field Name option can also be controlled for each individual item on the schematic using the Show Field Name command in the visible attribute pop-up menu.</td></tr><tr><td><strong>Allow Carriage Returns: Multi-line</strong></td><td>If this switch is checked, then the Return key may be used to enter Carriage Return characters into this field.</td></tr><tr><td><strong>Rotate text with object</strong></td><td>If this box is checked, displayed values will be rotated if the associated object is rotated on the schematic. Otherwise, when the object is rotated, the text will move to an appropriate new position but be drawn in the normal orientation.</td></tr><tr><td><strong>Visible by Default</strong></td><td>If this box is checked, whenever a value is entered for this field it will be displayed on the schematic in a default position. If the field is found in the default attributes for a device, the field will be displayed automatically on the diagram when the device is placed.<br>Changing this setting has no effect on values already in the circuit.</td></tr><tr><td><strong>In Primary List</strong></td><td>If this box is checked, the field will be considered a primary field and will be displayed in all attribute entry boxes when Primary Only is selected.</td></tr><tr><td><strong>Link value list to Part</strong></td><td>This is for cases where you have one symbol that might have multiple part names. In the Part.List field you can have a comma-separated list of values that can be put in for Part. Any other field X can also have a field X.List. If link value to Part is turned on, then when the user selects a Part value from the list, the corresponding value for X is automatically set. Learn more on the List field in Using Value List Fields.</td></tr><tr><td><strong>Read only</strong></td><td>This option makes the attribute read only. It cannot be modified by the user by selecting the attribute in the design. This is typically used for setting data from scripts or saving data that should not be touched by users.</td></tr><tr><td><strong>Temporary</strong></td><td>Creates a temporary attribute.</td></tr><tr><td><strong>Allowed in object types</strong></td><td>This group of check boxes allows you to select which types of schematic objects may have this field associated with them. You can check any one or more boxes, although in general we suggest using different names for fields used with different object types.<br>At least one of the Allowed in Object Types: switches must be selected for a new field.</td></tr><tr><td><strong>Maximum Length</strong></td><td>You can specify a maximum length (in characters) for the field data. This value does not determine how much storage is allocated internally for the data, it only affects checks that are done when the user enters data. All attribute data stored with the design occupies only the space required for its current value.</td></tr><tr><td><strong>Duplicate</strong></td><td><ul><li>This button allows you to create a new field with the same settings and (optionally) data contents as an existing one. You will be prompted to confirm the data duplication option before proceeding. More information on this operation is given in the following section.</li></ul></td></tr><tr><td><strong>Delete</strong></td><td>This button allows you to permanently remove a field definition and all associated data from the design. <strong>NOTE: THIS CANNOT BE UNDONE!</strong></td></tr></tbody></table>

## **Use value list fields** <a href="#using-value-list-fields" id="using-value-list-fields"></a>

A **value list field** provides a predefined set of valid values for an attribute field. These values are presented to the user throughout the application, making it easy to select an appropriate entry and helping ensure consistent attribute data.

A value list field uses the same name as its associated attribute field, with **.List** appended to the field name. For example, the field **Part** can have an associated value list field named **Part.List**.

When the program encounters a field named **xxx.List**, it uses the contents of that field to provide selection menus for the associated field **xxx**:

* **In the Attribute Editor**, selecting the field **xxx** displays a drop-down list containing all values defined in **xxx.List**. The user can choose a value from the list, or continue to edit the field manually if necessary. To define the available values, edit the **xxx.List** field and enter the desired items as a comma-separated list.

{% columns %}
{% column %}

{% endcolumn %}

{% column %}

{% endcolumn %}
{% endcolumns %}

* **In context menus**, right-clicking the object displays a submenu titled **xxx**. This submenu contains all values defined in **xxx.List**, allowing the user to quickly change the value of field **xxx** without opening the Attribute Editor.

Using value list fields simplifies data entry, reduces typing errors, and promotes consistency across the design.

{% hint style="info" %}
If the **xxx.List** field is defined only on an individual device within a schematic, the corresponding value list will be available only for that specific device instance and will not apply to other devices of the same type.
{% endhint %}

Typically, the default value for an **xxx.List** field should be defined in the library symbol using the [**Device Symbol Editor**](https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/model-and-simulation/edit-a-model-schematic/create-and-manage-designs/device-symbols-and-libraries/page-1.md). This ensures that the value list is automatically available whenever a device of that type is placed from the library.

### Value list data format

A value list field contains a series of text values that define the available options for an associated attribute field. The contents of the value list must follow these rules:

* Values must be separated by commas (**,**), a comma is always interpreted as a separator and cannot be included within a value.
* Values may contain any characters except commas. Leading and trailing whitespace is automatically trimmed from each value.
* Each value is limited to a maximum length of **16 characters**.
* A value list can contain up to **256 entries**.

## **Use script fields** <a href="#using-script-fields" id="using-script-fields"></a>

HYPERSIM can automatically execute a script when the value of a specific attribute changes. This mechanism, known as an **attribute change script**, allows you to implement custom actions or update related attributes in response to attribute modifications.

A script field uses the same name as its associated attribute field, with **.Script** appended to the field name. For example, the attribute **Status** have an associated script field named **Status.Script**.

When the value of an attribute changes, HYPERSIM searches for and executes the corresponding attribute change script using the following order:

1. HYPERSIM first checks the object where the attribute change occurred for a field named **xxx.Script**.
2. If the object's **xxx.Script** field is empty or undefined, HYPERSIM then searches for the same script field at the **design level**.

This search hierarchy allows scripts to be defined either for a specific object or globally for the entire design.

{% hint style="danger" %}
Care should be taken when creating attribute change scripts. Scripts that modify attributes which, in turn, trigger other scripts can create recursive loops. Improperly designed script interactions may result in excessive processing or cause the application to become unresponsive.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/hypersim/model-and-simulation/edit-a-model-schematic/create-and-manage-designs/manage-attributes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
