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 Windows: Installing CMS 10.6 Oxygen Web Launcher

Windows: Installing CMS 10.6 Oxygen Desktop Plugin Web Launcher

Prerequisites:
  • Users must have a Windows 10 or Windows 11 machine.
  • The Oxygen Desktop Plugin must be installed in the Oxygen XML Editor desktop application via the Ingeniux CMS Connector add-on. See Installing CMS 10.6 Connector Add-on for details.
  • Users with DITA configuration permissions must enable the web launcher feature for content contributors.Navigate to Administration > DITA > Setup in the CMS, and select the Allow invoking Oxygen Desktop XML Author for DITA editing checkbox in the DITA Advanced Options area.
    Note
    When this setting is selected, the CMS generates an OAuth Identity named _oxygen_exclusive_admin. The web launcher uses this OAuth identity to connect users to the Oxygen Desktop Plugin when they execute web launcher.

    See OAuth Identities for details about using OAuth identities in the CMS.

  • Ensure that Oxygen XML Editor is not currently running. Close the application.

Set up the web launcher tool for Windows to streamline the process of accessing and editing DITA in the Oxygen Desktop Plugin. After setup, the Edit in Oxygen button becomes available in the CMS. Users can select this button to directly open DITA content in the Oxygen Desktop Plugin from the CMS.

To install CMS 10.6 Oxygen Desktop Plugin Web Launcher for Windows:
  1. Complete the following steps to download OxygenWebLauncherInstall.exe.
    1. Navigate to Assets > Assets Tree.
    2. Select any DITA item in the tree to display the item's Overview tab.
    3. Select the gear icon on the Edit in Oxygen button, and select the Download Installer icon that displays.

      Download Web Launcher Installer

    OxygenWebLauncherInstall_Windows.zip downloads to your machine.
  2. Extract the contents from the .zip, and store them in your file system.
    Warning
    Do not delete OxygenWebLauncherInstall.exe. Without this file, the system will not maintain your Web Launcher registration settings. If you delete the file, then repeat the Web Launcher installation steps again.
  3. Run the OxygenWebLaunch.exe in File Explorer.
    The Oxygen Web Launcher Registration application displays in administrator mode.
  4. Complete the following fields.
    FieldDescription
    Select Oxygen InstallationSelect the Oxygen XML Editor installation from the drop-down list. This setting determines where the web launcher will execute.
    Select Running ModeSelect one of the following running modes from the drop-down list. This setting determines the mode that the web launcher will use.
    • Author. When web launcher executes, the system opens the DITA content in the Oxygen XML Author desktop application.
    • Developer. When web launcher executes, the system opens the DITA content in the Oxygen XML Developer desktop application.
    • Editor. When web launcher executes, the system opens the DITA content in the Oxygen XML Editor desktop application.

    CMS 10.6 Oxygen Web Launcher Registration

  5. Select Register Oxygen Web Launcher.
    A message displays to confirm completion of the web launcher registration.
  6. Select OK.
    The Oxygen Web Launcher Registration application and confirmation message close.
  7. Restart the Oxygen XML Editor twice to ensure the system copied the Web Launcher application to the correct location.

Next Steps: Run the Oxygen Desktop Web Launcher to automatically connect the CMS to the plugin and open DITA content directly in Oxygen XML Editor.