Show Page Sections

Integrate Heretto CCMS and oXygen

You integrate Heretto CCMS with oXygen by establishing a connection through the WebDAV protocol and installing the appropriate oXygen plugin.

CAUTION: Install oXygen in a default location in your computer. Installing oXygen in a custom location may result in a failure to integrate Heretto CCMS with oXygen.
  1. Establish a connection between oXygen and Heretto CCMS. See Connect oXygen with Heretto CCMS.
  2. Ensure that the Open in oXygen button is enabled in your Content Library. If not, contact your Customer Success Manager.
  3. Download and organize the oXygen plugin installation files. See Prepare the oXygen Plugin for Installation.
  4. Do one of the following:
  5. Test the plugin installation. See Open a Heretto CCMS Resource in oXygen.

Connect oXygen with Heretto CCMS

oXygen uses the WebDAV protocol to connect with Heretto CCMS.

If you use a Single-Sign On (SSO) solution to log on to your Heretto CCMS instance, generate a token for use in the password field. See Generate and Invalidate a Token.
  1. In oXygen, click Window > Show View > Data Source Explorer.
    Figure 1. Data Source Explorer Pane
  2. In the Data Source Explorer pane, click .
    Figure 2. Preferences Window
  3. Under Connections, click +.
    The Connection pop-up screen opens.oxygen webdav connection window
  4. Complete the following fields:
    FieldField EntryExample
    NameA meaningful name to identify this connectionHeretto Production Server
    WebDAVYour Heretto CCMS repository URLhttps://companyName.heretto.com/webdav/db/organizations/companyName/repositories
    UserYour Heretto CCMS user name (email address)user@companyName.com
    PasswordYour Heretto CCMS password or, for SSO users, your generated tokenpassword
  5. Click OK to close the Connection window.
  6. Click OK again to close the Data Resource Explorer window.
You can now access your Heretto CCMS resources in oXygen. Use the Data Source Explorer pane to navigate the folders.

Generate and Invalidate a Token

You can generate a token and use it instead of your actual password for CURL requests or for establishing a WebDAV connection.

Log in to the Heretto CCMS instance for which you want to generate a token.
  1. In a web-browser, open https://your_organization.heretto.com/tools/token-management/tokens.xql
    Where: your_organization is the name of your Heretto CCMS organization.
    Note: If you want to generate a token for an organization that uses the old domain, for example, your-organization.easydita.com, use https://your_organization.easydita.com/tools/token-management/tokens.xql.
  2. Fill-in the Token name field.
  3. Click create token.
  4. Copy the login and password (token) information and keep it in a secure place.
Your token is now active. You can use it for CURL requests or to establish a WebDAV connection.
Optional: To invalidate a token, complete 1 and click invalidate. Once your token is invalidated, your CURL requests and WebDAV connection will fail.

Prepare the oXygen Plugin for Installation

Download the oXygen plugin from Github and move it to the oXygen folder on your computer.

  1. Download the appropriate release of the webdav-x.zip file from https://github.com/shabanovd/oxygenxml-webdav/releases/.
    Important: For macOS, the plugin versions are backward-compatible so you can download the most recent version of the plugin. For Windows, the plugin releases are specific to your version of oXygen.
  2. Unzip the webdav-x.zip file.
  3. Move the unzipped webdav folder to the oXygen\plugins folder.
    Important: Ensure that you moved the webdav folder directly to the oXygen\plugins folder without any intermediary folders like webdav-21.1.

  4. In the webdav folder, navigate to the bin folder.
Do one of the following:

Windows: Install the oXygen Plugin

You install the oXygen plugin by adding keys to the Windows registry.

CAUTION: Ensure that these applications are closed: Mozilla Firefox, Google Chrome™, and oXygen.
  1. Run the appropriate script file by doing the following:
    1. Navigate to the oxygen/plugins/webdav/bin folder.
    2. Right-click the REG file that has the version of your oXygen in its file name and select Open with.
    3. In the window that appears, select or find the Registry Editor program and click OK.
    Registry Editor screen
  2. In the warning window, click Run.
  3. In the caution window, click Yes.
  4. In the information window, click OK.

macOS: Install the oXygen Plugin

You install the oXygen plugin on a macOS computer by running a script.

CAUTION: Ensure that these applications are closed: Mozilla Firefox, Google Chrome™, and oXygen.
  1. Run the script by doing the following:
    1. Navigate to the oxygen/plugins/webdav/bin folder.
    2. Right-click setup_osx_webdav.sh and select Open With.
    3. Select or find the Terminal application and click Open.
    The Terminal application runs the script.
    Terminal application screenshot
  2. Refresh oXygen by doing the following:
    1. In the Applications folder, first drag the oXygen folder, then hold Command as you move, and then drop the oXygen folder in your Documents folder.
    2. In the Documents folder, first drag the oXygen folder, then hold Command as you move, and then drop the oXygen folder in your Applications folder.

Open a Heretto CCMS Resource in oXygen

Open resources in oXygen by clicking the Open in Oxygen button in the Content Library.

  1. Establish connection between Heretto CCMS and oXygen by expanding the Connections tree in the Data Source Explorer oXygen pane.
    Figure 3. Data Source Explorer Pane
    Data Source Explorer pane
  2. In the Content Library, right-click a resource and select Open in oXygen.
    open in oxygen option in context menu
    Remember: If the oXygen icon is not showing, contact your Customer Success Manager.
  3. 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 do 3.a every time you open a resource.
  4. Click OK.