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.3–10.5 Oxygen Desktop Plugin Installation Configuring CMS 10.3–10.5 Connection Settings

Configuring CMS 10.3–10.5 Connection Settings for the Oxygen Desktop Plugin

Prerequisites:
  • System administrators must install the Oxygen Web Service for the Ingeniux CMS site instance. See Installing Oxygen Web Service for details.
    Important
    System administrators must install the latest version of the Oxygen Web Service .dll file for CMS 10.6. See Updating 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.
    Note
    If Ingeniux CMS Connector is already installed, see Installing Add-on Updates for details to update Ingeniux CMS Connector to version 1.5.37+.
The Oxygen Desktop Plugin requires each CMS 10.3–10.5 content contributor who will use the plugin without weblauncher to configure their own CMS connection settings.
To configure 10.3–10.5 connection settings for the Oxygen Desktop Plugin:
  1. Open the Oxygen XML Web Editor application.
  2. Select the Settings (gear) icon, or select Setup Connection to Ingeniux CMS in the Ingeniux CMS Browser tab.
    Note
    See Opening Ingeniux CMS Browser for details to open the Oxygen Desktop Plugin Ingeniux CMS Browser tab.

    Ingeniux CMS Browser Tab in Oxygen XML Editor

    The Configure Ingeniux CMS Connection dialog displays.

    Configure Ingeniux CMS Connection Dialog

  3. Enter values in the following fields.
    FieldDescription
    CMS URLEnter the URL of the Ingeniux CMS instance containing the DITA assets (e.g., https://cms-site.com).
    Important
    Do not include a trailing slash in the CMS URL.
    CMS 10.6 or later checkbox

    Clear this checkbox to configure CMS 10.3–10.5 connection settings.

    When you select this checkbox, the API Key field displays.

    Client ID
    Version Notes: CMS 10.3–10.5

    This field only applies to CMS 10.6. Be sure to clear the CMS 10.6 or later checkbox.

    Client Secret
    Version Notes: CMS 10.3–10.5

    This field only applies to CMS 10.6. Be sure to clear the CMS 10.6 or later checkbox.

    API Key

    Enter the key value (API key) you provided in Web.config.

    Operating UserEnter your CMS User ID that is used to access the CMS authoring UI (e.g., first.last@company.com).
    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 Transport Layer Security (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.

  4. Select Save Settings.
    Important
    After saving any value change in the Configure Ingeniux CMS Connection dialog, exit from Oxygen XML Editor to ensure your changes take effect when reopening the application.
    The Configure Ingeniux CMS Connection dialog closes. The plugin is now ready for you to connect the Oxygen Desktop Plugin to DITA assets in Ingeniux CMS.

    After you reopen the Oxygen XML Editor application, the structure of your CMS DITA assets displays in the Ingeniux CMS Browser tab. The CMS URL displays directly above the search field.

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

Next Steps: Use the plugin tools to edit CMS DITA content within the Oxygen XML Editor application interface.