Skip to content
Proxus 2.0.1 Licence and sign-in fixes after the 2.0 upgrade Release notes

Reference · for Engineers, Administrators

Machine types

Define a machine type once with fields, units and ranges, map a device's tags to it and read the device on the UNS model topic.

A machine type says what a kind of machine measures, once: a pump has a flow, a pressure and a running state, whatever protocol its device speaks. Each device that is such a machine chooses the type and maps the type's fields to its own tags. The gateway then also publishes the device in the type's shape, so every pump looks the same to the systems that read the Unified Namespace. Machine types are in Organize > Machine Types.

A type and its fields

Field of a typeMeaning
NameThe kind of machine, for example Pump or Centrifugal Pump. Unique.
Based OnA type this one builds on. The type has all of that type's fields first, then its own. Inherited Fields lists them.
DescriptionWhat the type is for.
FieldsThe values the type has.
ComponentsMachines the type holds, each with a name and a type.

Each field has a Name (for example Flow), a Data Type, a Unit, a Low Limit and a High Limit, and a Description. A field name may be used once in a type, also across the types it builds on. A type cannot be based on itself, directly or through another type.

Components

A type can hold other machines as Components: a Filling Line type with the components Pump1 and Pump2 of type Pump and Conveyor of type Conveyor. This fits one device that reads a whole line or cell, such as one PLC. Each component has a Name (letters, digits and _) and a Type.

The fields of a component are mapped on the device under the component's name: Pump1.Flow, Pump2.Flow. A tag named Pump1_Flow is filled in for Pump1.Flow. A component's calculated fields keep their formula and read the component's own fields. Components can hold components of their own; a type cannot contain itself, directly or through its components. On the model topic a component is nested:

"fields": {
  "Speed": { "value": 120, "dataType": "Double", "quality": "Good", "tag": "SPD", "ts": "..." },
  "Pump1": { "type": "Pump", "fields": { "Flow": { "value": 12.5, "unit": "m3/h", "quality": "Good", "tag": "P1F", "ts": "..." } } }
}

Calculated fields

A field with a Formula is calculated: it takes no tag, and the gateway works out its value from the type's other fields each time one of them changes. For example a Yield field with the unit % and the formula

GoodCount / (GoodCount + RejectCount) * 100

The formula uses the language of a flow's Calculate step: numbers, + - * /, brackets and the functions round, abs, min, max and clamp. It may read the type's fields that are not calculated themselves, by name. A formula that names a field the type does not have, or another calculated field, cannot be saved.

On the model topic a calculated field carries its formula instead of a tag. Its quality is the worst quality of the fields it reads, and Uncertain outside its own low and high limit. While a field it reads has no number yet, or when the formula divides by zero, the calculated field is left out.

Versions

A device follows a version of its type, not the type as you are editing it, so a change to a type never reaches running devices by surprise.

On the type's pageWhat it does
Unpublished ChangesWhat changed since the newest version: added and removed fields, and changes of data type, unit, limits or description.
Publish VersionRecords the type's fields as they are now, the inherited ones included, as a new version. Nothing changes on the devices.
Move Devices to VersionMoves every device of the type to the version you choose. The popup shows, per device, its version now and what changes for it; Move Devices applies it. An older version takes the devices back.
VersionsEvery published version with when it was published and what it changed.

A device's own version is its Model Version on its Model tab; change it there to move one device. The first device saved with a type that was never published publishes its version 1. A field that a version keeps keeps its tag when the device moves; a new field gets the tag of the same name, when the device has one. Inherited fields are taken when a version is published: after a change to the base type, publish the derived type again.

Give a device its type

  1. Open the device and go to its Model tab. A device that is on is read-only; turn it off under Configuration to change it, and on again afterwards.
  2. Choose the Machine Type. The device takes the type's newest version, and every field of that version, the inherited ones included, is listed with a Tag. A tag whose name is exactly the field's name (in any letter case) is filled in for you.
  3. Choose the tag for each remaining field. A field without a tag is left out of the model.
  4. Save. Choosing another type keeps the tags of the fields both types share.

The field takes the tag's value as the gateway sends it, after the tag's own scaling.

The model topic

For a device with a type, the gateway publishes .../<device>/model next to the tag topics of the Unified Namespace. It holds every mapped field with its latest value, and is kept by the broker for new subscribers:

{
  "ts": "2026-11-14T10:23:59.673Z",
  "type": "Filler",
  "fields": {
    "Speed": { "value": 57.8, "dataType": "Double", "quality": "Uncertain", "tag": "Speed", "ts": "2026-11-14T10:23:24.661Z" },
    "GoodCount": { "value": 161205, "dataType": "Double", "quality": "Good", "tag": "GoodCount", "ts": "2026-11-14T10:23:59.673Z" }
  }
}
PartMeaning
typeThe device's machine type.
fieldsOne entry per mapped field: value in the field's data type, unit when the field has one, quality, the tag it comes from (the formula, for a calculated field) and the ts of that value.
qualityThe tag's quality; a value outside the field's low and high limit is Uncertain.

