Beacons

Overview

Beacons are Bluetooth devices placed within a store or restaurant, that can detect nearby consumer smartphones and send them media such as offers, discounts, and special offers. The Beacons screen is used to manage information regarding beacons deployed throughout your locations.

Access

To access the Beacons screen, select Data from the Main Navigation Menu, then select Locations > Beacons from the Sub-Category menu.

Features

Working with Beacons

The Beacons screen provides the following features:

 Searching and Sorting

Click hereClick here

The Beacons screen provides a variety of options for searching for Beacons.

Search

The search feature allows you to search for a specified text string anywhere within a wide range of Beacon attributes.

  1. Optionally, in the search field near the top of the Beacons screen, enter the desired text string.

  2. Press Enter, or click the search button (magnifying glass icon).

  3. The Beacons screen is refreshed to show only the Beacons that meet your search criteria.

  4. To remove all search criteria, click the remove button ("X" icon).

Sort

The "Sort" drop-down menu allows you to sort the Beacons on a variety of different fields. To sort the list of Beacons, select the desired sort option from this menu.

  • Beacon ID (default)

  • Name

  • Created Date

  • Updated Date

 

 

 Create a New Beacon

Click hereClick here

To create a new Beacon:

  1. Enter the Display Name value for the new Beacon.

  2. Click create to display the Update New Beacon pop-up window.

  3. The "Display Name" field is populated with the value you entered above; optionally edit this value.

  4. The Internal Name is automatically populated based on the Display Name value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  5. Enter the following:

  • UUID: Enter the Universally Unique Identifier for the Beacon. The UUID is a standard identifying system which allows a unique number to be generated for a Beacon's manufacturer, application, or owner. The UUID value contains 32 hexadecimal digits, split into 5 groups, separated by hyphens.

  • Major: Enter the Major value for the Beacon. Major values are intended to identify and distinguish a group of Beacons. For example, all beacons in on a certain floor or room in a location could be assigned a unique Major value.

  • Minor: Enter the Minor value for the Beacon. Minor values are intended to identify and distinguish an individual Beacon within a group of Beacons assigned the same Major value.

  1. Click create.  

 

 

 View or Edit a Beacon

Click hereClick here

To view or edit the details of a Beacon:

  1. Search, sort, or filter the Beacons screen as described above.

  2. Click on the desired Beacon record. The "Edit Beacon" pop-up window is displayed.

  3. Make any necessary changes to the Beacon properties.

  4. Click save.

 

 

 Delete a Beacon

Click hereClick here

To delete a Beacon:

  1. Search, sort, or filter the Beacons screen as described above.

  2. Click on the desired Beacon record. The "Edit Beacon" pop-up window is displayed.

  3. Click delete.

  4. A confirmation dialog box is displayed; click confirm.  

 

Exporting Beacon Data

The Beacons screen provides the following features related to exporting Beacon records.

 Create Export Definition

Click hereClick here

Export definitions can optionally be saved and reused, when you need to download Beacon records from EDP:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Export Beacons." The "Create New Export - Beacons" pop-up window is displayed.

Info section

  1. In the "Display Name" field, enter a name for the export file.

  2. The "Internal Name" is automatically populated based on the "Display Name" value. This field is uneditable by default. To edit the Internal Name, check the "Edit Internal Name" check box. A confirmation dialog box is displayed; click ok. Edit the Internal Name value

  3. In the "Description" field, enter a description of the export file.

  4. Select a column separator -- comma or semicolon.

Timing section

  1. Select when you want to execute the export:

  • Asynchronous -- if you check this option, you'll have the ability to enter one or more recipients to receive the export by email.

  • Execute now -- check this option if you want to execute the export immediately.

  • Create schedule -- check this option if you want to define a schedule (either a one-off execution, or a recurring schedule).

  1. If you checked "Create schedule" above, the schedule options are displayed.

Define Export ScheduleDefine Export Schedule

To define the export schedule:

    1. From the "Recurrence" drop-down menu, select an option:

    • Repeat -- Execute the export based on the defined schedule; see below for more details.

    • Once -- Execute the export once. In the "Execute once on" field, enter the date and time. Select the time zone from the "Time Zone" drop-down menu.

    • On demand -- Execute the export when manually specified by a user.  

Define a Repeating Schedule

    1. From the "Schedule Composer" drop-down menu, select a unit of time -- every minute, hour, day, week, month, or year.

    2. Optionally, check "Advanced" to enable the "CRON expression" text field, and enter a custom CRON expression.

    3. In the "From" and "To" field, enter the start date and time, and the end date and time, for the repeating schedule.

    4. From the "Time Zone" drop-down menu, select the time zone to use.

 

Notification and Transport section

