Best Practices

The widely accepted standard for a given procedure is known as a best practice as it produces the optimal results. In the ES asset extension model the following best practices are followed for naming conventions and jaggery modules.

Naming Conventions

This section describes the naming convention best practices that are recommended when naming different aspects in ES.

App and extension naming	All extensions should be in the caterpillar case. Example: store-common The store and publisher prefixes have been reserved for ES extensions only.
Variable naming	All code and extensions in ES conforms to the camel case naming convention.
Commenting	ES and the related modules conform to the JSDoc commenting specifications when commenting.
Reusable code	Code segments being shared across pages or api endpoints should be collected into a javascript module and imported using the respective syntax accordingly.

Jaggery modules

This section describes the different jaggery modules used for asset extensions, which is in the <ES_HOME>/modules folder.

`rxt` module	The `rxt` module encapsulates the extension model of ES. It provides an API for the following: Building asset managers to perform CRUD operations. Resource resolution callbacks for the Caramel framework.
`lifecycle` module	The `lifecycle` module provides an API to work with the Governance Registry SCXML life cycle model. You can use this module to carryout the following actions: Retrieve the available life cycles for a given tenant. Retrieve JSON definitions of life cycles. Retrieve information on the state of an asset type. Identify the transitions between two states in an asset life cycle.
`utils` module	The `util` module provides the following functions and objects: Common request parameter parsing functions. Reflection methods for working with JS objects.
`store` module	The store module provides the following utility methods: Methods for working retrieving tenant details of logged in users Methods for working with tenant configurations