Naming Convention
The configuration process of a SMARTUNIFIER Instance involves the creation of configuration components such as Information Models, Communication Channels, Mappings, Device Types and the Communication Instances itself. Each configuration component needs to have a group and a name as an Identifier. The Identifier helps to organize configuration components and to build up a hierarchical structure.
Group
The group can be used to leverage the concept of paths like they are used in file systems by concatenating logical entities together. In most cases there is already a naming convention or a certain style of naming for equipment’s in place. This can be taken over when naming and organizing the configuration components.
Name
The Name should indicate the entity that is going to be integrated. Below some good and bad name examples are listed:
Configuration Component |
Good Naming |
Bad Naming |
|---|---|---|
Information Model |
Screwdriver1 |
ScrewdriverNr7Floor2SectionA |
Communication Channel |
Screwdriver1 |
OpcUaClient |
Mapping |
Screwdriver1ToOee |
OpcUaClientToDatabase |
Device Type |
Screwdriver1OeeIntegration |
ScrewdriverNr7Floor2SectionAIntegraton |
Instance |
Screwdriver1OeeIntegration |
OpcUaClientDatabaseIntegration |
Naming Examples
We recommend the following naming convention for better comprehensibility.
Information Models & Communication Channels
Information Models and its associated Communication Channels should both have the same naming.
System |
Group Format |
Name Format |
Example Group |
Example Name |
|---|---|---|---|---|
Equipment / Machines |
EquipmentType.Manufacturer |
EquipmentName |
cnc.hefner |
CNC3000 |
IT-system |
SystemType.Manufacturer |
SystemName |
erp.sep |
SEP PRO 5000 |
Mappings
Group Format |
Name Format |
Example Group |
Example Name |
|---|---|---|---|
EquipmentType.Manufacturer |
EquipmentToSystem |
cnc.hefner |
CNC3000ToERP |
Device Types
Group Format |
Name Format |
Example Group |
Example Name |
|
|---|---|---|---|---|
Region.PlantName.EquipmentManufacturer |
EquipmentToSystemIntegration |
germany.facility1.cnc.hefner |
CNC3000IntegrationTemplate |
Communication Instances
The Communication Instance provides the connectivity between the physical equipment on the shopfloor and IT-systems. It is the most granular configuration component that is created.
Group Format |
Example Group |
Example Name |
|---|---|---|
Region.PlantName.EquipmentManufacturer |
germany.facility1.cnc.hefner |
CNC3000Integration |
