Creating a Site Configuration and Installing Feedback

To create a new site configuration, click the Add site button at the top-right corner of the Sites page, or the Add site link in the Dashboard page (or if this is your first site configuration, click the Add your first site button in the Get Started pane). Next, a three-step wizard is initiated for creating the site configuration and installing it on your website or in your WebHelp documentation. The three pages used for the site creation wizard are the Settings, Version, and Installation page. When you create a site configuration, you are automatically assigned a user role of Owner for that site configuration.

Edit online

Settings Page

Site Configuration

The first page of the site creation wizard is the Settings page.

This wizard page includes the following options and features:

Add a logo

Click anywhere in the circle that contains the camera icon (

) to select an image to use for the logo for this site configuration. The logo will be displayed in the tile for this site configuration in the Sites page (it is also displayed in the header of the commenting component in the output). The supported extensions are: .jpg, .jpeg, .png, .gif. The maximum allowed size is 2048 KB.

Note:

When loading large logo images, they might be resized and lose some image quality. This is done to reduce network data traffic.

Name [Required]

The name of the site configuration. This will be displayed as the title in the tile for this site configuration in the Sites page (it is also displayed in the header of the commenting component in the output).

Note:

The site configuration name is unique per organization. Each organization cannot have more than one site configuration with the same name.

Description [Required]

The description of the site configuration. This will be displayed as the description in the tile for this site configuration in the Sites page.

Comments moderation

All - Select this option if you want all comments to require approval by an Owner, Admin, or Moderator before they are posted for all users to see. Also, each Owner, Admin, and Moderator for the site configuration will receive an email when a user adds a comment notifying them that there is a comment waiting for approval.
None - Select this option if you want all comments to be automatically approved and posted for all users to see.

Tip:

For more information, see Site Comments Moderation.

Allow block level comments

Controls whether or not block-level comments are enabled in the output.

Outline current block on hover: Available if the Allow block level comments option is enabled. If this option is selected, an outline is rendered on any block elements that allow block-level comments when hovering over the element (if the element does not already have a comment associated with it).

Allow page ratings

Controls whether or not a page ratings component is displayed in the output. You can also configure the question and the two possible options that will be displayed in the output:

Question - The page ratings question that is displayed in the output. The default value is Was this page helpful?
Option 1 (positive) - The positive response to the question. The default value is Yes.
Option 2 (negative) - The negative response to the question. The default value is No.

Edit online

Version Page

WebHelp Output Site Configuration

The second page of the site creation wizard is the Version page where you must specify a version and the base URL from your website where the WebHelp output is deployed.

This wizard page includes the following options:

Name

This is where you specify the version name or identifier. This is helpful if there will be multiple versions for your output. For example, if your published output is documentation for a product that has multiple released versions, each version probably has its own published documentation. In this case, each published version requires a different configuration since the version and base URL would be different for each of them. The version can be used later to decide whether or not comments from older versions are shown in new published versions. This is managed in the Site Versions page. In most cases (especially if you do not plan to have multiple versions), you can leave the name of the version as 1.0.

Base URL

