> > > Best Practices – Naming Conventions

Best Practices – Naming Conventions

23rd June 2016

Sean Hoppe Consulting Group

In the Cleo Clarify Studio, there are not many limitations to what you can name a Project, Package, or object with the exception of almost fifty different Java-oriented keywords. As you may have seen from our previous tips on the Core Project, Base Project, and Project/Package Structure, our naming conventions for our resources maintained a unified standard that you may not be very familiar with. This standard was developed by EXTOL upon the release of EBI version 3.1 and the new EBI Studio, and adopted by EXTOL Services and their partners.

Before we get into discussing how you should name your resources, let’s first talk about why.

Project Explorer Example Naming Conventions


Projects

At first glance, the com.YourCompanyName.clarify.TradingPartnerName Project name seems very long and unnecessary. However, if you understand why this is recommended, it may persuade you to adopt this standard like we have!

If you have a Java programming background, you’ve probably heard of errors such as java.lang.NullPointerException.  You may have even seen a similar error message in Cleo Clarify, or older versions of EXTOL Business Integrator.  The Project and Package naming convention are a lot like this convention.  Each period separates a different level; think of this that each period represents a new folder nested within a previous folder. A java folder that contains a lang folder.  The lang folder that contains a single file, as it is the last section after the last period.  

This structure maintains organization even inside of the Studio installation folder.  Eclipse, the framework behind Cleo Clarify, uses similar structure to organize internal resources, as shown below.

Eclipse Naming Convention and Folder Structure


This convention adjusted by EXTOL to suit their resources was based on existing programming conventions and have been around for a very long time.

Now that you understand why, how to name your Project is as simple as following the com.YourCompanyName.clarify.TradingPartnerName convention.


Packages

We’ve discussed naming conventions for Packages in our previous tip, check it out to find out what you should name your Packages, and how to properly organize them for your needs.

For your Projects and Packages, you should use all lower-case characters to maintain uniformity with Eclipse, but not required.


Objects

For your objects, you should include your Trading Partner name in Trading Partner-specific resources. For generic objects, you should leave the Trading Partner name out, and perhaps use the syntax or document type (and should be placed in your Core Project!).

Object names should be in upper-camel case.  For example, InboundEdi850toPurchaseOrderFfRS.   If you are to use EDI, XML, FF, or any other common acronym within your object name, they should also be upper-camel case except for those used on the acronym at the end of the object, like the Ruleset (RS) as shown above, to differentiate between those acronyms and showing their importance.

In your object names, having a short acronym at the end can help easily find your resources by using the Search menu option (or Ctrl + H) and using the asterisk ( * ) character as a special character to assist in searching.  This search will find all of your Control Number Generators that maintain the acronym at the end of the object name.

Search Using Acronyms Naming Conventions


Below is a list of acronyms for those objects.

  • Application Interface (AI)
  • Application Route (AR)
  • Business Process (BPS)
  • CodeTable (CT)
  • Control Number Generator (CN
  • Data Source (DS
  • Database Adapter (DBA
  • Database Monitor (DBM
  • Database Schema (DB)
  • EDI Enveloper (ENV)
  • EDI Schema (EDI)
  • Email Receive Monitor (EM)
  • Email Send Adapter (EA)
  • Event (EV
  • External API - Java Program (API
  • File Adapter (FA
  • File Monitor (FM
  • Flat File Schema (FF
  • Formula (FOR
  • FTP Adapter (FTP
  • Global Variable (GV
  • Inbound EDI Route (IR
  • Message Filter (MF
  • Next Number (NN
  • Outbound EDI Route (OR
  • Process Schedule (PS
  • Ruleset (RS
  • Ruleset Data Object (RDO
  • Spreadsheet Schema (SS
  • SQL Access (SQL
  • Trading Partner (TP
  • Transformation Settings (TS
  • Web Service Consumer (WSC
  • Web Service Provider (WSP
  • XML Schema (XML

The image below shows many objects with their acronyms.

Sears Project Explorer Example Naming Conventions


By: on