Creating or editing a Connector manifest
When you create a new Connector, you need to include a manifest file as part of the Add-ons package. When you create a new .NET or Java Connector based on the Tridion Connector Template, a manifest.json gets created for you, ready for use with just a few changes.
About this task
By performing this task, you will configure a manifest file for your Connector, which will do the following:
- Describe the Connector as an Extension that can be uploaded and managed by the Add-ons feature.
- Define default values for Connector properties. For certain properties, implementers of a connector can override the values in the manifest with custom values they define in the connector's configuration file. If the property is also in the manifest, the value in the configuration file will override the default value set in the manifest. Implementers can also refine the configuration even further according to the environment or namespace.
Procedure
Example manifests
A .NET manifest created from the template:
The following sample code illustrates the manifest file of a Connector created from the Tridion Connector Template for .NET:
{
"manifestVersion": "1.0",
"version": "1.0.0",
"id": "MyAwesomeConnectorConnector",
"name": "MyAwesomeConnector Connector",
"author": "Tridion Developer",
"description": "MyAwesomeConnector Connector using Tridion.ConnectorFramework.SDK for .NET Standard.",
"requireConfiguration": "Yes",
"extensions": [
{
"type": "Connector",
"name": "MyAwesomeConnectorConnector",
"properties": {
"connectorLibrary": "MyAwesomeConnectorConnector.dll",
"connectorRuntime": "DotNetStandard"
}
}
]
}
A Java manifest for the Connector for Salesforce CRM:
{
"manifestVersion": "1.0",
"version": "1.1.0",
"id": "salesforce-crm-connector",
"name": "SalesforceCRM",
"author": "RWS Group",
"description": "CRM connector to Salesforce",
"requireConfiguration": "yes",
"extensions": [{
"name" : "SalesforceCRM",
"type": "Connector",
"supportedVersions": "9.1.0.0",
"properties": {
"connectorRuntime": "Java"
"connectorClassName": "com.sdl.tridion.connectorframework.connector.salesforce.SalesforceConnector",
"configuration": {
}
}
}]
}
What to do next
Include the manifest in your Connector's Add-on package (ZIP file).