Sign in
< Back to Top

Naming Conventions

A good practice is to use a standardized method when naming Projects, Packages, and objects.
It’s especially critical when employing a modular approach to designing solutions using the CIC Studio.

(There are also naming conventions for  CIC Cockpit resources.)

The recommended rules discussed here are based on common standards and experience and provide several benefits.

  • Enhance clarity in cases of potential ambiguity
  • Avoid naming collisions or duplicate names
  • Provide meaningful information
  • At-a-glance understanding of Projects/Packages/objects
  • Predictability

Certain naming restrictions are enforced by the platform. These are noted here, along with strong recommendations meant to avoid potential complications.

Resource Naming Requirements & Recommendations
Projects
  • Use all lowercase characters.
  • Use a period as a separator, where necessary.
  • Use alphanumeric characters.
  • Include your web domain name/division/location, if more than one.
  • Include an identifier used to organize objects. For example, trading partner names and/or document types.
  • It is recommended that you create a core or common Project to organize commonly reused Packages/objects.

Examples:

  • com.mycompany.cic.backend
  • com.mycompany.division1.common
  • com.mycompany.cic.us.walmart
  • com.mycompany.division2.invoices
Packages
  • Use the Project name plus a qualifier.
  • Use all lowercase characters.
  • Use a period as a separator, where necessary.
  • Use alphanumeric characters.
  • Package names cannot begin with a number.
  • Java keywords are not permitted (see Java Keywords below).
  • Use simple, but meaningful names.
  • Include an identifier used to organize objects. For example: document types and/or direction.

Examples:

  • com.mycompany.cic.backend.flatfile
  • com.mycompany.division1.common.core
  • com.mycompany.cic.us.walmart.edi
  • com.mycompany.cic.division2.invoices.acme
Objects
  • Object names cannot begin with a number.
  • Use UpperCamelCase (the name is formed by joining multiple words with the first letter of each of the multiple words capitalized).
  • Use alpha-numeric characters (the dollar sign and underscore are permitted).
  • Although the file extension indicates the object type, you should always include the type (or an acronym) in the name.
  • See File Extension Acronyms below.

Examples:

  • Edi850ToDatabaseRS.ruleset
  • InvoiceTablesDBA.dbAdapter

File Extension Acronyms

The following file name extension acronyms are recommended for use in Object names.

Object Suffix Extension
Application Interface AI .appInterface
Application Route AR .appRoute
Business Process BPS .bps
CodeTable CT .codeTable
Control Number Generators CN .controlNumber
Cloud Adapter CA .cloud.adapter
Cloud Monitor CM .cloud.monitor
Data Source DS .dataSource
Database Schema DB .dbSchema
EDI Enveloper ENV .ediEnveloper
EDI Schema EDI .ediSchema
Event EV .event
Flat File Schema FF .ffSchema
Global Variable GV .globalVar
Inbound EDI Route IR .inboundEdi
JSON Schema JSON .jsonSchema
Next Number NN .nextNumber
Outbound EDI Route OR .outboundEdi
Process Scheduler PS .sched
Ruleset RS .ruleset
Ruleset Data Object RDO .rulesetDataObject
Spreadsheet Schema SS .ssSchema
SQL Access SQL .sqlAccess
Trading Partner TP .tradingPartner
Transformation Settings TS .tfSettings
Web Service Consumer WSC .wsConsumer
Web Service Provider WSP .wsProvider
XML Schema XML .xmlSchema

Java keyword restrictions

The following Java keywords cannot be used in Package names.

abstract
assert
boolean
break
byte
case
catch
char
class
const

continue
default
do
double
else
enum
extends
final
finally
float

for
goto
if
implements
import
instanceof
int
interface
long
native

new
package
private
protected
public
return
short
static
strictfp
super

switch
synchronized
this
throw
throws
transient
try
void
volatile

Duplicate names

Certain naming restrictions are enforced by the platform. These are noted here, along with strong recommendations to avoid potential complications.

For this Resource... Duplicate Names are …
Projects
  • not allowed
Packages
  • not allowed within the same Project
  • not advised, even when in different Projects
Objects
  • not advised within the same Project
  • not advised, even when in different Projects or Packages

Related articles

Comments

0 comments

Please sign in to leave a comment.