Manage Integrated Apps and Add-ons

Why manage integrations

Add-ons extend CMS functionality without custom development. A DAM connector brings external assets into the media library. A translation service automates multilingual workflows. Managing integrations centrally ensures they stay updated, secure, and compatible with your CMS version.

Install an add-on (PaaS)

On PaaS, add-ons are NuGet packages installed into your .NET project.

1. Open your project in Visual Studio or your preferred IDE.
2. Open the NuGet Package Manager.
3. Search for the add-on by name (for example, Optimizely.Labs.ContentManager).
4. Install the package and accept any dependency prompts.
5. Build the project to verify no conflicts.

Install via CLI

CLI

bash Copy

dotnet add package Optimizely.Labs.ContentManager --version 1.5.0

6. Deploy your project to the target environment.
7. Verify by navigating to the admin panel. The add-on should appear in the installed list.

CMS

On CMS PaaS, always check version compatibility before installing. Review the add-on’s release notes for supported CMS versions.

Install an add-on (SaaS)

CMS

On CMS SaaS, add-ons are installed from the App Marketplace. No code deployment is needed for marketplace apps.

1. Navigate to Settings > App Marketplace in the CMS.
2. Browse or search for the integration you need.
3. Click Install on the app listing.
4. Follow the on-screen configuration wizard.
5. Verify by checking Settings > Installed Apps. The app should show as active.

Configure an add-on

Most add-ons require configuration after installation.

1. Navigate to Settings > Installed Apps (or the add-on’s settings page).
2. Enter required values such as API keys, endpoints, or feature toggles.
3. Save the configuration.
4. Test the integration by performing the action it enables.
5. Verify by checking the add-on’s status indicator. It should show connected.

Configure an add-on in appsettings.json (PaaS)

appsettings.json

json Copy

{
  "Integrations": {
    "DAMConnector": {
      "ApiEndpoint": "https://dam.example.com/api",
      "ApiKey": "your-key-here",
      "SyncInterval": 30
    }
  }
}

Update an add-on

Keep add-ons updated for security patches and new features.

1. PaaS: Update the NuGet package version. Build and test before deploying.
2. SaaS: Check Settings > Installed Apps for available updates. Click Update.
3. Review the changelog for breaking changes before updating.
4. Verify that existing functionality still works after the update.

Remove an add-on

1. PaaS: Uninstall the NuGet package. Remove any configuration entries. Deploy.
2. SaaS: Go to Settings > Installed Apps. Click Uninstall on the app.
3. Verify the add-on no longer appears in the admin interface.
4. Check that no errors appear on pages that previously used the add-on.

Monitor integration health

1. Check the CMS logs for errors related to the integration.
2. Review the add-on’s status page or health check endpoint if available.
3. Set up alerts for integration failures in your monitoring system.
4. Verify by reviewing the logs after a typical usage period. No recurring errors should appear.

Manage plug-ins from the admin interface

The Plug-in Manager gives administrators a centralized view of all installed components, including scheduled jobs, content providers, and editor extensions. You can enable or disable individual plug-ins without removing their code or NuGet packages.

View installed plug-ins

1. Navigate to Admin > Plug-in Manager.
2. Review the list of installed plug-ins. Each entry shows:
   • Name: The plug-in display name.
   • Type: The component category (Scheduled Job, Content Provider, Editor Extension, etc.).
   • Status: Whether the plug-in is currently enabled or disabled.
   • Assembly: The source package or assembly containing the plug-in.
3. Use the search field to filter plug-ins by name or type if the list is long.

Enable or disable a plug-in

Disabling a plug-in prevents it from running without uninstalling the underlying package. This is useful for troubleshooting, for disabling features in specific environments, or for temporarily turning off a scheduled job.

1. Navigate to Admin > Plug-in Manager.
2. Find the plug-in you want to modify.
3. Click the plug-in name to open its details.
4. Toggle the Enabled switch to turn the plug-in on or off.
5. Click Save.
6. Verify the change:
   • For scheduled jobs, check that the job no longer appears in the Scheduled Jobs list when disabled.
   • For editor extensions, verify the extension is no longer visible in the editor toolbar.
   • For content providers, confirm the provider’s content no longer appears in the content tree.

CMS

On CMS PaaS, the Plug-in Manager reflects all components registered through the CMS plug-in system. Third-party NuGet packages that register plug-ins appear here automatically after deployment. Disabling a plug-in in this interface does not remove the NuGet package from your project.

Reset a plug-in to defaults

If a plug-in behaves unexpectedly after configuration changes, you can reset it.

1. Open the plug-in details in the Plug-in Manager.
2. Click Reset to Defaults.
3. Confirm the reset when prompted.
4. Reconfigure any settings the plug-in requires.
5. Verify by testing the plug-in’s functionality.

Common issues

Issue	Cause	Fix
Add-on not loading	Version incompatibility	Check supported CMS versions
API connection failed	Invalid credentials	Re-enter API key in settings
Feature missing after install	Missing configuration	Complete the setup wizard

Related content

Continue your journey with these related pages.

🔧Follow a guide

• Configure Search
• Connect Marketing Automation