Base template functional summary
- Last UpdatedAug 12, 2025
- 2 minute read
The following information describes each base template object and recommendations for use.
$UserDefined Template
The $UserDefined object provides an empty starting point for creating custom built objects that include attributes, scripts, and feature extensions, such as alarms, historization, and I/O. It is the most flexible and most commonly-used template for modeling your assets. Unlike other asset object templates, the UserDefined template contain only the basic editor tabs (Attributes, Scripts, and Object Information), while other object templates contain custom tabs that are applicable only to that object type.
The $UserDefined template should be used in most cases as the basis for creating the objects needed to model the physical plant environment.
$AnalogDevice Template
The $AnalogDevice Template object can be used to model more complex analog inputs and control loops.
The General tab of the Object Editor includes a field for setting the type of analog device. The Analog option type enables configuring a Process Variable (PV) input source and (optionally) a different output destination. The PV can be scaled, multiple alarm points defined, and history collected for the PV. The Analog regulator option type allows for a PV input (no separate output), a setpoint, an optional different setpoint feedback address, setpoint high and low limits, and optional control tracking. It also supports scaling, alarms, and history.
$DiscreteDevice Template
The $DiscreteDevice Template object can be used to model instruments or equipment that have two or more discrete states.
The Process Variable (PV) attribute of the discrete device is a string representing the state. This can also be read as an enumerated integer value. The object supports up to five distinct states based on one- to four inputs. Up to six discrete outputs are available from the template.
The Passive state is provided to represent the state when the field device is not energized. For example, a valve that fails to the closed state when it loses power would have a passive state of Closed. A valve that requires power to command it to open and to close may only use the two active states and not have a passive state.