oXygen Integration

The easyDITA oXygen Plugin enables you to navigate, view, and edit resources in both systems.

Supported oXygen Products

You can integrate easyDITA with the following oXygen products:

  • oXygen XML Author
  • oXygen XML Editor

For specific information about the supported oXygen versions, see https://github.com/Jorsek/oxygenxml-webdav.

Operation

The easyDITA oXygen Plugin plugin keeps your resources in sync while you work in each system. When you have a resource that is open in one system, a lock icon appears in the other system to prevent others from editing it. Once you close the resource, the lock is removed and other users can access the resource again.

The easyDITA oXygen Plugin uses the WebDAV protocol to communicate easyDITA with oXygen.

Integrate easyDITA and oXygen

You integrate easyDITA with oXygen by establishing a connection through the WebDAV protocol and installing the appropriate easyDITA oXygen Plugin.

CAUTION: Install oXygen in a default location. Installing oXygen in a custom location may result in a failure to integrate easyDITA with oXygen.
  1. Establish connection between oXygen and easyDITA. See Connect oXygen with easyDITA.
  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 easyDITA oXygen Plugin installation files. See Prepare the easyDITA oXygen Plugin for Installation.
  4. Do one of the following:
  5. Test the plugin installation. See Open an easyDITA Resource in oXygen.

Connect oXygen with easyDITA

oXygen uses the WebDAV protocol to connect with easyDITA.

If you use a Single-Sign On (SSO) solution to log on to your easyDITA instance, generate a token for use in the password field. See Generate 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 +.
    Figure 3. Connection Window
  4. Complete the following fields:
    FieldField EntryExample
    NameYour company nameJorsek
    WebDAVYour easyDITA repository URLhttps://[companyName].easydita.com/webdav/db/organizations/[companyName]/repositories
    UserYour easyDITA user nameuser@[companyName].easydita.com
    PasswordYour easyDITA password or tokenpass1234
  5. Click OK.
You can now access your easyDITA resources in oXygen. Use the Data Source Explorer pane to navigate the folders.

Generate a Token

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

  1. In a web-browser, open https://your_organization.easydita.com/tools/token-management/tokens.xql
    Where: your_organization is the name of your easyDITA organization.
  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.

Prepare the easyDITA oXygen Plugin for Installation

Download the easyDITA oXygen Plugin 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 backwards 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 easyDITA oXygen Plugin

You install the easyDITA oXygen Plugin by adding keys to the Windows registry.

CAUTION: Close 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.
  2. In the warning window, click Run.
  3. In the caution window, click Yes.
  4. In the information window, click OK.

macOS: Install the easyDITA oXygen Plugin

You install the easyDITA oXygen Plugin by running a script.

CAUTION: Close Mozilla Firefox, Google Chrome™, and oXygen.
  1. Run the script file 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.
  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 an easyDITA Resource in oXygen

Open resources in oXygen by clicking the Open in Oxygen button in the content library.

  1. Establish connection between easyDITA and oXygen by expanding the Connections tree in the Data Source Explorer oXygen pane.
    Figure 4. Data Source Explorer Pane
  2. In easyDITA, navigate to a resource in the content library and click the oXygen icon.
    Remember: If the oXygen icon is not showing, contact your Customer Success Manager.
  3. If you open an easyDITA 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 /user-guide/integrate/oxygen-integration#task-3528__substep_lb3_vmf_5jb every time you open a resource.
  4. Click OK.

Change the oXygen Version Integrated with easyDITA

If you have multiple versions of oXygen installed on your workstation, you can change which oXygen version is integrated with easyDITA.
  1. Ensure that you installed more than one oXygen version on your workstation.
  2. Connect the appropriate oXygen version with easyDITA. See Connect oXygen with easyDITA.
For Mozilla Firefox, do the following:
  1. In Mozilla Firefox, In the right-top corner, click the More icon and select Options.
  2. In the Find in Options field, enter applications
  3. In the Applications list, in the webdavs row, click Use Oxygen XML Version and select Use other.
    Where: Version is the version of oXygen that is currently integrated with easyDITA.
    Figure 5. Applications List
  4. In the Select Helper Application dialog, click Browse, navigate to the oXygen version that you want to integrate with easyDITA, and click Open.
For Google Chrome™, do the following:
  1. Reinstall the connector plugin by doing one of the following:
  2. Select the oXygen version that you want to integrate with easyDITA. See Open an easyDITA Resource in oXygen.