0

I see we have a Gateway article for example configuration, documentation for the manifest.json file for Add-On packages, and good examples by @vantonenko on GitHub.

But is there a JSON schema of sorts or list of the manifest options, specifically for properties like EXTENSIONTYPE and EXTENSIONVERSION. Also, do paths use forward ("/") or back ("\") slash?

Ideally, it'd be nice to be able to create and edit the Add-On manifest.json file with auto-completing intellisense, but a list of valid options would be helpful as well.

1 Answer 1

0

I'm adding a Community wiki to gather examples and known details. Feel free to add to this or add an answer if there is a Schema for the manifest file format for Add-ons.

Type

The list of type options are documented under Extension Types and includes, as of Tridion Sites 9.6:

  • CMApplicationDataConfiguration
  • Connector
  • CDDeployerExtension
  • CDModelTransformerExtension
  • CMResolver
  • ECLProvider
  • CMEventHandler
  • UIEditor
  • UIModel
  • CDGraphQLSchemaExtension
  • CDMergeableConfigurationExtension
  • CMApplicationDataConfiguration

Use "\" for local paths

In the Application Data Configuration Extension documentation you can see a file referenced using double back slash:

{
  "name":"MyAppDataConfigurationExtension",
  "type": "CMApplicationDataConfiguration",
  "properties": {
    "xmlFileName": "CM\\MyCustomAppDataConfig.xml"
  }
}

The MyCustomAppDataConfig.xml app data configuration file is placed in a folder named "CM" in the Add-on ZIP file.

Yet Another Example

Here's the manifest file format per the documentation.

{
  "manifestVersion": "MANIFESTVERSION",
  "version": "ADDONVERSION",
  "id": "ADDONIDENTIFIER"
  "name": "ADDONFEATURENAME",
  "requireConfiguration": "CONFIGREQUIREMENT",
  "author": "AUTHORNAME",
  "description": "DESCRIPTION",
  "icon": "ICONIMAGEFILE",
  "extensions": [
    EXTENSION1,
    EXTENSION2,
    ...
  ]
}

Here's an example from demos and training.

{
  "manifestVersion": "1.0",
  "id": "SchemaRenamer",
  "version": "1.0",
  "name": "SchemaRenamer",
  "description": "Event System Extension",
  "icon": "Renamer.png",
  "author": "Demo User",
  "requireConfiguration": "Yes",
  "extensions": [
    {
      "name": "TCMExtension",  
      "type": "CMEventHandler",
      "properties": {
            "assemblyFileSource": "EventSystemExtension.dll"
      }
    }
  ]
}

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.