BizTalk Naming Conventions

BizTalk Naming Conventions

Naming of BizTalk stuff is no different than for any programming language. It’s helpful if multiple developers on the same project use consistent terms. I’ve had a preference to how things like receive and send ports are named for years but I’ve never written them down - until now!

This list is a work-in-progress, I intend adding too it as time allows.

</table>

Artefact	Convention	Example	Notes
Physical Ports
Physical Receive Port	Rcv_TypeFromSource	Rcv_EmployeeUpdateFromSystemX	The port direction (Rcv or Send) is separated from the purpose by an underscore to aid readability and ensure the direction is immediately obvious
Physical Receive Location	Rcv_TypeFromSource_TRANSPORT	Rcv_EmployeeUpdateFromSystemX_FILE	The adapter transport is given in upper case as a highlight but also because often a receive port may have multiple locations that differ only by the transport that is used
Physical Send Port (One Way)	Send_TypeToDestination_TRANSPORT	Send_EmployeeUpdateToSystemY_WebHttp	The adapter transport is given in upper case as a highlight but also because often multiple send ports may exist that differ only by the adapter that is used
Physical Send Port (Two Way)	Request_TypeToDestination_TRANSPORT	Request_EmployeeUpdateToSystemY_WebHttp	I like to use the 'Request' prefix for two-way send ports otherwise you can end up with names like Send_GetCustomerId
BTDF Environment Settings
Send File Path	SendPort.Address	Send_EmployeeUpdateToSystemY_FILE.Address	A full stop is used to separate port name with its properties. The value from the excel spreadsheet gets substituted into PortBindings e.g ${Send_HR_FILE.Address}
Receive File Path	ReceiveLocation.Address	Rcv_EmployeeUpdateFromSystemX_FILE.Address