Installing Ingeniux CMS Connector in Oxygen XML Editor


  • System administrators must the install the Oxygen Web Service for Ingeniux CMS site instance. See Installing Oxygen Web Service for details.
  • CMS content contributors must install Oxygen XML Editor 23.1 on their authoring client(s). See the Oxygen XML Editor website for details.
  • If CMS content contributors installed the for Oxygen Desktop Plugin, then they must delete the IngeniuxCMSConnector folder (e.g., [Drive]:\Program Files\Oxygen XML Editor 23\plugins\IngeniuxCMSConnector\).

The Oxygen Desktop Plugin requires each CMS content contributor who will use the plugin to install the Ingeniux CMS Connector add-on in their Oxygen XML Editor 23.1 application. After installation, users can check for and install subsequent updates to the Ingeniux CMS Connector plugin.

To install the Ingeniux CMS Connector add-on for the Oxygen Desktop Plugin:

  1. Open the Oxygen XML Web Editor application.

    Note: Before opening Oxygen XML Editor, ensure that the CMS instance containing your DITA assets is running.

    Help > Install new add-ons...

  2. Navigate to Help > Install new add-ons... in the Oxygen XML Editor toolbar. 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:

    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. The Security dialog displays.

  5. Click Allow or Allow and remember to grant the system permission to connect with the host URL.

    Tip: We recommend clicking Allow and remember. This way, you only have to grant permissions once and not for each subsequent version update.

  6. 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. Click OK, and restart the Oxygen XML Editor application to apply the add-on install changes.
  9. Open the Oxygen XML Editor. The UI now displays new options (i.e., the Check OutCheck In, and Insert Topic Reference buttons) in the application's toolbar and the Ingeniux CMS Browser tab.

    Oxygen XML Editor to Ingeniux CMS Plugin Tools

    Ingeniux CMS Browser Tab in Oxygen XML Editor

  10. Click the Settings (gear) icon or click Setup Connection to Ingeniux CMS in the Ingeniux CMS Browser tab. The Configure Ingeniux CMS Connection dialog displays.

    Configure Ingeniux CMS Connection Dialog

  11. Enter values in the following fields:
    Field Description
    CMS URL Enter the URL of the Ingeniux CMS instance containing the DITA assets (e.g.,

    Important: Don't include a trailing slash in the CMS URL.

    API Key Enter the key value (API key) you provided in Web.config.
    Operating User Enter your CMS User ID that is used to access the CMS authoring UI (e.g.,
    Connection timeout (seconds) Enter the maximum duration the system will wait (in seconds) to connect before timing out. If no response initiates after this specified timeout period, the connection process terminates.
    Allow Self-Signed Certificate for HTTPS Connection to CMS checkbox

    Select or clear the checkbox. If selected, Oxygen Desktop Plugin allows users to connect to the CMS via an HTTPS self-signed certificate. If cleared (default), the Oxygen Desktop Plugin doesn't allow HTTPS self-signed certificates.

    This setting is based on the CMS instance setup. Contact your CMS system administrator for details.

    Important: Self-signed certificates only work for TLS 1.2+.

    Close Editor After Check In / Undo Check Out checkbox Select or clear the checkbox. If selected (default), Oxygen Desktop Plugin closes DITA assets after users execute the Check In or Undo Check Out action. If cleared, the DITA assets remain open in the editor after executing these actions.

    Important: After saving any value change in the Configure Ingeniux CMS Connection dialog, exit from Oxygen XML Editor to ensure your changes take effect upon reopening the application.

  12. Click Save Settings. The Configure Ingeniux CMS Connection dialog closes, and the structure of your CMS DITA assets displays in the Ingeniux CMS Browser tab. The plugin is now ready for you to connect Oxygen XML Editor to DITA assets in Ingeniux CMS.

    CMS DITA Assets Tree Structure in Ingeniux CMS Browser Tab of Oxygen XML Editor

Next Steps: