Site Module¶
The site module provides an interface to managing site content through the
Web SDK. This includes utilizing ORB Elements on your website to control
personalized content.
This module is available directly from the namespace:
var site_module = namespace.site();
Architecture¶
The main goal of the site module to keep track of content on the site, whether to track activity or add new content.
The site module is made up of two parts: the site plugin manager and the tagger.
The site plugin manager performs two roles: the watcher and the content manager.
The watcher will keep an eye on mutations of the DOM, and check for new ORB Elements. When new elements are added, it will register them with the content manager.
The content manager receives ORB Elements that are available on the page.
For each element, if it has a placement_id, then the equivalent site plugin
is fetched -- anything it needs, like templates, CSS, and javascript. It will
also use the fetched configuration to tag the element with information. You can
learn all about Site Plugins and their architecture here.
The tagger tags ORB Elements with information useful for tracking. For example, it could tag an element with information about a form on the page so that when submitted, the SDK knows which fields to collect and which to ignore.
A note about content restrictions¶
A conscious decision was made early in the Web SDK development process that we wanted to offer full control to our customers over their website. This includes restricting the insertion of content without their permission.
Therefore, it is our decision that we do not add website content unless it's wrapped with an ORB Element. This way, there's a clear indication of the area and content that the Web SDK can manage.
Any change that is not desired can be removed or altered through configuration or Orbee's Platform.
NOTE:
We do break this restriction for very specific, well-understood areas of content management, like Dynamic Number Insertion (DNI). Learn more
API¶
The site API wraps these capabilities in a few simple functions to work with
the browser's content.
Coming Soon