Documentation Center

Installing the Tridion Integration Framework PCA extension

Connectors built on the Tridion Integration Framework enable you to use GraphQL requests to the Content Service to access of Tridion Sites content in a headless fashion. Implementing this type of integration requires a Tridion Integration Framework extension to the Content Service.

Before you begin

This task has the following as prerequisites:
  • You have access to the extension on your installation media.
  • Content Delivery is installed, in particular, the Content Service.
  • The Add-on feature is installed.

Procedure

  1. Locate the following ZIP file on your installation media:

    \Tridion\Content Delivery\roles\tif\add-ons\connector-framework-pca-extension-assembly-n.n.n-xxx-tcf.zip

    Where:

    • n.n.n corresponds to the specific release of Content Delivery you are using, such as version "11.1.0".
    • xxxx is a build number and matches your file from your installation media. For example: connector-framework-pca-extension-assembly-11.1.0-1044-tcf.zip

    When the extension is run, the ZIP file will be expanded into a folder with the same name as the ZIP.

  2. From the Manage tab of the Add-ons screen, upload the ZIP file.

    For instructions on using the Add-ons feature, refer to the related topics on this subject.

  3. Optional: (Optional) Add framework-specific configuration to the Content Service's application.properties file.

    These properties affect the Tridion Integration Framework's Connector Manager, which is the part of the framework that handles all interactions with the Application Client (in this case, PCA).

    1. From the ZIP file, open the following sample properties file: \confg\application.properties
    2. Copy any of the properties that you want to set for the framework from this sample file to the application.properties file of the Content Service, and configure the values as needed.
  4. Restart the Content Service or Session-enabled Content Service by running start.ps1 (Windows) or start.sh (Linux).

Results

After installation, the Tridion Integration Framework PCA extension is exposed through the usual PCA endpoint: /cd/api

What to do next

From the Manage tab of the Add-ons screen, check the status of the uploaded Tridion Integration Framework extension. If deployed successfully, the Content Service will report a "Success" status.