BizTalk Naming Convention

BizTalk Naming Convention

Why it's important

Keeping a good overview of your environment as it grows is very important, you need to have a good foundation. By this you should follow good naming conventions for your applications, ports, orchestrations and hosts.

Even though it might seem though from the start the advantages of keeping a good naming conventions for all artifact will enhance the usability for everyone interacting with your BizTalk environment, for Microsoft or any other consultants you might need to hire a good naming convention will make it easier to "get to know your environment". This Wiki article will provide you with some information on how to do it however it does not affect resources, maps, BRE. It mainly focus on Applications and hosts, this guidelines may differ from company to company on how it should be. Let's say you work at a company only hosting applications created by your company (where you have internal development adding the company of the developing company to the application might not be necessary) however you might have many different vendors providing you with application, so adding the vendors name to the application will make it easier to know who to "contact" for assistance.

By starting out from day one with a good naming conventions it will be a lot easier as the environments evolve, as well as bring a better surveillance to make sure the critical "jobs" are up and running.

Below are a few examples and scenarios explained for a few different types of companies.

Naming conventions

Applications

Internal development

With many locations (warehouse, factory etc.)

Where you have interactions between 2 systems only
SystemA-SystemB.Location
Example:
ContosoFactory-ContosoStore.USA

Where communication is from or to one system but distributed to many systems
IntegrationName.Location
Example
ContosoUpdatingWarehouse.USA

Note: Location is optional

Internal and external development

With many locations (warehouse, factory etc.)

Where you have interactions between 2 systems only
CreatedBy.SystemA-SystemB.Location
Example:
Microsoft.ContosoFactory-ContosoStore.USA

Where communication is from or to one system but distributed to many systems
CreatedBy.IntegrationName.Location
Example
Microsoft.ContosoUpdatingWarehouse.USA

Note: Location is optional

Receive Locations, receive ports, Send ports (groups) and Orchestrations

Framework:
TypeOfPort.ToOrFrom/Purpose.Location
Example:

Receive Port
RcvPrt.ContosoFactory.USA

Receive Location
RcvLoc.ContosoFactory.NY

Send Port Group
SndGrp.ContosoWarehouse.Europe

Send Port
SendPrt.ContosoWarehouse.Norway

Orchestration
Orc.TransformOrderToUodateInv.Global

Hosts

When it comes to hosts its really up to how you want to do it, some companies don't have that many applications, and often split hosts for each applications, some have too many applications and must create many hosts of the same time to make it work. This guide is for dimension for a large company with many application, you can move out any of the elements you don't feel you need.

<Job>_<bit support>_<seq>_<adapter/functionality>_<throughput>_<priority>_<clustered>

Examples

This is a receive host, with x32, its sequence number 1, it is only running the FTP adapter, it is tuned for low latency and is clustered. It is also marked as critical
Rcv_x32_1_FTP_L_Critical_Clustered

This is a send host, x64 bits, this is the second adapter with this configuration (sequence number 2) and is running many different adapters, its tuned for high throughput, it is not marked as critical and isn't clustered
Snd_x64_2_Random_H_None_None

This is a 64 bit orchestration host, it is tunes for high throughput and is critical.
Orch_x64_H_Critical

Other languages

This article is available in the following languages


See Also

Read suggested related topic:

Another important place to find a huge amount of BizTalk related articles is the TechNet Wiki itself. The best entry point is BizTalk Server Resources on the TechNet Wiki.


Leave a Comment
  • Please add 2 and 8 and type the answer here:
  • Post
Wiki - Revision Comment List(Revision Comment)
Sort by: Published Date | Most Recent | Most Useful
Comments
  • Maheshkumar S Tiwari edited Revision 18. Comment: corrected typo error and minor formatting

  • Steef-Jan Wiggers edited Revision 17. Comment: Added resource link

  • Steef-Jan Wiggers edited Revision 15. Comment: Added tag

  • Steef-Jan Wiggers edited Revision 14. Comment: Minor edits

  • Carsten Siemens edited Revision 12. Comment: fixed typo

  • Tord G.Nordahl edited Revision 7. Comment: added reference to norwegian article

  • Tord G.Nordahl edited Revision 5. Comment: html cleanup

  • Tord G.Nordahl edited Revision 4. Comment: code cleaning

  • Tord G.Nordahl edited Revision 2. Comment: spell checking again!

  • Tord G.Nordahl edited Original. Comment: spellchecking

Page 1 of 1 (10 items)
Wikis - Comment List
Sort by: Published Date | Most Recent | Most Useful
Posting comments is temporarily disabled until 10:00am PST on Saturday, December 14th. Thank you for your patience.
Comments
  • Tord G.Nordahl edited Original. Comment: spellchecking

  • Tord G.Nordahl edited Revision 2. Comment: spell checking again!

  • Nice start on naming conventions.

  • Tord G.Nordahl edited Revision 4. Comment: code cleaning

  • Tord G.Nordahl edited Revision 5. Comment: html cleanup

  • Please also link to the Norwegian translation. Great job on building out this list!

  • Tord G.Nordahl edited Revision 7. Comment: added reference to norwegian article

  • Great start

  • Carsten Siemens edited Revision 12. Comment: fixed typo

  • Great article

  • Steef-Jan Wiggers edited Revision 14. Comment: Minor edits

  • Steef-Jan Wiggers edited Revision 15. Comment: Added tag

  • Steef-Jan Wiggers edited Revision 17. Comment: Added resource link

  • Maheshkumar S Tiwari edited Revision 18. Comment: corrected typo error and minor formatting

Page 1 of 1 (14 items)