Top
Create a Beacon
  • 30 Jan 2024
  • 3 Minutes To Read
  • Dark
    Light
  • PDF

Create a Beacon

  • Dark
    Light
  • PDF

Article Summary

Beacon creation is a two-step process:

Step 1: Create the Beacon

Step 2: Configure the segment for the Beacon

Step 1: Create the Beacon

Use the following steps to create a Beacon collection:

  1. Log in to the application where you want to create content, and then launch Whatfix Studio.
    CLM_editor plug in2

  2. On Whatfix Studio, click Beacon.
    clm_studio_beacon

  1. Enter a name for the Beacon Collection.
    beacon collection name
Info
  • A Beacon collection is a group of Beacons and are usually on the same page.
  • The Beacon collection name is solely for your (creator's) reference and is not visible to the end-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.
  1. Click + Add Beacon to create a new Beacon.
    add beacon

  2. Select an element on the application where the Beacon must appear.

  3. In the CONFIGURATIONS tab, under the Beacon style section, choose the style and color of the Beacon.
    Clm_Beacon_style

Note
  • You can select the Custom style to configure the text of your Beacon.
    clm_Beacon_text

  • Once you start selecting the element to place the Beacon, your cursor changes to the set Beacon style. You can then place the Beacon to any desired position.

  1. Under the Positioning section, adjust the position of the Beacon.
    clm_smart tip_basic positioning
your title goes here

There are two different positioning modes,

  • In the Basic Positioning mode, you can choose among the 8 available positions.
    clm_beacon_basic positioning

  • In the Advanced Positioning mode, you can adjust the position of the Beacon by pixel. You can either use the navigational arrows or enter the value in the Movement on key click(px) dropdown to change the position by pixels.
    clm_beacon_advanced positioning

  1. In the Tooltip Position section, choose the position of the tooltip.
    clm_beacon_tooltip position

  2. Enter the name of the Beacon.
    beacon name

Info

The Beacon name is solely for your (creator's) reference and not visible to the end user.

  1. Enter a description for the Beacon action.
    RB_DB_beaconaction
Info
  • The Beacon description is visible to the end user when they hover their cursor over the Beacon.
  1. Set the condition to stop displaying the Beacon.
    disappearance of beacon

  2. Click Save Beacon.
    save beacon

your title goes here

To add more Beacons, click + Add Beacon on the Studio, and then repeat steps 4 to 11.

  1. To save the Beacon collection, click Save Beacon.
    RB_beacon_clicksavebeacon
Note
  • Once you have created the Beacon collection, a segment is automatically created on your Whatfix dashboard.

  • To make content like Beacon or Smart Tip display on your page/ application, on the Whatfix Dashboard, go to the Widget section and move the associated Beacon segment from Draft to Production.

Info

You can edit a Beacon inside a collection during the Beacon creation process. For more information, see Edit Beacons.

Step 2: Configure the segment for the Beacon

Note

If your account is Smart Context enabled, then Whatfix automatically configures the Visibility Rules. In that case, skip to step 7.

Use the following steps to configure a Beacon segment:

  1. On the Whatfix Guidance dashboard, click Widgets.
    ia_left_nav_widgets

  2. Click Beacons.
    ia_widget_beacons

  1. In the Draft stage, hover your cursor over the auto-created segment, and then click the Edit icon.
    db_beacon_edit
Info

The Beacon collection that is attached is the newly published content.

  1. Expand the Set Visibility Rules section and configure your Visibility Rules that determine how the Beacon collection is displayed to the end user.
    RB_DB_beacon_setvisibilityrules
Note

For more information on the different conditions that can be used in Visibility Rules, see Visibility and display rule conditions.

  1. Click the When tab, and then select the number of times you want to show the Beacon.
    RB_DB_Whentab1
Note
  • You can also attach a Flow, Video, or Link to a Beacon.

  • To attach content to a Beacon, expand the attach content section, click Attach Content, and then select any content that you want to display to your users.
    attach content

  • The attached content is displayed based on the Disappearance of Beacon setting you configured while creating it.

  1. Click Save.
Info
  • The Beacon stops displaying once the end 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 segments need to be created for each individual page.
  • Subsequent changes to the Beacon collection do not update the corresponding segment.
  1. Once you are done creating the Beacon collection, select the segment, and then click Send to ready.
    clm_db_send_to_ready

  2. Go to the Ready stage and select the segment you want to move to the Production stage, and then click Push to production.
    clm_db_push_to_production

your title goes here

If you're using the JS Embed method to test or publish Whatfix content, add the relevant conditions in Map Stages. This ensures that the content appears in the correct instance. For more information, see How to add conditions in Map Stages? (Log in to see the article)


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.