If you checked "Asynchronous" above, this section is displayed.

  1. In the "Success Email Recipients" text field, enter one or more email addresses for recipients to receive a "success" notification.

  2. In the "Error Email Recipients" text field, enter one or more email addresses for recipients to receive an "error" notification.

Fields section

This section allows you to optionally include (or exclude) specific columns in the export file.

  1. From the "Inclusion" drop-down menu, select an option:

  • All -- include all columns in the export file.

  • Only Selected-- in the "Fields" field, select one or more columns you want to export, in the sequence you want them appear in the export file.

  • Except Selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

Rules section

This section allows you to create custom business rules to define which order records are included in the export file.

  1. To add a rule, click the plus-sign icon, and select "Add Rule."

  2. From the first drop-down menu, select the desired field.

  3. From the second drop-down menu, select a mathematical operator.

  4. In the text field, enter the desired value.

  5. If you define multiple rules, select the logical operator connecting the rules: From the "Include customers that meet" drop-down menu above the list of Rules, select either:

  • All of the following (i.e., an AND operator)

  • Some of the following (i.e., an OR operator)

To remove a Rule, click the delete icon next to it. To remove all Rules, click reset.

Finish

  1. When finished defining the export, click save.

 

 

View or Edit an Export Definition

Click hereClick here

To view or edit an Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Beacons Exports." The "Beacons Export Definitions" pop-up window is displayed and populated with a list of all Beacon Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Edit icon. The "Edit Export" pop-up window is displayed.

  3. Make any necessary changes to the Export Definition properties.

  4. When finished, click save.

 

 

 Manually Execute an Export Definition

Click hereClick here

To manually execute an Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Beacons Exports." The "Beacons Export Definitions" pop-up window is displayed and populated with a list of all Beacon Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Enqueue this Export icon. A confirmation dialog box is displayed.

  3. Click confirm.

 

 

 Download an Export Definition

Click hereClick here

To download the last execution of an Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Beacons Exports." The "Beacons Export Definitions" pop-up window is displayed and populated with a list of all Beacon Export Definitions.

  2. In the "Action" column of the desired Export Definition, click the Download File icon. The platform downloads the file to your PC.

 

 

 Delete an Export Definition

Click hereClick here

To delete an Export Definition:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Beacons Exports." The "Beacons Export Definitions" pop-up window is displayed and populated with a list of all Beacon Export Definitions.

  2. From the "Action" column of the desired Export Definition, click the Delete icon. A confirmation dialog box is displayed.

  3. Click confirm.

 

Import Beacon Data

The Beacons screen provides the following features related to importing Beacon records.

 Import Beacons

Click hereClick here

To import Beacon records:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Import Beacons." The "Create New Import - Beacon" pop-up window is displayed.

  2. From the "Import Method" drop-down menu, identify how you want the platform to handle the import records:

  • Insert data, or update if duplicate: Create new records and update existing records

  • Insert data, or skip if duplicate: Create new records only (don't update existing records)

  • Update data, or skip insert: Update existing records only (don't create new records)

  1. In the "Find Options" field, select one or more fields used to identify existing records in the database. The default field is "name."

  2. If you want to import blank values, select the "Yes" radio button next to "Include Blank Values."

  3. The platform supports email and phone number syntax validation on the appropriate import fields. To run this validation, select the "Yes" radio button next to "Validate Records."

  4. If you account is configured with business units, select the desired Business Unit from the "Business Unit" drop-down menu.

  5. To send email notifications following a successful import, enter one or more recipient email addresses in the "Success Import Email Recipients" field.

  6. To send email notifications following a failed import process, enter one or more recipient email addresses in the "Failed Import Email Recipients" field.

  7. To select the import file, click choose file, then browse to and select the desired file.

  8. Select a column separator: Comma or Semicolon.

Import Options

To configure additional import options:

  1. Click add options.

  2. To use a lookup table, select the desired table from the "Lookup table" drop-down menu.

  3. From the "Lookup column" drop-down menu, select the desired column on the lookup table.

  4. Enter a value in the "Rename as" field.

  5. In the "Find by columns" field, select one or more columns used to identify existing records in the database.

  6. If the lookup table is required, select the "Yes" radio button next to "Required."

  7. If you want to stop the import process if a duplicate record is found, select the "Yes" radio button next to "Abort on Duplicate Record."

  8. Optionally enter an expression in the "Condition" field.

Finish

  1. When finished, click submit.

 

 

 View Beacon Imports

Click hereClick here

To view a list of previous Beacon imports:

  1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Beacons Import List." The "Beacons Import List" pop-up window is displayed and populated with a list of all previous Beacon imports. For each import, the screen displays the following:

  • Imported by

  • Filename

  • Result (i.e., the number of records successfully imported, the number of failed records, and the number of skipped records)

  • Created at

  • Duration

  • Status

 

 

 Back to Locations Overview

Last Updated: April 2022