Pop-up survey in Madcap Flare Documentatoin s/w to give a thumbs-up/down in a page.
CustomerGauge has a native Pop-Up Surveys feature that is well-suited for in-app or documentation-site feedback. You can either use that (recommended), or embed your own launcher script in MadCap Flare so it appears on every page.
Option A — Use CustomerGauge Pop-Up Surveys (recommended)
CustomerGauge’s Survey Suite → Pop-Up Surveys lets you create a modal/overlay survey and control key behaviors—frequency, delay, embed code, and parameter passing (so you can send page title/URL, user/account IDs, etc.). You’ll find step-by-step instructions and the embed code in the help article. https://support.customergauge.com/support/solutions/articles/5000878643-survey-suite-pop-up-surveys
Typical setup:
In CustomerGauge, create a Pop-Up Survey and configure Frequency (how often to show) and Pop-up Delay (e.g., after 10–15 seconds).
Copy the Embed Code from the Distribution tab. If desired, enable parameters (e.g., page_url, page_title, account_id) to improve attribution and filtering in reports.
Paste that embed code into your MadCap Flare output so it loads on every topic page (see “How to add scripts to Master Pages” below).
There are also documented ways to trigger CustomerGauge using external pop-up frameworks (Pendo, Appcues, SatisMeter) against a Direct Link or generic link survey if you prefer your existing tooling.
Option B — Bring-your-own launcher (if you want a custom UI)
If you need a branded “Feedback” button or a custom trigger (exit-intent, scroll-depth), you can add a small JS snippet to open your Direct Link or Pop-Up survey. Put the script once on the Flare Master Page so it appears site-wide, and pass page/user parameters in the URL. https://docs.madcapsoftware.com/flare2025/Flare-Scripting-Guide.pdf
Where to add the code in MadCap Flare
Flare supports placing JavaScript in a Master Page (template page); anything you add there loads on all associated topics for your HTML5 target. You can link an external /Content/Resources/Scripts/*.js file or inline <script> in the master page’s <head>/<body> (Text Editor). Then assign that Master Page to your HTML5 target.
Practical notes for Flare:
If you get syntax errors saving certain <script> attributes (e.g., async) in the Master Page UI, add the tag in the Text Editor or omit async—this is a known quirk.
Confirm the Master Page is actually applied to the output/target so the script loads on every page.
Example of linking a shared script from a Master Page <head> is shown here (same technique for your survey embed).
Quick path for your docs site
Build a Pop-Up Survey in CustomerGauge → copy its Embed Code.
In Flare, open your Master Page in the Text Editor and paste the embed code (or reference your external JS) so it loads globally.
(Optional) Append parameters—page_title, page_url, account_id, etc.—to enrich analytics and targeting in CustomerGauge.
Notes
You may consider the choice of “native CG pop-up” vs. “custom button launcher” - depending on that the exact embed snippet (including parameter names) can be tailored so it drops into your Flare Master Page.
Survey Widget Choices:
In the CG pop-up, there are several types of survey questions. https://support.customergauge.com/support/solutions/articles/5000882385-survey-suite-create-or-edit-a-survey
NPS
CES, CSAT
Comment (“why do you say this?”)
Star rating
We don’t currently offer the “thumbs up/down” option in the popup. It is a form of “radio button” - which we do offer, so this can be adapted to make this use case operate.
Reporting:
An outline of the dashboard in CustomerGauge would be as follows:
Recent responses (score, sentiment, comment, date/time)
Demographics (customer number, account, name etc)
Page source (and any other information)
Insights: AI to provide context of themes (also word clouds), recommended action.
Optional: Tagging manually
Workflow: presumably internally to close the loop
Appendix A - Code suggestion:
<!-- In your Master Page (Flare) head or prior to UI -->
<script type="text/javascript" src="https://survey.eu.customergauge.com/pop-up/pop-up.iife.js"></script>
<!-- Later in the body, e.g. in a Feedback button or auto trigger logic -->
<script>
// Configuration (adapt values)
const surveyConfig = {
surveyId: "YOUR_SURVEY_ID", // from CustomerGauge Embed Code
language: "en_GB", // match your survey locale
params: {
"first_name": window.CG_FIRST_NAME || "",
"last_name": window.CG_LAST_NAME || "",
"reference": window.CG_ACCOUNT_ID || "",
"email": window.CG_EMAIL || "",
// Optionally a random value for sampling:
"rand_value": Math.random()
}
};
// Conditional trigger logic
function launchSurvey() {
CG.init(surveyConfig);
}
// Example: auto-show after delay
const POPUP_DELAY_SEC = 15;
setTimeout(launchSurvey, POPUP_DELAY_SEC * 1000);
// Example: button to manually trigger
// <button id="cg-launch-btn">Give Feedback</button>
document.getElementById("cg-launch-btn")?.addEventListener("click", () => {
launchSurvey();
});
// Listen to events (optional)
document.addEventListener("cg_survey_started", function(e){
console.log("Survey opened");
});
document.addEventListener("cg_survey_finished", function(e){
console.log("Survey completed");
});
document.addEventListener("cg_survey_closed", function(e){
console.log("Survey closed without completion");
});
</script>
Notes / mapping to CG support guidance:
The pop-up library file (pop-up.iife.js) must load before calling CG.init() (as stated in the “Embed Code / Loading the library” section)
You can pass a JSON params object with field names matching your org’s Field Settings (first_name, last_name, reference, email, segments) for contact matching and reporting.
The Frequency setting in the CG UI ensures the survey is shown only once per configured period (by checking localStorage) — but you don’t need extra logic for that; CG handles it.
Duplication Rule does not suppress repeated pop-up triggers — every time your code fires the pop-up, a non-response record is created (unless converted via Partial Complete logic).
You can also host the embed via Google Tag Manager by creating a custom tag that loads the library and calls CG.init() (or using a template) if desired.
If you already use a pop-up manager (like Pendo, SatisMeter, etc.), you can embed the CG pop-up logic under its control. The support article “How to work with external pop-up surveys and CustomerGauge” gives patterns for that.
Summary recommendation for your solution
In CustomerGauge, create a Pop-Up Survey (Campaigns → Survey Suite → Pop-Up Surveys). Configure its Frequency and Pop-Up Delay in the UI.
Copy the Embed Code from the Distribution tab. Use that code (or a variation of it) in your Flare Master Page.
Add any custom logic (delay, gating, conditional triggers) around CG.init() as needed in the Master Page or an included JS file.
Pass contextual parameters (page title, URL, account ID, user email) in the params object so CustomerGauge can attribute responses correctly.
Optionally wrap CG.init() in button or scroll/exit triggers to control engagement.
If using an external pop-up or tag manager, embed CG’s library/trigger logic via that tool instead.