General Naming Guidelines

The following naming guidelines provide the general rules to apply when developing applications on CloudIO Platform. Following this section are guidelines which detail rules for specific object types.

Throughout this document there are various naming guidelines. In the following guidelines it's important to not follow them blindly if the suggested naming convention will create meaningless names. In general you should attempt to follow the Java naming conventions wherever possible.

Non-Java Object names – The guideline for Classes should extend to non-Java specific objects you create in CloudIO Platform too. 
For example Datasource name should also use camel case with the first letter capped, such as SalesOrderHeader.

Acronyms in object names – If a name contains an acronym, only capitalize the first letter of the acronym rather than all the letters. 
For example, "RegisteredTfn" for “Registered Tax File Number” rather than "RegisteredTFN".

Meaningful object names – Object names should be meaningful even when they're taken out of context. For example naming page codes like P1001, P1002 means little and only a close inspection of the application and code would show their use. Alternatively names like SearchOrder and EnterOrder convey more information on what they're used for without looking at the application.

Common abbreviations in object names - Use abbreviations where the abbreviation is more commonly used than the long form of a name. For example use HTML and URL over HyperText Markup Language and Uniform Resource Locator.

Unnecessary abbreviation in object names - Avoid unnecessary abbreviation to assist readability unless the object name is large. For example DateOfBirth is easier to read than Dob. However use common sense. For example ExtensionToSeries700LegislationErrata would be clumsy to work with, so ExtSeries700Legislation may be better in this case.

Object name consistency - If you use acronyms or abbreviations, be consistent. For example don't refer to Tfn in one location and TaxFileNumber in another

Datasource Names:

Datasource names should match that of the relating database object name, but following the Java convention of using initialized camel-case names without special characters. For example the PURCHASE_ORDER_HEADER table would become the PurchaseOrderHeader datasource. An incorrect example would be Purchase_Order_Header or PURCHASEORDERHEADER.

Datasource Attribute Names:

Datasource attribute names should match that of the relating database column name, but following the convention of using initialized camel-case names with space between words and without any other special characters. For example the database ORDER_TOTAL column would become the "Order Total" attribute name. Calculated attribute names should indicate their purpose or intent. For example a calculated attribute that uses the expression "UNIT_PRICE * QUANTITY" could be called "Total Price".

Page Code:

Page code names should match that of the functionality offered by the page, but following the convention of using initialized camel-case names without special characters. For example the page that offers the functionality to query sales orders would become the "SearchSalesOrdersPage" or "SearchSalesOrders" page code.

Page Name:

Page Name names should match that of the functionality offered by the page, and be more meaningful to the enter user. Page Names are used to create the navigation menus and hence should be short, simple & meaningful. For example the page that offers the functionality to query sales orders would become the "Search Sales Orders" page name.

Item Id:

By default Item Id is generated as item1, item2 etc., by the platform while creating new items in CloudIO Designer. Make sure to give a meaningful name while referencing those item ids at other location. For example, when you are using an ActionHide to hide a Cancel Order Button with item id "item1234", make sure to change the item id of the button to "cancelOrderBtn" and then use it for ActionHide to specify the target item id to hide. If the item id is not being used by other items, then you can leave them as is. Since any complex page could potentially contain 1000+ items, always try to keep the item id short or leave it to the system generated value. Shorter item ids means less memmory consumption and faster processing.

Location

101 California Street, Suite 2710
San Francisco, CA 94111


440 N. Wolfe Rd.
Sunnyvale, CA 94085


Office 11, 5th Floor, Building 9,
Mindspace IT Park
Hyderabad 500081

p: +1 (844) AT CloudIO (844-282-5683)
f: +1 (650) 300-5247 | e: sales@cloudio.io
© 2009, 2017 CloudIO Inc. | Terms of Use | Privacy Policy