> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/engage/-MGi9-KKLwnWfoD36Ot6/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/engage/-MGi9-KKLwnWfoD36Ot6/getting-started-with-engage/configuring-engage-on-your-website/setting-up-the-inititalization-script.md). # Setting up the Initialization Script Once your configuration is set up, you can download the Engage plugin for your website using the loader CDN URL. The standard Engage initialization flow using the Loader URL is as follows: * You add the Loader CDN URL (script tag with source ) followed by the Engage Init script into either the`` or the `` tag on every page of your website. The exact method of propagating this code to all your pages can vary depending on the CMS that is used to manage your website. * The Loader CDN URL downloads the loader-Config.json file. The loader-Config.json file contains the URLs from where the loader then downloads the Engage plugin, the FingerPrint plugin, and the G2Insights plugin. The Audience plugins (Engage, FingerPrint, and G2Insights) are fetched from Naviga-managed CDN. * Once plugins are fetched, Loader initializes them passing the plugin-specific part of the initialization script. {% hint style="warning" %} Prior to version 2.7.2, Engage requires jQuery 3.0 or higher to function. {% endhint %}

CName Approach

#### Context: The loading of the Engage Plugin on your site can be blocked by the Adblockers enabled on readers’ browsers. An Adblocker generally blocks those URLs on a website that appear to be third-party URLs. Whenever Engage CDN URLs are mistakenly identified as third-party URLs by the Adblockers, the URLs cannot bypass the Adblockers set on the browsers. This problem is particularly observed when Adblockers such as AdBlock Ultimate, UBlock, Ghostery, or similar ones are activated on the browsers. To resolve this issue, it is recommended to implement the CName(Canonical Name) approach. #### What must you do? 1. You should create four subdomains using your specific clientCode/clientName such as:\ a. **loader.\.com** --> For ***loader.min.js*** and for ***loader-config.json***\ *b.* **Engage.\.com** --> For ***t8y9347t.min.js*** and ***t8y9347t.min.css***\ *c.* **Fp.\.com** --> For ***fp.min.js***\ *d.* **G2i.\.com** --> For ***g2i.min.js*** 2. Share the newly created subdomain names with your Project Manager to pass them on to the Engage team. 3. These sub-domains must then be directed/pointed to Engage CDN endpoints.
*(Note: This step enables Engage to bypass any Adblocker set on the readers’ browsers. We can make sure that the loading of Engage plugins is uninterrupted and not affected by any Adblockers.)* For example,\ loader.\.com should direct to -> loader-cdn.azureedge.net\ Engage.\.com should direct to -> connext-cdn.azureedge.net\ Fp.\.com should direct to -> fp-cdn.azureedge.net\ G2i.\ should direct to -> g2insights-cdn.azureedge.net 4. The new client sub-domains must be whitelisted in Engage CDN endpoints. The whitelisting ensures that the new subdomains are recognized as legitimate and can access Engage resources without issues. #### Note: Below is an example of a loader URL following the CName approach: New URL: .com/prod/\.loader.min.js Example:

Below is a sample version of the scripts for a production environment: ```javascript ``` {% hint style="info" %} * To avoid any timing and page rendering issues, it is ideal to place the initialization code towards the end of the page, just inside the closing``tag. This ensures that all the DOM elements are already present on the page before the script starts loading. * It's also recommended to place the Engage initialization script as the **first script within the list of scripts loaded at the end of the body tag**, but again, make sure that it is AFTER all the DOM objects are loaded. {% endhint %} ### Initialization Script Options The initialization script contains the necessary `initOptions` that define the settings for each of your Audience plugins: Fingerprint (`"FP"`), G2Insights (`"DL"`), and Engage (`"NXT"`). All the values passed within `initOptions` must be separated by commas.\ Below you'll find a list of the essential Engage options and their properties.

