UNS UserTypes Reference

Create reusable equipment templates (UserTypes).

Reference → Modules → UNS → UI → Asset | Tags | UserTypes | Enumerations | Services | Monitor

Ontology Metadata (10.1.5+)

Every UserType carries ontology metadata alongside the familiar configuration properties. Import populates these columns from RDF/OWL source files, export serializes them back to triples, and semantic search ranks matches across them. See Industrial Ontology Integration How-to for the full model.

Member-def ontology columns (10.1.5+)

The UDT member grid gained two ontology columns in 10.1.5:

Why no Labels column on member-def: property-level synonyms (skos:altLabel on data properties) are rare in real industrial ontologies (IOF, ISA-88, ISA-95) — altLabels cluster at the class level. DisplayText already covers the primary human-readable member name.

Mutability & retention

The ontology columns follow a class vs. instance split that matches W3C and industrial-ontology conventions: IRIs are identity (immutable everywhere); Labels are skos:altLabel synonyms (edited on the class at design time, on tag instances at runtime); Attributes is an extensibility bag (design-time at class and member-def levels, runtime-mutable only at tag level).

Bindings can read all three columns on every layer; writes go through script (@Tag.X.SetAttribute(...)) or the Designer editors — never through bindings directly. For RDF/OWL export, per-tag runtime mutations on Labels / Attributes must be snapshotted back to the cold-start data with promote_retentive_attributes before running the exporter.

AI / MCP page action (10.1.5+)

When Designer is navigated to the UserTypes page, the following action is exposed via the designer_action MCP tool:

• designer_action("relationship_graph") — mirrors the Knowledge Graph toolbar button. Generates an interactive HTML view (pan, zoom, filter via cytoscape.js) and opens it in the default browser. A Mermaid Markdown side-car lands next to the HTML in the Exchange folder under Visualizations/ for diff and source-control use.

The action is listed in the tabActions array returned by get_state() only when the UserTypes tab is active. See Generate a visual report of your UNS for the broader visual-report reference.

Creating UserTypes

1. Navigate to Unified Namespace → UserTypes
2. Click New button
3. In dialog:
   • Name: Template identifier
   • Description: Documentation
4. Click OK
5. Add members in grid:
   • Type in first row
   • Press Enter to add
   • Configure properties per member

UserType Properties

Using UserTypes

Creating Tags from Templates

1. Go to Unified Namespace → Tags
2. Click New Item
3. In Type dropdown, select template
4. Tag inherits all template members

Template Instance Example

Template: Motor
Members:
  - Running (Digital)
  - Speed (Double)
  - Temperature (Double)
  - AlarmStatus (Integer)

Tag: Motor1 (Type: Motor)
Access:
  @Tag.Motor1.Running
  @Tag.Motor1.Speed
  @Tag.Motor1.Temperature
  @Tag.Motor1.AlarmStatus

When the UserType represents an ontology-imported equipment class (10.1.5+)

When the UserType comes from an OWL ontology import (e.g., S88_Unit auto-created from s88:Unit by import_graph_model), instantiate it TWICE per real-world entity to capture both halves of the dual-shape pattern:

• One naked UserType-instance Tag at <path>/<entityName> — live equipment members (Temperature, Speed, Status) fed at runtime by Devices, Scripts, or simulators.
• One /Attr Tag at <path>/<entityName>/Attr — static ontology metadata members (rdfs:label, dcterms:identifier, manufacturer, classification) with StartValue defined. The importer creates this one automatically.

Both tags live as siblings under the auto-created folder. Conceptual containers (Enterprise / Site / Area / Cell with only Name + Description literal members) typically use /Attr-only. See Industrial Ontology Integration How-to → Two paradigms for the full pattern.

Nested Templates

Templates can contain other templates:

Template: PumpStation
Members:
  - Pump1 (Type: Motor)
  - Pump2 (Type: Motor)
  - FlowRate (Double)
  - Pressure (Double)

Access:
  @Tag.Station1.Pump1.Running
  @Tag.Station1.Pump2.Speed

Security Settings

Member Configuration

Supported Base Types

• Digital
• Integer
• Long
• Double
• Decimal
• Text
• DateTime
• Custom Templates

Array Members

Template: TankFarm
Members:
  - Tanks (Type: Tank, Array: 10)

Access:
  @Tag.TankFarm1.Tanks[0].Level
  @Tag.TankFarm1.Tanks[1].Temperature

Relative Addressing

For device communication:

Template: AnalogInput
Members:
  - Value (RelativeAddress: ".PV")
  - Status (RelativeAddress: ".ST")

Device mapping automatically appends to base address

Important Notes

Common Use Cases

Motor Template

Members:
  - Running: Digital
  - Speed: Double (0-1800 RPM)
  - Current: Double (0-100 Amps)
  - Temperature: Double (0-200 °C)
  - HoursRun: Long
  - LastMaintenance: DateTime

Tank Template

Members:
  - Level: Double (0-100 %)
  - Temperature: Double (-50-150 °C)
  - Pressure: Double (0-10 Bar)
  - HighAlarm: Digital
  - LowAlarm: Digital
  - Product: Text

Production Line

Members:
  - Station1: Motor
  - Station2: Motor
  - ConveyorSpeed: Double
  - ProductCount: Integer
  - BatchID: Text
  - QualityScore: Double

Best Practices Checklist 

• Plan template hierarchy - Design before implementation
• Use meaningful names - Clear member identification
• Document templates - Describe purpose and usage
• Standard units - Consistent engineering units
• Reuse templates - Avoid duplication
• Version control - Track template changes
• Test thoroughly - Verify all members

Troubleshooting

Template not appearing:

• Save after creation
• Check for naming conflicts
• Verify no circular references
• Review template hierarchy

Members not accessible:

• Confirm tag uses template type
• Check member names
• Verify array indices
• Review security settings

Values not retained:

• Check retentive settings
• Verify database connection
• Review member configuration
• Test with simple template

In this section...