Top
URL Properties as Visibility Rules
  • 27 Nov 2023
  • 4 Minutes To Read
  • Dark
    Light
  • PDF

URL Properties as Visibility Rules

  • Dark
    Light
  • PDF

Article Summary

Introduction

URL Properties enable you to uniquely identify a web page to show Whatfix content and widgets. These properties can be added as a Visibility or Display Rule condition to your Whatfix content and widgets, as required.
The following are the URL Properties that you can use:

  • URL
  • URL Hostname
  • URL Path
  • URL Parameters
  • URL Hash

Types of URL Properties

URL

You can use the URL criteria to specify the entire URL that you want to use as a Visibility or Display Rule.

url_studio


your title goes here

Whatfix enables you to add dynamic URLs also. For more information on how to use dynamic URLs as a Visibility Rule, see the use cases mentioned in this article.

URL Hostname

When you want to uniquely identify a page using the domain name, you can use this condition. The URL Hostname is the first part of any URL.

URL Hostname new 11

Example: If you wish to display the tip only when you are on ap17.lightning.force.com, you can add a condition as shown in the following screenshot.

url_hostname


URL Path

The website pathname is the part that you see after your domain name but before the parameters or hashes.

URL path new1

Example: If the website URL is https://ap17.lightning.force.com/lightning/#lead/
list?filterName=Recent, then the pathname is /lightning.

url_path_new


URL Parameters

If you want to identify your web page using the parameters on the URL, you can use this condition.

URL parameter updated1

Example: If you want to show a tip to a user only when they filter for Recents, you can add a condition as shown in the following screenshot.

url_parameters_studio


URL Hash

If you want to identify a page using the hash value of your URL, you can use this condition. Hashes are usually present in Single page applications developed using AngularJS or ReactJS. There are no page refreshes but only Hash changes.

URL Hash updated1 1

Example: If you want to show a tip to a user only when they go to the Lead page, you can add a condition as shown in the following screenshot.

url_hash_studio


Use Cases

Display a widget on a specific page

Use the following steps to configure the Visibility rules in a widget:

  1. Under the Visibility Rules condition, select URL
    image.png

  2. Under the Operator section, select Contains
    db_URL_contains

  3. Copy the URL value that is common across all the pages of your application, and then paste it under the URL section.
    db_URL_contains_Web_URL

  4. Click Save.

Display a widget on selected pages in an application

Use the following steps to configure the Visibility rules in a widget:

  1. Under the Visibility Rules condition, select URL.
    image.png

  2. Under the Operator section, select Not Equals.
    image.png

  3. Copy the Browser URL of the page you don't want the widget to appear, and then paste it under the URL section.
    image.png

  4. Click Save.

Display a widget on all pages across the application

Use the following steps to configure the Visibility rules in a widget:

  1. Under the Visibility Rules condition, select URL.
    image.png

  2. Under the Operator section, select Contains.
    image.png

  3. Copy the URL value that is common across all the pages of your application, and then paste it under the URL section.
    image.png

  4. Click Save.

Display a widget on all pages of an application except one

your title goes here

Pre-requisite:
To prevent a widget from appearing on a page, you need to identify the URL path value specific to the page that you want to exclude.

Use the following steps to configure the Visibility rules in a widget:

  1. Under the Visibility Rules condition, select URL.
    image.png

  2. Under the Operator section, select Contains.
    image.png

  3. Copy the URL value that is common across all the pages of your application, and then paste it under the URL section.
    image.png

  4. Click the Plus icon.
    image.png

  5. Select URL as the display rule condition.

  6. Under the Operator section, select Not Contains.
    image.png

  7. Copy the URL value specific to the page you don't want the widget to appear on, and then paste it under the URL section.
    image.png

  8. Click Save.

Display a widget on an application in case you have dynamic URLs

A dynamic URL has a URL path that is divided into two parts. One part of the URL path is dependent on user-defined variables, that keep changing to display specific information depending on user inputs. The other part of the URL path is independent of user inputs and remains common throughout the application.

your title goes here

To display a widget on an application having a dynamic URL, you need to identify the two parts of the application URL.

If the URL path ends with a dynamic value, then while configuring the Visibility rules in a widget, use the following steps:

  1. Under the Visibility Rules condition, select URL.
    image.png

  2. Under the Operator section, select Starts With.
    image.png

  3. Copy the independent URL path value, and then paste it under the URL section.
    image.png

  4. Click Save.

If the URL path begins with a dynamic value, then while configuring the Visibility rules in a widget, use the following steps:

  1. Under the Visibility Rules condition, select URL.
    image.png

  2. Under the Operator section, select Ends With.
    image.png

  3. Copy the independent URL path value, and then paste it under the URL section.
    image.png

  4. Click Save.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.