Management Center file and class naming conventions

All Management Center files follow a consistent naming syntax or convention. Any files that you add to the Management Center should follow the same naming conventions as the default files provided with the Management Center. Keeping consistent file and class naming conventions is important if you plan to migrate to a later release, or if you require assistance from IBM support with your customizations.

When customizing the Management Center, consider the following types of naming conventions: OpenLaszlo naming conventions, definition naming conventions, and JSP file naming conventions.

OpenLaszlo naming conventions

OpenLaszlo classes: OpenLaszlo classes must be named using a three-character Management Center component code (in lower case), the class name (in camel case), and the superclass suffix. For example, catProductObjectDefinition or catProductFilter. The valid three-character Management Center component codes are cat (for the Catalogs tool), pro (for the Promotions tool), mkt (for the Marketing tool), att (for the Assets tool), and wcf (for the Management Center foundation or shell).
If you extend any of the default OpenLaszlo classes, it is recommended that you prefix the class names with ext so that they are clearly identified as extensions. For example, if you extend catProductObjectDefinition, name the extended class extCatProductObjectDefinition.
OpenLaszlo library files: Library source files must be named after the main class declared in the library, minus the three-character component code prefix. For example, name the library source file that contains the catProductPrimaryObjectDefinition class, ProductPrimaryObjectDefinition.lzx.
OpenLaszlo methods, views, attributes, and arguments: Method, view, attribute, and argument names must start with a lower case letter and then camel case for the remaining text. For example, resourceBundleKey or displayName.

Definition naming conventions

Definition names: Definition names are typically formed using a three-character Management Center component code (in lower case), the definition name (in camel case), and the class name suffix. For example, catBaseCatalogEntryPrimaryObjectDefinition. Some object definitions must use the object type for the definition name. For example, the definition name for the product primary object definition is Product. Primary objects and organizational objects that are not base definitions must use the object type as the definition name. All search definitions must use the search type as the definition name. For example, the definition name for the find all catalog entries search definition is FindAllCatalogEntries.
Definition files: Definition files must be named after the main definition declared in the library, without the three-character Management Center component code prefix. For example, a definition file that contains the catBaseCatalogEntryPrimaryObjectDefinition must be named CatalogEntryPrimaryObjectDefinition.def.

JSP file naming conventions

JSP files for search: JSP files used for search follow this syntax: FindobjectType.jsp. For example, FindProduct.jsp, or FindActivity.jsp.
JSP files for locating a single object: JSP files used to locate a single object follow this syntax: GetobjectType.jsp. For example, GetMasterCatalog.jsp, or GetPromotion.jsp.
JSP files for locating child objects: JSP files used to locate child objects follow this syntax: GetobjectTypeChildren.jsp.
JSP files for locating reference objects: JSP files used to locate reference objects follow this syntax: GetobjectTypeReferences.jsp. For example, GetCatalogGroupReferences.jsp, or GetCatalogGroupReferences.jsp.
JSP fragment files for serializing objects: JSP fragment files used to serialize objects follow this syntax: SerializeobjectType.jspf. For example, SerializeCatalogEntry.jspf.

For more details about the conventions for JSP files and Struts actions, see Management Center Web application.