Configuring a Connector
Connectors require that you provide custom configuration for the Connector's Add-ons package in the form of a JSON configuration file.
Before you begin
To complete a configuration file for an Connector, you need to know the following:
- The name of the Connector as it is defined in the Add-on's manifest file.
- The name of each Content Delivery environment to be specifically configured for an Connector, as they are defined in the cdenvironment environment variable of each environment.
About this task
After adding a Connector to your SDL Tridion Sites implementation, create a JSON configuration file to your needs and upload it to the Add-ons service. The configuration includes settings that are specific to your implementation, such as endpoint URL, username, password, and more.
Procedure
Example configuration created from the .NET template
The following sample code illustrates the configuration file of a new .NET Connector for YouTube, which has two defined namespaces and integration on the Content Management-side:
{
"configuration": {
"YouTube": {
"privilegedUserName": "global\\userID",
"configuration": {
"apiKey": "API_KEY_123456",
"channels": ["CHANNEL_A_123456",
"CHANNEL_B_123456",
"CHANNEL_C_123456"],
"updatableChannels": ["CHANNEL_B_123456"],
"pageSize": 20,
"enableTemplateCapability": "true"
},
"namespaces": {
"ytb": {
"displayName": "YouTube",
"stubFolders": ["tcm:1-4-2"],
},
"ytb1": {
"displayName": "YouTubeDynamic",
"stubFolders": ["tcm:1-4-2"],
}
}
}
},
"sitesCm":
{
"isEnabled": true,
"configuration": {
"apiKey": "API_KEY_123456",
"channels": ["CHANNEL_A_123456",
"CHANNEL_B_123456",
"CHANNEL_A_123456"],
"updatableChannels": ["CHANNEL_B_123456"],
"pageSize": 2,
"enableTemplateCapability": "true"
}
}
}