Configuring CMS 10.6 Connection Settings for the Oxygen Desktop Plugin


If the Oxygen Desktop Plugin Web Launcher is installed, then skip this task. Do not configure Ingeniux CMS connection settings. When content contributors execute web launcher, the system automatically connects CMS 10.6 to the Oxygen Desktop Plugin.

See Oxygen Desktop Plugin Authoring and Editing for details about using plugin features.

The Oxygen Desktop Plugin requires each CMS 10.6 content contributor who will use the plugin without Web Launcher to configure their own CMS connection settings.

To configure CMS 10.6 connection settings for the Oxygen Desktop Plugin:
  1. Open the Oxygen XML Editor application.
  2. Select the Settings (gear) icon, or select Setup Connection to Ingeniux CMS in the Ingeniux CMS Browser tab.
    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.

    Enter the URL of the Ingeniux CMS instance containing the DITA assets (e.g.,

    Do not include a trailing slash in the CMS URL.
    CMS 10.6 or later checkbox

    Select this checkbox to configure CMS 10.6 connection settings.

    When you select this checkbox, the Client ID and Client Secret fields display.

    Client ID

    Per the prerequisite, enter the appropriate OAuth client ID.

    If you don't know your client ID, contact your CMS administrator.
    Client Secret

    Per the prerequisite, enter the client secret associated with your OAuth client ID.

    If you don't know your client secret, contact your CMS administrator.
    API Key
    Version Notes: CMS 10.3–10.5

    This field only applies to CMS 10.3–10.5. Be sure to select the CMS 10.6 or later checkbox.

    Operating User

    Enter the CMS user ID that you will use to access the CMS in the Oxygen Desktop Plugin.

    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

    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.

    Self-signed certificates only work for Transport Layer Security (TLS) 1.2+.
    Close Editor After Check In / Undo Check Out 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.
    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

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