Deployment Tab
About the Deployment Tab
When you’re finally ready to deploy your Website / App Insights project on your website, head over to the Deployment section of the Settings tab. Here, there are also several options you can adjust before deploying.
Project Deployment Code
The project code contains all the active intercepts and their creatives in the project.
Implementing the project code
The project code can be placed on any page where you may want to display creatives to your visitors. In addition, you will also want to place the code on any pages for which you’d like the Website / App Insights project to track or collect information.
Adding the Code Snippet to Your Site on Your Own
- Copy the code snippet.
- While you can place the code snippet anywhere within the page HTML, it is typically placed within the page header or footer.
Sending the Code Snippet to Your Website Developer
Instead of updating the website code yourself, you can also choose to have your website developer do it for you. In that case, simply copy the code snippet and email it to your website development team.
Your developer can put the code in the header or footer of each page’s HTML, or in the global header or footer, so it loads on all pages of the website.
Using a Third Party Tag Management Solution
Another option for implementing Website / App Insights projects on your site is to add it to a tag management system instead of applying it directly to the site code. Code can be copied and pasted from the Qualtrics interface right into a tag manager. Check out our Using Tag Managers page for more information!
Common tag management systems that our clients use in conjunction with Website / App Insights projects are Tealium, Adobe, Google Tag Manager, and Ensighten. Tealium has a wizard built that allows for easy implementation of Website / App Insights projects.
Testing Your Project Code
Just like you can test individual intercepts, you can also test your project code! See Testing Unpublished Changes for more information.
Project Options
Go to the Settings tab and select the Intercepts section to view the settings for your project.
FAQs
- I activated my intercept, but it‘s not showing up on my site. Why not?
-
There are numerous potential causes as to why an intercept may not be appearing once it has been implemented. These causes may stem from the setup of the intercept itself or the implementation of the code.
- Logic: intercept targeting logic and action set logic are the conditions that must be met in order for an intercept to be displayed to a visitor. Checking this logic will be helpful in discovering why the Intercept is not displaying on a page.
- Logic sets that use “Contains”: A common cause of logic error is the use of the “Contains” vs. “Is.” To say a condition “Contains” means that the parameter you are basing the logic off (i.e., Current URL) will have the specified value present in addition to more information. For example, if I had logic that read as Current URL contains ‘qualtrics’, this would cause the intercept to display on any URL that has the word qualtrics present. The other option you have is using Current URL is [URL]. This condition depends on the visited URL being an exact match. Any differences or additional characters will prevent the intercept logic from passing.
- Intercept Revisions: When making edits to intercepts, changes are not made live until the intercept is published. When publishing an Intercept, a version of the intercept, or a “revision,” is saved. Reviewing the revisions that have been made is very useful for identifying any changes that may have suddenly prevented the intercept from appearing.
- Debug Window: The debug window is an invaluable tool for testing why an intercept is not displaying on a particular page.
For intercepts whose deployment code was implemented before March 2019, to enable the debug window, append a query string to any given URL called Q_DEBUG. This must be prefixed with a ? or a & like the following examples: https://www.qualtrics.com?Q_DEBUG, https://www.qualtrics.com/blog?item=value&Q_DEBUG.
For intercepts whose deployment code was implemented after March 2019, run the following JavaScript snippet in the Console of your web page:
The debug window breaks down all conditions required for intercepts running on the URL to appear. If you find that an intercept is not appearing, locate it in the debug window and identify any red failed warnings.QSI.API.unload(); QSI.isDebug = true; QSI.API.load(); QSI.API.run();
Qtip: The Website Feedback debugger does not function if the code has been implemented using a tag manager. Also, if the URL already has a query string with a ?, then the debugger will require a & instead. - Network Request: Most browsers possess a developer tools menu that allows a user to see a site’s source code, resources, cookies, and network calls. Website Feedback possesses a distinct presence in the Network section of these tools. To check for these scripts running, open the developer tools and navigate to the Network section. Once here, reload the webpage and the menu should begin to populate with all network requests being made by the website. To identify Website Feedback code, look for calls that begin with ?Q_ZID or ?Q_SID. This is the code itself running checks on the display logic. If you cannot find anything matching this format, then there is an issue with the implementation of your project code. You can refer to our support page on implementation for advice on where is best to place the code.
- Content Security Policy Issues: If you receive a console log that violates a Content Security Policy, there is most likely a restriction on your website that is blocking our intercepts from deploying. We recommend reaching out to your web-development team to resolve. To ensure your intercepts work, we generally recommend allowlisting the following items in your Content Security Policy headers:
- connect-src https://*.qualtrics.com
- frame-src https://*.qualtrics.com
- img-src https://siteintercept.qualtrics.com
- script-src https://*.qualtrics.com
- What is the difference between zone code and intercept code? Now that it’s called “project code” in the new interface, what does this mean?
-
Intercept codes were specific to the intercept that it was generated for. This means if you want something to appear on a specific page, you can place the code on that URL. This was less commonly used, since it required you to add lots of code to your site in different places. Old intercept codes still work, and will always work, but you can’t generate new ones in the new UI.
Zones (now “Projects”) act as collections for multiple creatives and intercepts. Zone codes contain all the intercepts in the zone. This allows you to implement a single code on your site instead of continually adding codes for individual intercepts. This can save a lot of time, since every time you activate content on the zone, it’s automatically added to the code, requiring no change.
Projects are the equivalent of zones, so project deployment code is the equivalent of old zone codes. - I have built my intercept but would like to test it before activation. How can I do that?
-
There is a tool called a bookmarklet that allows you to test any intercept without having to activate it.
- What is Website / App Feedback? / Where’s Site Intercept?
-
Site Intercept has been renamed Website / App Feedback, since the primary function of these projects is to gather data on your online presence. The functionality for Website / App Feedback is on par with Site Intercept, with notable improvements and a beautiful new user interface.
- When I deploy my intercept, I see the error that reads "No Access-Control-Allow-Origin". How do I fix it?
-
This error message appears when you are a FedRAMP user and you are trying to deploy an intercept on a website that has not been whitelisted.
If your project is within our FedRAMP environment, and your website's domain does not end in .gov, you will need to contact FedRAMP Support to request that your domain be whitelisted. If you attempt to run an intercept prior to doing so, you'll encounter a console error of "No Access-Control-Allow-Origin". This enhanced security measure will need to be completed for any subdomain that doesn't end in .gov, as well.