Zephr User Guide

Creating and Managing Zephr Features

993 views 0

In Zephr, Features refer to the elements of your site you wish to place access decisions on. By creating a Feature within Zephr, you can customise your user journeys for anonymous, registered, and subscribed users viewing your site features, using our Zephr rules builder.

Your list of Zephr Features is available to view by navigating to Products > Features within your Zephr Admin Console.

The list of Features details the Feature Title, Feature Type, and Latest and Live Versions of each Feature. You can also click View to view and edit different versions of your Feature, or click Delete to remove it.

Creating a Feature

To add a new Feature, click the Add A Feature button.

Name your Feature and, if relevant, provide a short description. We recommend naming the Feature as simply as possible. For example, if you are creating a rule for how users interact with articles, name your Feature ‘Article’.

Types of Integration

Zephr journeys can be integrated into your site using HTML, JSON or SDK integrations.

HTML Features work by looking at parts of an HTML document, such as an article body, video, image, or data table on your website. Each feature is wrapped with Zephr tags. When wrapped in these tags and served via the Zephr CDN, we are able to transform these features, removing them or replacing them with new user journeys, such a registration walls, paywalls, and special offers.

JSON Features work by transforming a JSON response based upon Zephr Decision outcomes. To use JSON Feature Rules within Zephr you need to set up a Site with a JSON origin. Typically this would be an API that returns JSON content, listing the features available for transformation. Read our Sites guide for more information about setting this up.

SDK Features allow you to share information with Zephr’s Decision Engine and receive a response detailing the outcome your Site, App, or CDN should take for an individual user.

Select the type of integration you wish to use, then click Continue. In this example, we will use HTML Features. Read our JSON and SDK guides for details on other types of integration.

Developer Interface

Once you have named your Feature and selected the type of integration you wish to use, you will see a Developer Interface. This contains the tools needed by a developer to add the Feature to your site.

Firstly, you will see the option to allow web crawlers to access this feature. Selecting Yes will mean the likes of Google Web Crawlers will be able to read your article, regardless of not having an active session or product grants. If you do not want this, select No. Zephr verifies the IP address of the following crawlers before granting access:

If you want to control access for other web crawlers, you can use the Device decision node. For further information on the Device decision node, see the Session topic.

Note: Zephr does not verify the IP address of other web crawlers.

Next you will see the Site Integration section, which details how to integrate the Zephr Feature with your site.

If you have chosen an HTML integration, you will be given a Feature Tag, like the one seen below, which should be wrapped around the feature of your website.

Zephr HTML Feature Tags

If you have already integrated the Zephr Feature Tags onto your page, you can check your integration by selecting Check Site for Feature Tag. This will crawl your site to check the Feature Tag is present, and warn you if it cannot be found.

No Feature Tags Found

Once you’re happy with your Developer Interface set up, select Update & Lock. This will ensure it is not accidentally updated during future rule changes. Once locked, it can be accessed below the Rules Builder.

Using the Rules Builder

The Zephr Rules Builder is where you decide what your site visitors see.

Across the top, you will note a slider for Anonymous, Registered, and Customer user types. Toggling between these will give you a blank rule canvas to build a bespoke journey for that user type.

The Rules Builder also has a decision bar, detailing the different decision points and outcomes available to use, and a rule canvas. You can filter the decision points using the search on the left of the decision bar.

Select the magnifying glass to display the Search text box.

The filter automatically updates to display only the decision points that match the characters you enter.

When you select a different tab in the rules canvas, the search filter is removed.

Each journey begins with a Page View Node, signifying when a user views a page which includes your Zephr Feature. To build your user journeys, drag decisions from the top decision bar onto your rule canvas and join the dots to build your user journeys.

For example, if your Registered users should have full access to Article contact, select Outcomes from the decisions bar, drag the Show Article outcome onto your canvas and connect it to the Page View Node.

Example Rule in the Zephr Feature Rule Builder

Most decision points will display on your rule canvas with an output for Yes, and an output for No. Follow each option like a tree to build each possible user journey, finishing each branch with an Outcome stating what users following that journey should see.

If you’re still learning the array of options available to you within Zephr, take a read of our Feature Decision Points guide, and our Feature Outcomes guide. Alternatively, take a look at one of the following guides:

When you’ve built journeys for each of your user types, click Save.

Managing your Feature

Zephr Rules are versioned, so once you’ve saved your Feature, you will be taken to a page detailing any versions of this Feature that are available to publish.

List of Available Features and Actions

Click the version number to view or edit any of these rules, or click Add a New Version to start from scratch. Edited rules will always save as new versions, so there’s no need to worry about losing old versions.

If you wish to delete a version, click the Delete button next to the relevant version number.

Publishing your Feature

Your Feature’s version page also provides information on which rule is currently in Staging or Published to your live site.

Published rules are tagged as Live in the Status column, versions in Staging are tagged as Staged, and versions which have previously been Live have a status of Previously Published.

To publish a rule, you will first need to promote it to Staging. To do this, click the Stage button in the Actions column, next to the relevant version.

When you’re happy with your rule in Staging, click Publish, and we’ll make your rule Live. Only one version per Feature can be made Live at one time.