Top
Creating a Beacon
  • 2 minutes to read
  • Print
  • Dark
    Light

Creating a Beacon

  • Print
  • Dark
    Light

A beacon enables you to quickly catch the attention of your user to a particular part of your application. Creating a Beacon is a 2 step process.

The first step is done using the editor extension where you capture the part of the screen where you want the beacon to appear. Then, on the Whatfix dashboard, you need to define when and where the beacon will appear.

Step 1: Create the Beacon

Step 2: Configure the Segment for the Beacon

Step 1: Create the Beacon

  1. On the Whatfix Editor, click Beacons.
    click_beacons_wfx_editor.png
  2. Enter a name for the Beacon Collection.
    Note
    • A Beacon Collection is a grouping of beacons belonging to the same page.
    • The Beacon Collection name is solely for your (creator's) reference and is not visible to the user.
    • Visibility rules are defined for a beacon collection. So even if you have only one beacon on a page, it needs to be part of a collection.

    beacon_collectionName.png

  1. Click the +Beacon button to create a new beacon.
    beacon_%2Bbeacon.png
  2. Select an element on the application where the Beacon must appear.
    Beacon_element.png
  3. Enter the label for the Beacon. 
    beacon_name.png
    Note
    This text is visible to the user when they hover over the beacon.
  1. Set the position and visibility for the beacon.
    beacon_position_appearance.png
  2. Click Add Beacon.
    Beacon_addBeacon.png
    Note
    Multiple beacons can be included on a single page. To include more beacons, click the +Beacon button and repeat 5 to 8 for each beacon.
  1. Click Maximize.
    beacon_maximize.png

  2. Click Save.
    Once you have created the Beacon collection, a segment is automatically created on your Whatfix dashboard.

Step 2: Configure the Segment for the Beacon

Configuring Segments helps you control who sees your content and when and where your beacon is displayed. To configure the visibility rules, follow the procedure below.

  1. Navigate to the Whatfix Dashboard.
    gotoDashboard%20%282%29.png
  2. In the left panel, click Widgets.
    widgets1.png
  3. Click Beacon.
    Widgets_beacon.png
  4. Navigate to the auto-created segment. The segment name is the beacon collection name. Click the Edit icon.
    beacon_autoSegment.png
    Note
    The beacon collection that is attached is the newly published content.
  1. Expand the Set Visibility Rules section and set up your visibility rules that determine the display of the beacon collection. See Identifying conditions for showing tooltips for more information on the different conditions used in visibility rules.

    beacon_visibilityRules.png

  1. Click the When tab and then select the number of times you want to show the beacon.
    beacon_visibility_repeat.png
  2. To attach a flow, video, or link to the beacon, expand Attach Content section, click the Attach Content button and then select any content that you want to display to your users.
Note

The attached content starts based on the Disappearance of Beacon setting you configure when creating it.

beacon_segment_attachContent.png
8. Click Save.
9. On the Segment page, activate the segment. 
segment_active.png

To learn more about setting up visibility rules, see Segmentation.

    Note
    • The beacon stops displaying once the user clicks it. To show the beacon again, you can refresh the beacon segment or re-create it.
    • If Beacons are to be used for multiple pages; separate collections need to be created for each individual page.
    • Subsequent changes to the beacon collection do not update the corresponding segment.
    Was this article helpful?