How to build custom connector using Tridion Integration framework

Tridion Integration Framework helps you to write and deploy Connectors for integrating Tridion Sites with third-party applications. The Tridion Integration Framework is provided for the various Application Clients that it supports. The method of installation the framework may differ from client to client.

RWS Documentation Reference : https://docs.rws.com/1099777/729801/tridion-sites-10-connectors/building-a-new-custom-connector

 

API  reference documentation reference :  https://docs.rws.com/1099777/918320/tridion-sites-10-connectors/api-reference-documentation-downloads

Step 1)  Installed on your machine .NET 6. Download the .NET SDK

Step 2)  Install the connector Template based on the Tridion Sites Version listed below.

Step 3) Open a command line and run the following command to install the template:

dotnet new install Tridion.Connector.Template

The command installs the template to your .NET Core environment. You can verify that it's properly installed by running only the dotnet new command

Step 4)  Create a folder where you want to generate a new connector project.  – Example C:\Connector

 

Step 5) From a command line, go to the folder you created in the previous step and run the following command:

dotnet new tridionconnector --n PROJECT_NAME

Where PROJECT_NAME is the name you want to use for the new project. As a best practice, we suggest you use the same name as the folder containing the project.

The command builds the connector project with everything you need to build your custom connector. The project includes the following resources and samples:

  • Entity types
  • Capability implementations
  • Test data
  • Icons
  • Add-on manifest
  • Connector configuration

Step 6)  Edit the manifest.json file, as needed.

Step 7)  From the command line, run the following command to generate the Add-ons package:

 

dotnet build

Note: You can also build the package from within your IDE.

Step 8)   Logon to  Tridion Content Management System and Create a folder called Stubs and Copy the tcm URI  example : tcm-2-167-2

 

Step 9) Navigate to the folder where the json file is created Example : DemoConnectorConnector.json edit the file change the  value from Default Value "stubFolders": ["tcm:4-67-2"]  to tcm-2-167-2 and Save the file

Step 10 ) Upload the package (as a ZIP file) to the Add-ons feature.

Access the Add-on URL and click on the Upload Addon Package

Upload  the  json configuration file

access the Content Manager CME and refresh the Add-on to show the connector is activated successfully

Step 11 ) Logon to Content Manager and you will see the Demo Connector with few Folders and Files