Feedback function

[MWdal]

Hello,
We are using OxygenXML in an environment without internet access. I'm looking into how we can get the feedback function working. I saw this on page https://www.oxygenxml.com/xml_webhelp/w ... nsive.html :
"You simply need to create an Oxygen Feedback site configuration in the administration interface, copy the HTML installation fragment that is generated at the end of the creation process, and paste the generated fragment in the Feedback tab in the WebHelp transformation scenario dialog box."
I suppose that instruction is valid for installations with internet access, is that correct?

Are Oxygen Feedback Commenting Component and Oxygen Feedback Service the same, or 2 different things?

Cheers, Mikael

[alin]

Hello Mikael,

Thank you for reaching out with your questions about integrating Oxygen Feedback in an offline environment.

The instructions you referenced are indeed primarily for environments with internet access. However, you can still use the Oxygen Feedback Enterprise edition in offline settings, as it’s designed to be deployed on-premises without requiring internet access. This edition allows you to set up Oxygen Feedback entirely within your secure, disconnected environment by hosting the Oxygen Feedback Service on your local infrastructure.

To clarify:
Oxygen Feedback Service: This is the backend service that manages all data storage and processing for feedback and comments, running on a server you control (such as your internal network in the case of the Enterprise edition).
Oxygen Feedback Commenting Component: This is an integral part of the Oxygen Feedback Service. It serves as the user interface embedded in your WebHelp output, displaying the comments and enabling users to add new comments directly within the documentation.

For your use case, with the Enterprise edition, you would:

1. Set up the Oxygen Feedback Service on your internal network.
2. Generate a site configuration in the Oxygen Feedback administration interface hosted on your local server.
3. Copy the HTML installation fragment from this configuration and paste it into the Feedback tab of your WebHelp transformation scenario. This will embed the Commenting Component in your published output without needing external connectivity.

If you need guidance on the installation steps or any other configuration, please let us know.

Best regards,
Alin

[MWdal]

Thanks for info Alin, very helpful.
So we would need to purchase the Oxygen Feedback Service Enterprise edition, to install it in our environment. I understand from the Pricing page that the number of members is unlimited, is that correct?
And an installation hosted on a local server here would be equal to a Site configuration?

Some of the users have their webhelp installed in a stand-alone system, so they would not have access to our local Feedback server. Is there a way to extract comments from such standalone systems?

regards, Mikael

[alin]

Dear Mikael,

See my answers below:

So we would need to purchase the Oxygen Feedback Service Enterprise edition, to install it in our environment. I understand from the Pricing page that the number of members is unlimited, is that correct?

You're correct that the Enterprise edition of Oxygen Feedback is designed for on-premise installations, making it suitable for environments without internet access. Regarding user limits, the subscription plans impose restrictions only on the number of users with administrative rights (organization/site admins and moderators). The number of regular members (commenters) is not restricted. Additionally, the subscription plans impose restrictions on the total number of site configurations platform-wide.

And an installation hosted on a local server here would be equal to a Site configuration?

In Oxygen Feedback, a 'Site Configuration' refers to the setup that links your documentation to the feedback system. This configuration is not synonymous with the physical installation of the Feedback service on your server. Instead, after installing the Feedback service on your local server, you can create multiple site configurations within the administration interface. Each site configuration corresponds to a specific set of documentation, allowing you to manage feedback for different publications effectively.

Some of the users have their webhelp installed in a stand-alone system, so they would not have access to our local Feedback server. Is there a way to extract comments from such standalone systems?

For users who have their WebHelp installed on stand-alone systems without access to your local Feedback server, integrating Oxygen Feedback poses significant challenges. Currently, there is no built-in functionality to connect Feedback to a website deployed on a standalone offline system, nor is there an option for exporting comments. Therefore, integrating Oxygen Feedback in such isolated environments is not feasible at this time.

I hope this information assists you in understanding how Oxygen Feedback can be integrated into your environment. If you have further questions or need additional assistance, please don't hesitate to reach out.

Best regards,

Alin