> > > Best Practices - Base Project

Best Practices - Base Project

16th June 2016

Sean Hoppe Consulting Group

In our last tip, we reviewed our first best practice in designing your integration solution in Cleo Clarify.  We discussed how and why you should utilize the Core Project, and then detailed how to configure your Project dependencies.  Maintaining a properly structured Project Explorer is essential to develop efficiently.  The next Project that you should have that we’re going to review is the Base Project.

Base Project

The Base Project is a Project that will allow the user to copy generic, pre-configured resources and paste them into a trading partner-specific Project so that they can be modified to meet partner requirements.  The term base derives from the use of “base maps” .. a term used by EXTOL Services implementation and methodology to copy old Rulesets and alter them for each trading partner.  In doing so, this allowed for quick configuration and on-boarding without the need to create resources from scratch each time.

Much like our Core Project, the Base Project should not contain any trading partner-specific resources, but generic resources.  Rulesets should contain a well-defined structure of composite and basic rules that may suit a wide variety of partners, instead of being configured specifically for an individual partner.  When a generic Ruleset is copied into the trading partner Project, that Ruleset can be renamed and then modified to suit that partner’s needs to include rule conditions, and even disable and delete unnecessary rules.  The most time consuming part of on-boarding has already been developed, and can be reused time and time again.

Base Project Clarify Studio Project Explorer Best Practices

Because we are not using resources directly from within the Base Project in other Projects, dependencies do not need to be configured.  The Base Project is also not designed to be deployed to a remote server environment. It can be maintained directly from your Project Explorer in your Cleo Clarify Studio, or even from your SVN Repository.

Some resources that you may wish to place inside of the Base Project could be:

  • Ruleset Data Object (RDO) – This object can contain generic variables with values pre-configured that pertain to your company, such as your partner identifier or even contact information. Partner-specific values can be included into the variables after it is copied.

  • Rulesets – As previously mentioned, Rulesets can very well be the most time consuming part in designing and on-boarding a new trading partner.  By taking the time to create a “base map” , this will save time for every new partner.
  • Schemas – Not all Schemas can be reused. But, perhaps you’re receiving similar flat file documents, or EDI documents, from different trading partners. Schemas can be copied and then altered into the partner-specific Project.

  • File Adapters – File Adapters may contain partner-specific values.  If they are already created, even without every parameter, they can be modified to adhere to partner requirements.


By: on