Each extension provides meta-data describing the author/developer of the extension and other information related to its creation. This meta-data is contained in a manifest file called ext.json
. Without the manifest file, the extension cannot be loaded. The ext.json
file should include:
extensionID
: Unique ID of the extension. Note that this ID must match the value generated on the Extensions page in the administrative console. See “Install the extension” in Using Oracle Commerce Cloud for more information.developerID
: The extension author’s unique developer ID.createdBy
: The name of creator (company or individual).version
: The version of the extension, expressed as a single whole number.timeCreated
: When the extension was created.iso-8601
is the recommended format; however, an informal time stamp is also acceptable.translations
: An array that provides translations for both the extension name and description. These properties are displayed on the Extensions page that is accessible from the Settings page in Commerce Cloud. For example, the English translation for the name of the extension in the illustration below is “Visit Counter Widgets” and the description is “Provides visitor counting related functionality”.
An example of an ext.json
file that includes translations for English and French is shown below. Note that the translations
property has three sub-properties, language
, name
, and description
. The language
property can be either a two-letter language code (for example, en
) or a two-letter language code and a two-letter country code with an underscore in between (for example, en_US
). ISO 639-1
defines the two-letter language codes. ISO 3166-1 alpha-2
defines the two-letter country codes.
{ "extensionID": "f3acef8e-375a-11e4-9c85-ebc5b52923a8", "developerID": "987654", "createdBy": "Company name", "version": 1, "timeCreated": "2016-09-08", "translations" : [ { "language" : "en_US", "name":"Extension label in English", "description":"Extension description in English" }, { "language" : "fr_CA", "name":"Extension label in French", "description":" Extension description in French" } ] }