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.

Note:

Heretto CCMS does not provide general WebDAV support. WebDAV is supported only for connecting Heretto CCMS with Oxygen XML Editor and Oxygen XML Author.

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, Postman, or custom scripts. You can also use this token to authenticate a WebDAV connection with Oxygen XML Editor or Oxygen XML Author.

If single sign-on (SSO) is configured in the CCMS, you must generate a token to authenticate API requests. If SSO is not configured, you can use your CCMS password instead. However, for security reasons, using a token is strongly recommended regardless of whether SSO is configured.

Note:

Heretto CCMS does not provide general WebDAV support. The only WebDAV support offered is for connecting to Oxygen XML Editor and Oxygen XML Author. For details, see Authoring in Oxygen.

Sign in to Heretto CCMS.
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
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
Click create token.
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.

In Oxygen, click Window > Show View > Data Source Explorer.

Figure 1. The Show View menu with the Data Source Explorer Option Highlighted

Figure 2. Data Source Explorer Pane
In the Data Source Explorer pane, click Configure Database Sources .

Figure 3. Preferences Window
Under Connections, click New .
The Connection pop-up screen opens.

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`

Click OK to close the Connection window.
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, Postman, or custom scripts. This also invalidates a WebDAV connection with Oxygen XML Editor or Oxygen XML Author authenticated with that token.

Note:

Heretto CCMS does not provide general WebDAV support. The only WebDAV support offered is for connecting to Oxygen XML Editor and Oxygen XML Author. For details, see Authoring in Oxygen.

Sign in to Heretto CCMS.
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
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.

Under maintenance

Heretto Help

Connect Heretto CCMS and Oxygen through WebDAV

Generate a Token

Configure a WebDAV Connection between Heretto CCMS and Oxygen

Invalidate a Token

Footer Section

Our Support Team is here to help