ForeSee Developer Portal

Everything you need to configure and optimize your ForeSee products. Home of developer documentation, implementation guides, and release notes.

Blueprint

On-Premises Deployment

Overview

The ForeSee On-Premises Deployment option gives you the ability to host all of the ForeSee product files on your internal server(s). CX Measure, Replay, and Feedback are all available in the On-Premises Deployment option.

With On-Premises Deployment, you also have the ability to make changes to product configurations through CX Suite. Note: Configuration changes outside of CX Suite can only be done by the ForeSee Support Team, e.g., sampling percentage, loyalty factor, invite excludes, etc.

Installation

Set up of the On-Premises deployment requires these two steps:

Step 1: The Support Team sends the product files as a zipped email attachment for hosting on your website.

Step 2: Deploy the HTML snippet on your website template or a global tag manager. This needs to appear on every page of your website, ideally in the <HEAD> area. Don't forget to include it on special areas of the site like in the checkout process and 'logged in' areas.

For details on deploying within a tag, please refer to the article on Using Tag Managers to Add the Embed Snippet.

See the example STAGING embedded snippet below. Your snippets come in the zip folder delivered to you from ForeSee. The file names to look for are:

  • sampleselfhost_page_production.html
  • sampleselfhost_page_staging.html

There are two sections of the snippet that you must update to reflect the file path to where you want to host our main code files, "data-codelocation" and "data-product-assets". Here is an example of what the file path could look like: "data-codelocation": "/foresee_assets/code/19.3.3-v.2/",
"data-product-assets": "/foresee_assets/product_assets/".

On-Premises Embed Snippet

Below is an example of the ForeSee On-Premises snippet to be used for a STAGING environment.

The "data-environment" attribute inside the snippet determines which environment to use. For PRODUCTION, use the snippet from the sampleselfhost_page_production.html file (in which the "data-environment" attribute is set to ‘production’).

You may also need to update the values in the "data-codelocation" and "data-product-assets" to reflect the location where you host the ForeSee files.

<script type="text/javascript">
    // Instructions: please embed this snippet directly into every page of your website template.
    // For optimal performance, this must be embedded directly into the template, not referenced
    // as an external file.

    // ForeSee Embed Script v2.00
    // DO NOT MODIFY BELOW THIS LINE *****************************************
    ;(function (g) {
      var d = document, am = d.createElement('script'), h = d.head || d.getElementsByTagName("head")[0], fsr = 'fsReady',
        aex = {
          "src": "gateway.min.js",
          "type": "text/javascript",
          "async": "true",
          "data-vendor": "fs",
          "data-mode": "selfhost",
          "data-environment": "staging",
          "data-hasssl": "true",
          "data-client": "[sitekey]",
          "data-codelocation": "/foresee_assets/code/19.3.3-v.2/",
          "data-isselfhosted": "true",
          "data-product-assets": "/foresee_assets/product_assets/",
          "data-role": "gateway"
        };
      for (var attr in aex){am.setAttribute(attr, aex[attr]);}h.appendChild(am);g[fsr] = function () {var aT = '__' + fsr + '_stk__';g[aT] = g[aT] || [];g[aT].push(arguments);};
    })(window);
    // DO NOT MODIFY ABOVE THIS LINE *****************************************
</script>

🚧

Embed snippet for http sites

If your website has http pages, you must make a change to one line of the embed snippet.

Change "data-hasssl":"true", to "data-hasssl":"false",.

Code Hosting Diagram

This diagram shows how the various files involved in the On-Premises Deployment are hosted. Note that the ForeSee configuration files are pure data only and clients host all of the product files on their internal servers. Please also note that the connections shown are only made one time per site visit.

Updated about a year ago

On-Premises Deployment


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.