Option Name	Description	Parameters
Option Name	Description	Parameters
`clientCode`	Mandatory. The constant variable representing your publication, provided by your Project Manager.	e.g. `"My-Newspaper"`
`siteCode`	Mandatory. This is the site code that will be provided by your Project Manager. If it's missing or invalid, Engage will not be able to initialize.	e.g. `"MNPP"`
`environment`	Optional, defaults to `prod`. This option sets the testing environment for your website and determines the relevant database and website where Engage is to be deployed. If the `environment` option property is missing, Engage will search for the environment details in the website's URL. If none are found, the `"prod"` property will be passed.	`"stage"` – for staging environments `"prod"` – for production environments (The property used by default is "prod").
`configCode`	This is the code of your configuration containing all your Engage settings. The code is defined in the Configurations tab of your Engage dashboard.	e.g. `"CONFIG"`
`debug`	If set to `true`, will open the Engage debug panel by default. Should be set to `false` in production.	Boolean
`silentmode`	This option can be used if you would like to initialize Engage manually by running the `Connext.Run()`method.	`"true"` – Engage will not start initializing until you use the `Connext.Run()` command; "false" – Engage will initialize as usual according to your settings. The default property is `"false"`.
`runSettings`	This option defines specific parameters that can be used to run the Engage plugin.	`runPromise` – uses a JavaScript Promise object based on the fulfilled/rejected status of which Engage will run. This is useful if you would like the plugin to start after some other process; `onRunPromiseResolved` – a callback function which is called when `runPromise` is fulfilled (by default when `Connext.Run()` is executed). `onRunPromiseRejected` – a callback function which is called when `runPromise` is rejected; `runOffset`– a delay in milliseconds after which Engage will run (in case the Promise object did not return any results). By default, `runOffset` is 5000 milliseconds (if `runSettings` are present but `runOffset` is not).
resourceUrl	Defines url for downloading plugins.	e.g. “"https://cdn.someurl.xyz/stage/clientCode”
settingsKey	This option is used to handle sub-sections of the site.	e.g. “sports"
configSettings	Defines some settings which should be merged with config settings from DB.	e.g. {“ EnforceUniqueArticles”: false}
productCode	Defines product code.	String
apiUrl	This option stores url to engage API	e.g. “https://271-api-connext.azurewebsites.net/”
integrateFlittz	Used to integrate Flittz platform	Boolean
publicEventHandlers	This option defines a list of callbacks that can be used to handle specific events.	onNotAuthorized, onAuthorized, onHasNoActiveSubscription, onHasAccessNotEntitled, onHasAccess;
appInsightsKey	This option is used to store data to AppInsight and then to get this data by this value.	e.g. “nxt”
loadType	This option defines how to load data.	e.g. “ajax”
authSettings Note: The parameters seamlessSISO is available from 2.8.6, seamlessSO is available from 2.8.6.1, and enableAuth0JwtCookie is available from 2.8.3.2. The seamlessSISO parameter is renamed to seamlessSI from 2.8.7.	This option defines some values for authentication.	{ "domain": "site.com", "client_id":"some_secret_key", "redirect_uri":"https://www.site.com/login-redirect/", seamlessSISO: true/false, seamlessSO: true/false, enableAuth0JwtCookie: true/false, "cacheLocation":"localstorage" }
swgSettings	This option defines properties to configure Subscribe with Google feature.	{ “ DataMarkup”:”string”, “GoogleClientId”:”string”, “SwgJs”: “string”, “JsonpCallback”:”string”, “ForceAccountLinking”: false }
userAuthenticationTime	Defines amount of days of life of auth cookie’s value	Number
userIgmAuthTime	Defines amount of days of life of IGM auth cookie’s value	Number
tracingSettings	Defines settings of tracing logs.	{ “TraceLevel”: 0, “DebugTraceExpirationSettings”:{ “Duration”: 0, “StopAfter”: 0, “ConfigCode”: “string” }
traceLevel	Defines which level of logs to trace. (Debug, Error, Fatal, None)	Number
debugTraceExpirationSettings	Defines when tracing settings expire.	{ “Duration”: 0, “StopAfter”: 0, “ConfigCode”: “string” }
ViewsUpdateFromServerPeriod	This option defines how often Engage should update views (In hours).	Number
ConversationPromiseTimeout	This option defines how long conversation calculation can take (In milliseconds).	Number
ActionPromiseTimeout	This option defines amount of time to resolve action (In milliseconds).	Number
DynamicMeterPromiseTimeout	This option defines amount of time to resolve dynamic meter (In milliseconds).	Number
articleIdProvider	Optional. This option defines a function that returns articleId.	Function
checkUserDataEveryPageload	Optional. This option turns on refreshing user data on every pageload instead of updating it once in 24 hours.	Boolean
batchCount	Defines count of requests after which Engage sends view request to the server.	By default 3.
attr	Additional attribute for config’s name	String
sessionId	This option helps to identify actions per session.	String
publishData	Contains information about the last published configuration.	e.g. {"publishSettings" :{"ResetArticleViews": false, "ResetAllowIpList": false, "ResetCurrentConversation": false, "ResetRepeatable": false, "ResetDaysVisitedSite": false, "PluginDebugAllowed": true, "Date":"2022-03-30T20:34:56+00:00"}, "needUpdate":false}
externalMigrationCode	Defines code migrations.	String
integrateDisqus	This option is used to add Disqus integration	Boolean

## Init Parameters ### authSettings 1. **seamlessSI** - If this parameter is set to 'true', it enables seamless sign-in functionality across your sister websites. The Seamless Sign-In feature allows visitors to stay logged in to your other sister websites if they are already logged in on any of your websites. 2. **seamlessSO** - With this parameter, you can configure the lastlogoutDate API call. When the parameter "SeamlessSO: true" is present in the initOptions, Engage triggers the lastlogoutDate API call on every page load. If this parameter is absent in the initOptions or if its value is 'false', then the lastlogoutDate API call is not triggered on every page load. 3. **enableAuth0JwtCookie** - If this parameter is set to 'true' in initOptions, the Engage plugin drops a cookie 'auth0\_jwt' with the contents of Auth0 JSON web token that has the access details, and Engage allows server-side paywalls on your website. 4. **enableActiveIdTokenFlow** - If this parameter is set to 'true' in initOptions, upon successful user login, the `auth0_jwt` cookie will store the ID token received from Auth0, with an expiry time the same as that of the ID token of the Auth0 local storage object. {% hint style="info" %} **Server-side paywalls:** As the name implies, it is a mechanism used to restrict access to content or services on your website from the website server. The implementation of the server-side paywall and its functioning is completely the client's responsibility. {% endhint %}