Gretyl's Portal

Heretto Help

Show Page Sections

Enable the Open in Oxygen Option in Heretto CCMS

Once you connect Heretto CCMS and Oxygen through the WebDAV protocol, you can optionally enable the Open in Oxygen option in Heretto CCMS. The option enables you to open resources in Oxygen with a click of a button directly from Heretto CCMS.

Enabling the option is not required to use Oxygen XML Author or Oxygen XML Editor with Heretto CCMS.

macOS: Configure the Open in Oxygen Option

The configuration differs depending on whether you previously configured the Open in Oxygen option with one of currently deprecated configuration scripts.

Important:

As of version 21, the Open in Oxygen option is enabled by default during the installation of Oxygen XML Author or Editor on macOS®. Heretto no longer supports alternative configurations for macOS®. Upgrade your Oxygen product to version 21 or higher to use this feature.

Perform one of the following:
OptionDescription

If you are configuring the Open in Oxygen option for the first time,

  1. Contact your Customer Success Manager and request that the Heretto team makes the Open in Oxygen option configurable in the CCMS.

  2. Unless already installed, install Oxygen XML Editor or Oxygen XML Author.

    Ensure your Oxygen product is installed in the default location on your computer.

    CAUTION:

    Installing Oxygen in a custom location may result in a failure to connect Heretto CCMS and Oxygen.

  3. Configure a WebDAV connection between Heretto CCMS and Oxygen. See Connect Heretto CCMS and Oxygen through WebDAV.

  4. Verify that the Open in Oxygen option works. See Open a Heretto CCMS Resource in Oxygen.

If you have previously configured the Open in Oxygen option with any of the deprecated configuration scripts (see https://github.com/Jorsek/oxygenxml-webdav/releases),

  1. Re-install your version of Oxygen XML Author or Oxygen XML Editor.

    Ensure your Oxygen product is installed in the default location on your computer.

    CAUTION:

    Installing Oxygen in a custom location may result in a failure to connect Heretto CCMS and Oxygen.

  2. Verify that the Open in Oxygen option works. See Open a Heretto CCMS Resource in Oxygen.

Windows: Configure the Open in Oxygen Option

For Windows® users, Heretto provides a one-time file association script that enables the configuration of the Open in Oxygen option.

Complete these prerequisites only if you are configuring the Open in Oxygen option for the first time.

  • Contact your Customer Success Manager and request that the Heretto team makes the Open in Oxygen option configurable in the CCMS.

  • Unless already installed, install Oxygen XML Editor or Oxygen XML Author.

    Ensure your Oxygen product is installed in the default location on your computer.

    CAUTION:

    Installing Oxygen in a custom location may result in a failure to connect Heretto CCMS and Oxygen.

  • Configure a WebDAV connection between Heretto CCMS and Oxygen. See Connect Heretto CCMS and Oxygen through WebDAV.

  1. Perform one of the following:

Remove previous configurations of the Open in Oxygen option

  1. On your computer, go to your Oxygen plugin folder.

    For Oxygen XML Editor, it's C:\Program Files\Oxygen XML Editor version number\plugins, where version number is the software version number.

  2. Delete the webdav folder.

    Deleting the folder removes previous configurations of the Open in Oxygen option. You are now ready to re-configure the option.

  3. Scroll down to Download and set up the configuration script for all Oxygen Author and Editor versions.
Download and set up the configuration script for all Oxygen Author and Editor versions
  1. Download the open-in-oxygen-config-script-all-versions.zip file from https://github.com/Jorsek/oxygenxml-webdav/releases.
  2. Unzip the open-in-oxygen-config-script-all-versions.zip file.
  3. Move the unzipped webdav folder to the Oxygen\plugins folder.

    For Oxygen XML Editor, it's C:\Program Files\Oxygen XML Editor version number\plugins, where version number is the software version number.

    Important: Ensure that you moved the webdav folder directly to the oXygen\plugins folder without any intermediary folders.
    Layer 1
  4. On your computer, open the Command Prompt as an administrator.
    Layer 1
  5. In the confirmation window, click Yes.
  6. In the Command Prompt window, change the directory to the webdav\bin folder by typing cd and pasting the path to the bin folder. Press Enter.

    cd C:\Program Files\Oxygen XML Editor 19\plugins\webdav\bin

    command prompt in the bin directory
  7. Run the configuration script by entering: register_edit_in_oxygen.bat Oxygen_product_name Oxygen _product_point_version

    Make sure to:

    • Include spaces as provided in the example

    • For Oxygen_product_name, use either editor or author only

    • For Oxygen_product_point_version, provide the version in this format number.digit. For example, 26.1. For major versions like 27, use zero (0). For example, 27.0 .

    A command for Oxygen XML Editor version 19: register_edit_in_oxygen.bat editor 19.0

    Command to run the script in the Command Prompt window

You configured the Open in Oxygen option in Heretto CCMS. Verify that the option works by opening a Heretto CCMS resource in Oxygen.

Confirmation in the command prompt that the script was run successfully
Open a Heretto CCMS Resource in Oxygen

Open a Heretto CCMS Resource in Oxygen

Open resources in Oxygen with the Open in Oxygen option in Heretto CCMS to verify that the option has been configured successfully.

  1. In Heretto CCMS, right-click a resource and select Open in Oxygen.
    open in oxygen option in context menu
    Remember:

    If the Open in Oxygen option is not available, contact support at support.heretto.com.

    If you are a macOS® user and the option is not available or doesn't work, contact Oxygen support.

    If you are a macOS® user and the option is not available or doesn't work, contact Heretto support at support@heretto.com.

  2. If you open a Heretto CCMS resource in Oxygen for the first time, do the following:
    1. In the application selection dialog specific to your operating system, select the Oxygen version you want to use.
    2. If applicable, check the Remember my choice for webdavs links check box.
      You select the Remember my choice for webdavs links check box so you don't have to perform 2.a every time you open a resource.
  3. Click OK.

You confirmed that the option is configured correctly and are ready to use it.