Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline Authoring and Editing DITA Content Oxygen Desktop Plugin Oxygen Desktop Plugin Installation and Updates CMS 10.6 Oxygen Desktop Plugin Installation Installing CMS 10.6 Connector Add-on

Installing CMS 10.6 Connector Add-on

Prerequisites
  • System administrators must install the CMS 10.6 Oxygen Web Service for the Ingeniux CMS site instance. See Installing CMS 10.6 Oxygen Web Service for details.
  • Users must install Oxygen XML Editor 23.0+ on their authoring client. See the Oxygen XML Editor website for details.
    Important
    For MacOS Oxygen XML Editor installations, the Ingeniux CMS Connector add-on requires the Oxygen XML Editor/Author/Developer folder to reside directly under the Applications folder. The connector add-on also requires oxygen.sh, oxygenAuthor.sh, and oxygenDeveloper.sh to reside within the Oxygen XML Editor/Author/Developer folder.

Install the Ingeniux CMS Connector 1.6.4+ add-on in your Oxygen XML Editor 23.0+ application to enable DITA authoring with the Oxygen Desktop Plugin. This connector version is compatible with all CMS 10.6 builds. After installation, you can check for and install subsequent updates to the connector.

To install the Ingeniux CMS Connector add-on:
  1. Open Oxygen XML Editor.
  2. Click Help > Install new add-ons... from the menu bar.

    Help > Install new add-ons...

    The Install new add-ons dialog displays.

    Install new add-ons Dialog

  3. Copy and paste the following URL in the Show add-ons from field:
    Oxygen Desktop Plugin Feed URL
    https://oxygenplugin.ingeniux.com/plugins/pluginfeed.xml
    The Ingeniux CMS Connector add-on displays in the list.

    Select IngeniuxCMSConnector Add-on

  4. Select the Ingeniux CMS Connector add-on, and click Next.
  5. If a Security confirmation message displays, click Allow or Allow and remember to grant permission to connect with the host URL.
    Tip
    We recommend clicking Allow and remember to grant permissions once instead of for each subsequent version update.
  6. Review and accept the license agreements in the License and Signature tabs by selecting the I accept all terms of the end user license agreements checkbox.

    Ingeniux CMS Connector Add-on End User License Agreement

  7. Click Install.
    The add-on installs to your system, and the Add-ons dialog displays.
  8. Select OK, and restart the Oxygen XML Editor application to apply the add-on install changes.
  9. Open the Oxygen XML Editor.
    The interface now includes:
    • New toolbar buttons: Check Out, Check In, and Insert Topic Reference.

      Oxygen XML Editor to Ingeniux CMS Plugin Tools

    • The Ingeniux CMS pane.
    • the Ingeniux DITA References pane.

Task Troubleshooting: If you encounter errors or issues:

  • Review the installation steps to ensure you installed the connector properly and provided the correct plugin feed URL.
  • Verify with a system administrator that the Oxygen Web Service is updated to the latest version compatible with your CMS version.
  • If you still encounter errors, uninstall and reinstall the Ingeniux CMS Connector in Oxygen XML Editor.
  • The connector will not connect to your CMS instance until you install Web Launcher or configure connection settings manually.

Next Steps:

Note
For subsequent Ingeniux CMS Connector add-on updates, see Installing Add-on Updates for update steps.
Choose your next step based on your machine and configuration requirements: