In this article, we will focus on the site properties that can be configured in Portal, in the section of Advanced Settings for each site:
List of configurable properties
Property | Example of the value |
personalAnalytics.enabled | true |
pageTracking.enabled | true |
editor.screenshots.enabled | true |
editor.popup.openAsWindow.urlPatterns | ^ http://example.com.* |
contentPreview.enabled | true |
webExtension.runtime.Mode | "ISOLATED" |
theme.name | "dark" |
urlProcessor.urlProcessorId | "crmURLProcessor" |
urlProcessor.enabled | true |
urlProcessor.patternUrlProcessor.buildUrl.replacePattern | Pattern to replace dynamic part a URL before navigating to URL (e.g. when Journey is started). |
urlProcessor.patternUrlProcessor.matchUrl.ignorePattern | Pattern to ignore part URL during matching. |
hint.preciseFiltering.enabled | true |
pageMonitor.mutationBuffering.interval | 200 |
pageMonitor.mutationBuffering.threshold | null |
pageMonitor.mutationBuffering.maxCapacity | null |
crossDomainStorage.storageAccessApi.enabled | false |
overlayApi.enabled | true |
ai.assistant.enabled | true |
ai.assistant.customKnowledge.enabled | true |
ai.translation.enabled | true |
Personal Analytics
If the property "personalAnalytics.enabled" is set with the value as "true", end users will have to do the mandatory user identification before playing the journeys and it will be possible to monitor their activities based on usernames in the whole Analytics section.
In cases it has value as "false", mandatory login will be disabled as well as Activity Feed section in Portal Analytics.
Page Tracking
If the property value is configured as "true", the frequency of visiting different pages of the target application by users is tracked and shown in Page Views Analytics section.
If the property is set to false, the page views are not tracked.
Editor Screenshots
If "editor.screenshots.enabled"= true, it is possible to see and update screenshots of steps and tips in the Editor:
If "editor.screenshots.enabled"= false, it is not possible to see the screenshots in Editor.
Editor Popup
The configurable property "editor.popup.openAsWindow.urlPatterns enables to specify when popup will be opened as a native window. By default, popups will be opened as Editor tab.
Native popup window is for target web application that uses opener-child relation in its popups. Editor tab is for all other cases.
Editor tab
Native window
- In this case popup is opened in a separate window on the top, hiding part of the Editor main window
- Overlay automatically starts in opened popup and is disabled in a opener tab
- When popup is closed, then Overlay in a opener tab is enabled again
- Journey can flow from opener to popup and back
Example of how to configure this property:
When such pattern (see example below) is configured for this property value, then all popups on URL starting with http://example.com will be opened as native windows.
editor.popup.openAsWindow.urlPatterns = ^http://example.com.*
Content Preview
If "content.preview.enabled" is set as true, the functionality of opening Journeys and Bookmarks as a slideshow from the Launcher is enabled both in Editor and in the browser:
If you set this property value as false, Journey and Bookmark slideshow will get disabled in the Launcher in both Editor and browser (in the Editor you will still have an option to open a slideshow from the sidebar):
Web Extension mode
When the content is deployed to the target application using web extension, there is a possibility to use two different runtime modes. You can find more details in this article: Newired Web Extension.
Theme
Using this property, you can define the Overlay design.
URL Processing
If you set property "urlProcessor.enabled" as true and define value for "urlProcessor.urlProcessorId", you enable the URL Processing feature. This functionality allows the initiation of Journeys from a wider range of URLs.
To learn more about this feature including description of other urlProcessor.* properties, please check this article: URL Processing.
Hint Precise Filtering
If the property hint.preciseFiltering.enabled is set as true, you will be able to use Precise Filtering feature for Hints allowing to register them to the originated page only based on the exact full URL match.
Page Monitor Mutation Buffering
The mutation buffering feature helps to resolve a slow performance of applications with many DOM mutations in short intervals. Hints in such applications are tried to be re-registered to the page each time a DOM mutation in page happens which causes a slower performance. Mutation buffering feature reduces the unnecessary repetitive registration tasks.
The feature can be configured using below described properties:
PageMonitor.mutationBuffering.interval defines the time interval to check if to dispatch buffered mutations, or conditions to be passed are the following:
- The max capacity of buffered mutations exceeds the current buffer.
- The time difference threshold is passed. The comparison is between average time difference of all buffered mutations in the configured interval against the threshold value. If the average difference time is higher, then the condition is passed.
- No new mutation is observed in the configured time interval then buffer is released.
The property value is a real number. The default value is 200ms.
PageMonitor.mutationBuffering.threshold
- One mutation buffered interval can possibly record zero to multiple observed events with some mutations. The time difference between the observed events is calculated and compared against the threshold. If the average value is over the value then the buffer is release to registered subscribers.
- The intention of threshold is to release buffer more frequently. Application page can mutate heavily and the configured interval can continuously buffer the changes without informing subscribers. So if subscribed clients need to react more "lively" then with the threshold configuration you can achieve it (a proper value depends on time frequency of observed events in every page).
The default value is null.
PageMonitor.mutationBuffering.maxCapacity defines the maximum size of buffered mutations.
- Each observed event in one configured interval can signal one or multiple mutations. All those mutations are buffered and checked at the interval conditions
The default value is null.
Cross Domain Storage Access
The property "crossDomainStorage.storageAccessApi.enabled" can be configured with the value as true or false to enable or disable asking end users for Storage Access API Permissions.
You can find more details related to the Storage Access Permission in this article: Storage Access Permission not Granted.
Overlay API
If the property "overlayApi.enabled" is configured as false then Overlay is loaded without Overlay API available in the target web application. This feature was implemented to speed up Overlay start in web pages with strict CSP that prevents Overlay API loading.
AI Assistant
If the property "ai.assistant.enabled" is set as true then each submitted content version is passed to the AI Service and Overlay UI contains AI Assistant.
The property "ai.assistant.customKnowledge.enabled" can be configured so that AI Assistant provides links to relevant articles in the customer knowledge base.
AI Translations
When the property "ai.translation.enabled" is set as true then the Portal contains UI enabling to perform AI-powered content translations.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article