The model topic is published in the JSON format; with Sparkplug B only the tag metrics are published.

States

A type can say what its machine is doing. Choose the State Field (the field whose value is the state, for example OperatingState) and name its values on the States tab: each Value (for example 4), its Name (Fault) and its Category: Running, Idle, Planned Stop (left out of planned time), Unplanned Stop or Fault. A type built on another takes its states; naming a value again changes it for this type.

Every device of the type takes the states: its state tag is the tag the state field is mapped to, and its state labels are the type's names, in colours by category. The trend's state band, the alarm page and the UNS Explorer show them. A device whose type names no states keeps the state band set in the Trend Workspace. The states also drive the downtime log and OEE, together with three fields for OEE:

FieldMeaning
Good Count FieldThe field that counts good units, as a counter that goes up.
Reject Count FieldThe field that counts rejected units.
Ideal Rate (units/min)How many units a minute the machine is built for.

Data contract

The type is also a contract for its devices' data. Values Outside Limits says what the gateway does on the model topic with a value outside its field's low and high limit: Mark as Uncertain (the default) or Hold Back (the field leaves the model topic until a value inside the limits comes). The tags themselves are always kept.

The Contract tab lists, for every device of the type, what does not fit right now: a field with no tag (Not Mapped), a text tag for a number field, a tag whose unit differs from the field's (°C and degC count as the same), a field with no value yet, and a value outside the limits.

Import from a standard and download as AAS

Import from File on the Machine Types list reads an OPC UA information model: a companion specification (for example Pumps or Machine Tools) or a CESMII Smart Manufacturing Profile, both NodeSet2 XML files. Each object type becomes a machine type: the type it builds on (HasSubtype), its variables and properties as fields (with EngineeringUnits as the unit and EURange as the limits), the variables in its folders as fields named Folder_Variable, and its object components as components. Tick the types to create; a type they build on or contain comes along, and a name already taken is left as it is. Nothing is created before Import.

Download as AAS on a device's or a machine type's page downloads an Asset Administration Shell (IDTA AAS v3) as an .aasx file. A device is an Instance: an Identification submodel (name, type, place in the plant) and an OperationalData submodel with each field, its latest value, unit and limits; a component is a collection. A machine type is the Template of the same submodels, without values. The machine types are also served through the i3X API.

Ready-made types

Add from Library on the Machine Types list offers types most plants have: pump, centrifugal pump, air compressor, electric motor, industrial oven, energy meter, conveyor and chiller, each with its usual fields, units and limits. Tick the ones you need and select Add Selected. A type that builds on another brings it along (a centrifugal pump adds Pump). A type whose name is taken is left as it is. The added types are ordinary machine types: change them as you like. Their names stay in English, because they appear in the model topic and in rules; their descriptions are written in your language.

Let the AI Assistant map the tags

When the tag names differ from the field names, Suggest Mapping on the type's page does the matching for you.

  1. Tick the devices to map. The devices of the type are ticked; a device without a type is listed too and gets this type when you approve. You always choose the type: the AI Assistant never picks one for a device.
  2. Select Suggest mapping. A field keeps the tag it has, and a tag with the field's name is taken as is. For the rest, the AI Assistant compares the field (unit, limits, description) with each tag (unit, description, data type, latest value) and suggests a tag, with why in one sentence. A number field never gets a text tag, and a tag gives one field. Devices of one profile are asked about once.
  3. Check the rows. Each row says where its tag comes from (Mapped already, Same name, AI Assistant, Not found). Change any tag in its list; an empty tag leaves the field out.
  4. Select Approve and apply. Nothing is saved before this. Running devices update on their gateway.

In the AI Assistant chat you can ask for the same: "map the Labeler fields on the three labelers". It reads the mapping (Model mapping) and proposes the tags as a change you approve. Ask "which devices have no type but the same tags?" and it lists the groups (Similar devices without a type), then asks whether you want a type for one and what to call it. It creates nothing until you approve.

Rules and a dashboard for the type

Write a rule or build a dashboard once for the type, and it covers every device of the type, whatever its tags are called.

A rule for every device of the type. In Automate > Rules, set the condition's Where to Machine type and choose the type. The comparisons then list the type's fields, for example Main.Speed below 20. The Now and Last 24 hours checks read each device's own tags. The gateway runs the rule on each device of the type, over the tag that device maps the field to, and an alarm names the device. The rule follows the devices: when a device gets the type or its mapping changes, the rule is sent again. A device that has not mapped a field the rule compares is left out. A calculated field has no tag and cannot be compared yet. The type's page lists its rules on the Rules tab.

A dashboard for the type. Create Dashboard on the type's page builds one dashboard for all its devices and opens it. It is listed under Analyze > Dashboards with the other dashboards. Choose a device at the top. There is one card per field with its latest value, and the chart shows the field of the chosen card over the last 24 hours. Fields that are calculated or text are not shown. The dashboard keeps the devices and mappings it was created with: after you add a device or change a mapping, press Create Dashboard again to update the same dashboard.

What's next

Was this page helpful?

Evaluating Proxus? See it on your own machines in a 30-minute technical session.