Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure HTML features in the developer interface

The Developer Interface for HTML features allows you to define and integrate HTML features with your site, offering options for running in different environments and controlling web crawler access.

Once you select Continue in the Add a Feature screen, the Developer Interface for HTML Features appears. Use it to configure runtime options and integration specifics before building your rule.

To define the Developer Interface for an HTML feature, complete the following steps:

  1. Choose where to run your HTML feature:
    • Run in Site CDN : Use this when leveraging the Zephr CDN transformation layer.

    • Run in Browser Use this for browser-side execution, regardless of CDN use.

  2. Select whether to allow web crawlers to access the feature from the Web Crawler Access radio buttons. The options are as follows:
    • Yes - Allows web crawlers, such as, Googlebot, Bingbot, to access the feature even without an active session or product grant. Zephr verifies both agent and IP address.

      Zephr verifies an agent as a trusted crawler by checking both the IP address and the User Agent. If the User Agent indicates a crawler device type, Zephr performs a reverse DNS lookup on the IP address to match it with the list of verified domains, including:

      • Googlebot - For further information on Googlebot, refer to the Google documentation.

      • Bingbot - For further information on Bingbot, refer to the Microsoft Bing FAQs .

      • Applebot - For further information on Applebot, refer to the About Applebot page .

      • LinkedInbot - For further information on the LinkedInBot, refer to the LinkedInBot read me.

      • Yahoo Slurp - For further information on Yahoo Slurp, refer to Yahoo Help Central .

      • Facebook - For more information, refer to the Facebook Crawler documentation .

      • DuckDuckGo - For more information, refer to the DuckDuckGo Help Pages .

        Note: Zephr does not verify the IP address of other web crawlers.
        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 <https://knowledgecenter.zuora.com/Zephr/Products/Rules_Builder/Feature_decision_nodes/Session> topic.
    • No - Blocks web crawler access.

  3. If you've selected Run in Browser in Step 1, you can define JSON paths that could be used to make decisions in the rule. The JSON paths should match the JSON object that is passed to the custom data. Add_JSON_Path.png Click Add A JSON Path to add a JSON path. Available data types are String, Number, Boolean, and DateTime. You can later create Custom Data decisions based on the JSON Path defined here. For more information about how to add Custom Data decisions, see Custom Data .
  4. Select whether to use comment tags or CSS selectors to integrate the feature with your site from the Site Integration radio buttons. The options are as follows:
    • Comment Tag - Zephr generates HTML tags to embed around your feature. Copy them using the Copy control and paste into your site's code. For an example of using Comment Tags, see the Comment Tags Use Link text: Comment Tags Use, Path: //Zephr/Products/A_Features/Add_a_Feature/Developer_interface_for_HTML_Features/Comment_tags_use topic.
    • CSS Selector: Enter a valid selector that identifies your feature element in the markup.

  5. If the feature tags, or CSS selector, are already added to your code, you can verify the integration by selecting the Check Sites for Feature button. If integrated successfully, you'll see a confirmation message and the URL where the feature was found. If not found, the message will indicate failure and the text box will remain blank.
    You can enter your origin URL in the Example Feature URL text box to check your site again.
    Note: The origin site URL is the URL to which your domains, or vanity URLs, would point if you were not using the Zephr CDN; or, if not using the Zephr CDN, your website.
  6. Click Update & Lock to preserve your settings. Then choose Save to store the HTML Feature. Or, use Save & Publish to make the feature immediately available for use.

    You can build your rule using the output in the Rules Builder. For further information on the available decision nodes, see the Feature Decision Nodes topic.