Top

Create a Beacon

Prev Next

Note:

  • Whatfix evaluates only one Beacon Collection per page at any given time. To show two or more Beacons on the same page, create them as part of a single Collection.

  • Whatfix also enables you to display multiple Beacon Collections on the same page. To enable this feature, contact support@whatfix.com.

Whatfix enables you to create Beacons using the Whatfix Studio. Expand the following sections to learn how to create, configure, and manage Beacons:

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
  3. Enter a name for the Beacon Collection.
    Enter_Beacon_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.

  • Add a Display Name to keep internal naming conventions, such as region, release, or module codes, out of the labels that appear to your end users. Users then see the Display Name of the Beacon in shared PDFs and Exports. For more information, see Add a Display Name to Whatfix Content.
    The image shows the Collection Name and the Display Name, which can be set while creating content on the Studio.

  1. Click + Add Beacon to create a new Beacon.
    Add_Beacon

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

  3. 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. On Studio, enter the name of the Beacon.
    Enter_beaconname

Info

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

  1. In the CONFIGURATIONS tab, expand Interaction, and then, under the Disappear Beacon section, select the condition to stop displaying the Beacon.
    Disappear_Beacon

  2. Expand Appearance, under the Tooltip section, make the following changes:

  • Change the tip Color using the color picker or enter the hex code in the text box.

  • Customize the style, color, and size of the text of the Beacon Tooltip.
    Config_beaconappearance

  1. Under the Icon section, select the Type, Color, and Size of the icon.
    Configure_beaconicon

your title goes here

  • By default, Whatfix provides four types of icons for a Beacon, that is, Custom, Radial, Ripple, and Speckle.
    Beacon_type

  • Select the Custom icon to configure the Text of your Beacon.
    Custom_icon

  • You cannot change the size of the Custom icon.

  • Whatfix enables you to add custom icons for Beacons. To add custom icons, see Use custom icons for Beacon.

Note

Once you start selecting the element to place the Beacon, your cursor changes to the set Beacon style. Then, place the Beacon to any desired position.

  1. Expand Positioning and adjust the position of the Beacon.
     Beacon_position

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. Either use the navigational arrows or enter the value in the Movement on key click(px) dropdown to change the position by pixels.

  • Click the Lock icon to unlock and reposition the Beacon.
    Advanced_positioning

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

  1. Click Save Beacon.
    save beacon

your title goes here

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

  1. To save the Beacon collection, click Save Beacon.
    RB_beacon_clicksavebeacon

Note

  • Once you have created the Beacon collection, a Collection is automatically created on your Whatfix dashboard.

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

Info:

Edit a Beacon inside a Collection during the Beacon creation process. For more information, see Edit Beacons.

Step 2: Configure the Visibility Rules for the Beacon

  1. On the Whatfix Guidance dashboard, click Content.
    ia_left_nav_content

  2. Click Beacons.
    ia_left%20nav_beacons

  1. Hover your cursor over the Beacon collection you want to configure, and then click Edit.
    Image

  2. Click Collection Visibility.
    Image

  3. Expand Where does the beacons colection Rules appear? section, and configure URL and Page tags. For more information, see Set Where your Widget or Content appears.
    Image

  4. Expand When does the beacons collection Rules start and stop appearing? section, and configure configure when you want to start showing your widget. For more information, see Set When your Content appears
    Image

  5. Expand Who does the beacons collection Rules appear to? section, and configure who you want to show your content to. For more information, see Set Who can see your Widget.
    Image

  6. Click Save.
    Image

Note:

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)

Privacy Policy | Whatfix Glossary | Whatfix Platform Status
Copyright © 2024 WHATFIX TM. All rights reserved.