- 11 Mar 2024
- 4 Minutes To Read
-
Print
-
DarkLight
-
PDF
Set Technical Configurations for your Whatfix account
- Updated On 11 Mar 2024
- 4 Minutes To Read
-
Print
-
DarkLight
-
PDF
The Technical Preferences Section enables specific system configurations, initially set using code, to be configured directly on your dashboard at a global level. This centralized control ensures that modifications can be applied universally, enabling you to manage system configurations and behaviors, and implement changes seamlessly across your entire Whatfix deployment.
The following table provides a list of all the preferences you can set up:
Analytics
Preference title | Description |
---|---|
GA Exclude Optional Dimensions | When enabled, this preference reduces data sent to Google Analytics using smaller and secure GET calls, potentially avoiding data loss from blocked POST requests due to large payloads. However, this may result in some data being omitted. |
Proxy Domain | When enabled, you can set up a forward proxy on your network using a custom domain to receive Analytics calls. From this proxy domain, the calls are then forwarded to the http://whatfix.com endpoint. |
Common Properties
Preference title | Description |
---|---|
Finder Performance | When enabled, you can improve Smart Detect performance by reducing multiple element detection calls when an element selector is provided. |
Mutation Observer Config | When enabled, Whatfix monitors mutations whose type matches this configuration. This preference is used by Smart-Tips, Beacons and Launchers. |
Mutation Throttle Interval (ms) | When enabled, Whatfix re-evaluates Smart-Tips, Beacons and Launchers only if the page is stable for a certain time interval. By stable, it means there is no change in page structure for that time interval. This time interval can be changed using this property. |
Overflow Hidden Check Required | When enabled, Whatfix evaluates hidden elements that become visible only on a scroll action. |
Override Text Content with Inner text | When enabled, Whatfix captures the innerText property of the selected element instead of the textContent property. |
Mutation Observer Config for Smart Context | When enabled, Whatfix monitors mutations whose type matches with this configuration. This config is used by Smart Context to re-evaluate all widgets if Page Tags have changed due to these mutations. |
Mutation Throttle Interval for Smart Context (ms) | When enabled, Whatfix re-evaluates all widgets only if page is stable for a certain time interval. By stable, it means there is no change in page structure for that time interval. This time interval can be changed using this preference. |
Single Page Application | When enabled, Whatfix considers the current application as a single page application. |
Step Configurations | When enabled, you can apply global configurations to tooltips in Flows, Smart Tips, or Beacons. |
Z Index | When enabled, you can set the desired z-index for Whatfix elements. Z-index property is related to the order in which various HTML elements on a page show up, either in front or behind. If tooltips are showing up behind the HTML elements then it can be brought to the front by using the z_index property value with a higher value. |
Flows
Preference title | Description |
---|---|
Closing Retries | When enabled, this parameter determines the number of retries Whatfix will perform to find the selected element before continuing with the running Flow. This is useful when waiting for a new page, redirect, or page refresh to occur. |
Delay State Clearance | When enabled, Whatfix delays Flow end state, especially when the subdomain remains the same or when dealing with different domain states. This enables Whatfix to hold Flow progress during page navigation and reloads. |
Handle Domain | When enabled, Whatfix manages cross domain Flows in JS Embed cases. This prevents steps failing when a Flow is created across multiple domains. |
Handle SubDomain | When enabled, this preference, in conjunction with Handle Domains, stores Flow state when it is active within the same domain but different subdomains. This means that if a Flow is created across multiple subdomains, then Whatfix is able to prevent the steps from breaking. |
Ignore Scroll on Body | When enabled, Whatfix ignores the scrollbar on the application body and automatically scrolls to the element where the Flow step is created. |
Message On Close | When enabled, a Flow end message is always shown when the Flow is closed midway or exited. |
Step Timeout Durations (ms) | When enabled, you can set the time allocated to locate the next step. If Whatfix cannot find the step in the allocated time, it advances to the next step or fails. |
Self Help
Preference title | Description |
---|---|
Self Help Link Content Query Param | When enabled, Whatfix provides a JWT token for repository content. This token is automatically added as a query parameter whenever repository content is accessed. |
Self Help Search History Popup Disable | When enabled, you can choose to not show Self Help search history popup. |
Self Help Search Suggest Popup Disable | When enabled, you can choose to not show Self Help search suggestion popup. |
Support Chat Target | When enabled, you can open the Self Help configured chatbot either in the same tab or a new tab. |
Smart Tip
Preference title | Description |
---|---|
App Initial Load Time | When enabled, Whatfix maintains a continuously runs element detection to ensure that any Smart Tips loading within an iframe do not break. |
Mutation Exclude Attribute Names | When enabled, Whatfix disregards application attributes during mutations of the application. |
Smart Tip Overflow | When enabled, Whatfix assesses the visibility of the select element on the screen. If the element is obscured, hidden, or scrolled out of the viewport, the content is not displayed. This is also applicable to Beacons, and Launchers. |
User Action
Preference title | Description |
---|---|
Time Check End User | When enabled, Whatfix modifies the default retry behavior for User Actions in the end user browser, ensuring that any widget visibility remains unaffected in the presence of any User Action related issues. |
User Action Ids with Visibility Check | When enabled, Whatfix enables custom Smart Detect behavior and adjusts retry frequency for User Actions specified in its scope. This ensures that no latching issues occur due to underlying application’s UI. |