This is where you specify the base URL for the website where you publish your output. For WebHelp output, for example, it is the URL where your WebHelp output is deployed. Only http and https protocols are allowed and it must NOT point to a file (e.g. http://example.com/index.html is not allowed).

Warning:

The comments component will only appear on pages within the hierarchy of this base URL. For example, https://example.com/a IS a base URL for https://example.com/a/b, while it IS NOT a base URL for https://example.com/abc.

Display in-place error message for comments component

Select this option if you want an error message to be displayed directly in the location where the comments component should appear if any issues arise during the integration process. A hyperlink is also displayed that directs you to a user guide topic to help you troubleshoot the issue.

Include query parameters when identifying pages

Note:

This feature is intended for sites where the same HTML file serves different logical content depending on URL query parameters. It is not needed for standard WebHelp output where each topic has its own URL path.

Select this option if you want URL query parameters to be considered when computing the unique identity of a page for comments. This is particularly useful for portals or single-page applications where different content is served at the same URL path but distinguished by query parameters (such as ?docid= or ?page=).

When this option is enabled, you can optionally enter a comma-separated list of Query parameter names to include. If the field is left empty, all query parameters are included. If parameter names are configured, only those parameters contribute to page identity, keeping unrelated parameters (such as search highlighters) from affecting comment grouping.

Important:

Enabling this setting or changing the parameter names may cause existing comments to become disassociated from their pages if the new page identity path no longer matches the path stored with the comment. Review your comment history before enabling on an active site.

Parameter matching rules:

Parameter names are matched exactly and are case-sensitive.
When multiple parameters are present, they are sorted alphabetically before being stored, so ?b=2&a=1 and ?a=1&b=2 produce the same page identity.
Parameters not included in the allow-list are never stored, even if they appear in the URL.

Example:

The option is enabled and docid is specified in the Query parameter names field.


URL visited	Page identity stored
/page.html?docid=topic1&hl=search	page.html?docid=topic1
/page.html?docid=topic2&hl=search	page.html?docid=topic2
/page.html?hl=search	page.html (no matching param)

Enable content indexing

Use this option to enable/disable content indexing and to configure search functions. When content indexing is enabled for a site's version, the corresponding WebHelp Responsive output will use Oxygen Feedback as the search engine when users search the published content. If content indexing is disabled, the search will be performed using the JS Search Engine bundled in the WebHelp Responsive output. Once the content indexing is enabled, you can choose the language that the search engine will use for the indexing and which AI features are enabled.

Tip:

For more details about the content indexing functionality, watch our webinar: How to Enable Content Indexing and Search in Oxygen Feedback 3.0.

AI Features

Notice:

To use the AI features, you must have an AI-ready subscription. See https://www.oxygenxml.com/oxygen_feedback/buy_feedback.html for information about the available subscription plans.

The AI Features section contains options for configuring AI-enhanced search functionality. These AI-related options are available if you have configured Oxygen Feedback Enterprise to connect to OpenAI™ on your behalf in the Organization Profile page.

Enable semantic search - Activates functionality to enable semantic searches, an advanced search technique that aims to improve the accuracy and relevance of search results by understanding the context and meaning behind the search query, rather than relying solely on keyword matching.
Enable AI Assistant - If selected, WebHelp sites that have Oxygen Feedback Enterprise installed will have an AI Assistant button displayed in the lower-right corner of each page that will allow users to interact with the AI Assistant to help find answers to questions and find information quickly and accurately.
Enable Assistant debug mode - Selecting this option enables the debug mode for the AI Assistant. When enabled, a Debug button appears at the bottom of the chat window for users with a role of Admin or Owner. Clicking the button displays the complete set of interactions between Oxygen Feedback Enterprise and the AI.
Enable AI-enhanced search summary - If selected, when a user enters a search query in the WebHelp search results page, an AI-generated response to the search query is displayed before the usual search results. The response is generated using the AI Assistant based upon information found in the current publication.

Notice:

The AI Assistant and AI-enhanced Search Summary features can generate costs. It is recommended to use support from OpenAI to configure a budget limit on the API key configured for the organization.

Edit online

Installation Page

WebHelp Output Site Configuration

The third page of the site creation wizard is the Installation page. This page is where you choose how to install the configured Feedback system. You can choose between three options:

Install Oxygen Feedback in WebHelp output generated from Oxygen XML Editor/Author: Choose this option if you are adding the Feedback system to WebHelp Responsive documentation AND you will generate the documentation using a transformation scenario in Oxygen XML Editor/Author.
Install Oxygen Feedback in WebHelp output generated from a command line: Choose this option if you are adding the Feedback system to WebHelp Responsive documentation AND you will generate the documentation using a command-line script.
Install Oxygen Feedback in WebHelp output generated with Oxygen Content Fusion: Choose this option if you are adding the Feedback system to WebHelp Responsive documentation AND you will generate the documentation with Oxygen Content Fusion.
Tip:
A pre-built AI Positron prompt is available when you expand the instructions. You can copy it and paste it into the AI Positron assistant in Content Fusion to complete the setup automatically.
Install Oxygen Feedback on any HTML-based website: Choose this option if you are adding the Feedback system to a website. When you select this option, an HTML fragment will be displayed. You need to copy this fragment and paste it into your HTML code for each webpage that you want to have the Feedback system embedded.