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 themselves. Each configuration component needs to have a group and a name as an identifier. The identifier helps to organize configuration components and build up a hierarchical structure.
Group
The group can be used to leverage the concept of paths, similar to those 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 in place. This convention can be adopted when naming and organizing the configuration components.
Name
The name assigned to each configuration component should clearly reflect the entity being integrated. The following table provides examples of appropriate naming conventions for the specific configuration components:
Configuration Component |
Description |
Naming Example |
---|---|---|
Information Model |
Name of the entity that is modeled |
CNC-Machine |
Communication Channel |
Name of the entity that is connected to |
CNC-Machine |
Mapping |
Name of the source and target entity |
CNC-MachineToDatabase |
DeviceType |
Name of the entity type that is integrated (CNC-Machine) |
CNC-Machine |
Instance |
Specific name of the entity that is integrated (Equipment) |
CNC3000 |
Naming Examples¶
We recommend the following naming convention for improved 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¶
System |
Group Format |
Name Format |
Example Group |
Example Name |
---|---|---|---|---|
Equipment / IT-system |
EquipmentType.Manufacturer |
EquipmentToSystem |
cnc.hefner |
CNC3000ToERP |
Device Types¶
System |
Group Format |
Name Format |
Example Group |
Example Name |
---|---|---|---|---|
Equipment / IT-system |
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.
System |
Group Format |
Name Format |
Example Group |
Example Name |
---|---|---|---|---|
Equipment / IT-system |
Region.PlantName.EquipmentManufacturer |
EquipmentToSystemIntegration |
germany.facility1.cnc.hefner |
CNC3000Integration |