Connect Heretto CCMS and Oxygen through WebDAV

Note:

This documentation uses the word Oxygen to refer collectively to the supported Oxygen products: Oxygen XML Author and Oxygen XML Editor.

You can use Oxygen XML Author or Oxygen XML Editor to edit files hosted in Heretto CCMS. To do that, you need to configure a Web Distributed Authoring and Versioning (WebDAV) connection between Heretto CCMS and Oxygen.

The WebDAV connection is required to use Oxygen products with Heretto CCMS.

Once the WebDAV connection is configured, you are ready to open resources hosted in Heretto CCMS through the Oxygen Data Source Explorer interface.

Note:

Editing files through Oxygen makes it impossible for multiple authors and contributors to collaborate in one file simultaneously, which is possible when you work directly in the Heretto CCMS Content Editor.

Generate a Token

You can generate a token to authenticate API requests instead of using your Heretto CCMS password. Use this token with any tool or application that makes API calls (such as cURL, WebDAV, Postman, or custom scripts).

Create separate tokens for different applications or scripts. This enables you to revoke a token without affecting other integrations.

When single sign-on (SSO) is configured in the CCMS, you have to generate a token. Otherwise, you can use your CCMS password. However, for security reasons, using a token is strongly recommended regardless of whether SSO is configured.
  1. Sign in to Heretto CCMS.
  2. In a web browser, navigate to https://organizationId/tools/token-management/tokens.xql

    Where {organizationId} is the subdomain you use to access Heretto CCMS. For example, if you access Heretto CCMS at https://thunderbird.heretto.com, use thunderbird as the organizationId.

    https://thunderbird.heretto.com/tools/token-management/tokens.xql
  3. In the Token name field, add a meaningful name for the token.

    The name will be visible in the tokens interface.

    Oxygen Webdav Token, or CI/CD Pipeline, or Publishing Script

  4. Click create token.
  5. Copy the login and password (token) information and keep it in a secure place.
    Important:

    Once you navigate away from the page with your login and token, you won't be able to see the token again.

Your token is now active. It will remain active until you manually invalidate it.

Configure a WebDAV Connection between Heretto CCMS and Oxygen

Connect Heretto CCMS and Oxygen XML Author or Oxygen XML Editor through the WebDAV protocol. A WebDAV connection is required to use Oxygen products with Heretto CCMS.

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

    CAUTION:

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

  • If you use a Single-Sign On (SSO) solution to sign in to Heretto CCMS, 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. The Show View menu with the Data Source Explorer Option Highlighted
    The Show View menu with the Data Source Explorer option highlighted
    Figure 2. Data Source Explorer Pane
    Data Source Explorer Pane
  2. In the Data Source Explorer pane, click Configure Database Sources Configure Database Sources.
    Figure 3. Preferences Window
  3. Under Connections, click New new option represented by a blue cross.
    The Connection pop-up screen opens.oxygen webdav connection window
  4. Complete these fields:
    Field Field Entry Example
    Name A meaningful name to identify this connection Heretto Production Server
    WebDAV Your Heretto CCMS repository URL

    https://your_heretto_ccms_domain/webdav/db/organizations/companyName_from_your_heretto_ccms_domain/repositories

    Example: https://thunderbird.heretto.com/webdav/db/organizations/thunderbird/repositories
    User Your Heretto CCMS user name (email address) user@companyName.com
    Password Your Heretto CCMS password or, for SSO users, your generated token password
  5. Click OK to close the Connection window.
  6. Click OK again to close the Data Resource Explorer window.

You can now access resources hosted in Heretto CCMS through the Oxygen Data Source Explorer interface.

Invalidate a Token

You can invalidate a token you previously generated for API authentication. Once your token is invalidated, any API requests using that token will fail, regardless of the tool or application making the request (such as cURL, WebDAV, Postman, or custom scripts).

  1. Sign in to Heretto CCMS.
  2. In a web browser, navigate to https://organizationId/tools/token-management/tokens.xql

    Where {organizationId} is the subdomain you use to access Heretto CCMS. For example, if you access Heretto CCMS at https://thunderbird.heretto.com, use thunderbird as the organizationId.

    https://thunderbird.heretto.com/tools/token-management/tokens.xql
  3. Click Invalidate next to the token you no longer need active.
Your token is now inactive. Your API requests that use the invalidated token will fail.