Documentation Center

Implementing Add-ons

To extend the functionality of Tridion Docs with custom functionality, create or obtain one or more Add-ons.

Add-on packages

An Add-on takes the form of a ZIP file. The ZIP file must contain one or more Extensions, which together represent your custom feature. If you want, you can combine multiple custom features in a single package as well.

The package must also contain a manifest file, which explains where each Extension is located, and may include custom configuration for each Extension.

The implementer of the Add-on can choose to make some of the properties of the Add-on configurable by the Add-on user. If so, that user can provide such custom configuration in the form of a JSON file, which the user uploads separately to customize their instance of the Add-on.

The name of the ZIP file must be one of the following:
  • IDENTIFIER.zip
  • IDENTIFIER-VERSION.zip
  • IDENTIFIER-VERSION-COUNTER.zip
where:
  • IDENTIFIER is a unique identifier for the Add-on as specified in the id attribute in the manifest file.
  • VERSION is a version number (optional) for the Add-on as specified in the version attribute in the manifest file.
  • COUNTER is any number that helps you identify this particular instance of the file. This number is yours to set, and is not in the manifest file. Compare it to a build number.

Your package resides either in the Cloud or on a network share. Tridion Docs automatically detects any change you make to the package, including your removal of the package.

WebExtensions application

The WebExtensions web application is responsible on adding extensions for Organize Space. By default, the WebExtensions application provides the following single endpoint:

https://BASEURL/ISHEXTPROJECTSUFFIX/Extensions

Where:

  • BASEURL is the value defined for the Content Manager installation

  • PROJECTSUFFIX is an optional unique identifier for the application

For example:

https://example.com/ISHEXT/Extensions

Log files

The following is the default location for log files:

C:\\InfoShare\\DataSQL2019\\Logs

Authentication

Authentication is handled by Tridion Access Management. As a result, administrators can give or restrict access to extensions, as needed. By default, all users authenticated with the Tridion Docs Identity Provider (or ISHID) has access to the WebExtensions web application. If you are using other identity providers, you need to also configure them with the appropriate audience and role.

Note that the required bearer token is handled automatically in Organize Space by BFF (backend for frontend).

Authorization

There are two options for authorization:

  • Authorize attribute - With this option, the application checks the user in the Content Manager database to determine if an [Authorize] attribute is present.

    Use this method when you need functionality from Web Services API20/API25.

  • Authorize policy - With this option the application will not check the user in Content Manager database and instead uses the following policy: [Authorize(Policy = "DisabledInfoShareUserAuthorizationRequirement")]

    Use this method only when you do not need functionality from the Web Services API20/API25 API, such as for third-party calls or dashboards.