Project Template Recommendations

 The structure of the Project to be used as the template determines the effectiveness of the Project Generator. A well-formed Project, with resources clearly identified using recommended naming conventions, as well as logical organization, ensures good Project generation, and limits the amount of required configuration between objects.

Taking the initial effort to select or create a well-formed Project Template will make all future use of the Project Generator more effective and save development time and effort. Consider these recommendations when selecting a Project Template for the Project Generator.

Use good names for Project resources

Practice good naming conventions for your resources. Use consistent identifiers in your Project and object names so that the Project Generator can quickly and accurately find and replace new resource name values. When using trading partner-specific objects, include the identifying name in all resource names; this supports better value replacement in the generated Project. Nothing will be substituted if values can't be found.

Consider this example:

A Template Project contains the identifier "TradPart" in the names of the Project, Package, and objects.

• Template Project name: com.cic.TradPart
• Object names: TradPart204IR.inboundEdi, TradPart204Inbound4010RS.ruleset, and TradPartIR.inboundEdi

For our generated Project, our new trading partner name "NewCustomer" can be quickly replaced as the Template Trading Partner Name.

• New Project name: com.cic.NewCustomer
• Object names: NewCustomer204IR.inboundEdi, NewCustomer204Inbound4010RS.ruleset, and NewCustomerIR.inboundEdi

If we were to inspect other objects, such as the Trading Partner, Inbound/Outbound Routes, or EDI Envelopers for the new Project, we would see that these same identifiers have been replaced (TradPart to NewCustomer). Conversely, if naming was inconsistent, there would be a greater chance that not all resources would be correctly identified for replacement.

Avoid these names

The following names should not be used as identifiers, as potential conflict with other resources may occur.

• Template
• TradingPartner
• X12
• Edifact
• Tradacoms

Use a Core Project for shared objects

Cleo recommends creating a generic CORE Project (for example: com.mycompany.cic.core) to contain all the common, shared objects. When you create a trading-partner-specific Project, reference the CORE Project. That way, when an object used by multiple Projects needs to be changed, you'll immediately know it's contained in the shared Project.  See Sharing Resources for additional information.

Let Cleo help!

Take advantage of available demos, sample Project templates, and Trading Partner .csv templates. These helpful resources can be downloaded from an SVN repository provided by Cleo. See Connecting to the Cleo Repository for access information.

These resources support the use of the Project Generator, while sample Projects can be checked out to your Workspace and be used as templates for your own Projects.

Please contact your Cleo Support for more information on repository contents and access.