Building Blocks > Building Block Naming Conventions
Building Block Naming Conventions
The following naming conventions are used by the PTC-provided building blocks, and are recommended for use in custom building blocks.
Project Naming
The project name always starts with a name space, followed by building block prefix, which is the name of the building block. The building block prefix should be singular. The PTC name space is reserved for projects developed by PTC.
For example, for the shift building block provided by PTC, the project name is PTC.Shift.
Customer-created projects should use their own unique name space identifier, for example MyCompany. The project name for a custom shift building block could be MyCompany.Shift.
Entity Naming
The name of each entity in a building block starts with the name space, followed by the building block name, and then a functional name for the entity. For most entities, the functional name is followed by a suffix indicating the entity type. Project, Data Shape, and Thing names do not include the suffix indicating the entity type.
For example, the entry point Thing Template in the PTC-provided shift building block is named PTC.Shift.EntryPoint_TT and the entry point Thing is named PTC.Shift.EntryPoint. In a custom shift building block, the entry point Thing Template could be named MyCompany.Shift.EntryPoint_TT and the entry point Thing could be named MyCompany.Shift.EntryPoint.
The following table provides example names for different entity types, including the suffix, where one is used:
Entity Type
Suffix
Example Name
Thing
PTC.Shift.ThingName
Thing Template
_TT
PTC.Shift.ThingTemplateName_TT
Thing Shape
_TS
PTC.Shift.ThingShapeName_TS
Data table
_DT
PTC.Shift.DataTableName_DT
Data Shape
PTC.Shift.DataShapeName
Stream
_SM
PTC.Shift.StreamName_SM
Value stream
_VS
PTC.Shift.ValueStreamName_VS
Timers
_TM
PTC.Shift.TimerName_TM
Scheduler
_SL
PTC.Shift.SchedulerName_SL
Network
_NW
PTC.Shift.NetworkName_NW
Mashup
_MU
PTC.Shift.MashupName_MU
Master mashup
_MM
PTC.Shift.MasterMashupName_MM
Menu
_MN
PTC.Shift.MenuName_MN
Media
_MD
PTC.Shift.MediaName_MD
Style definition
_SY
PTC.Shift.StyleDefinitionName_SY
State definition
_ST
PTC.Shift.StateDefinitionName_ST
Style theme
_TH
PTC.Shift.StyleThemeName_TH
User group
_UG
PTC.Shift.UserGroupName_UG
Organization
_OR
PTC.Shift.OrganizationName_OR
Application key
_AK
PTC.Shift.ApplicationKey_AK
Projects
PTC.Shift
Was this helpful?