BLEep BMS User Manual

Revision Date Details
1.0 19 June 2014 Document Creation
1.1 17 Dec 2014 Updated
  • UI Updates
  • New functions updates

Table of Contents

2.0.   Features
2.1.Creating an account
2.2.Signing in
2.3.Forgot Password
2.4.Navigation
2.5.Applications
2.6.Applications > New Applications
2.7.Applications > BLEep API Key
2.8.Beacon Management > Manage Beacons
2.9.Beacon Management > Manage Beacons > Add Beacons
2.10.Beacon Management > Manage Beacons > Bulk Activate Beacons
2.11.Beacon Management > Manage Beacons
2.12.Manage Beacons > Adding Rules and Pairing Communication
2.13.Manage Beacons > Add Rules
2.14.Manage Beacons > Pair Communications
2.14.1.Manage Beacons > Add Communications
2.14.2.Manage Beacons > Alert
2.14.3.Manage Beacons > Image Advertisement
2.14.4.Manage Beacons > Audio
2.14.5.Manage Beacons > Video
2.14.6.Manage Beacons > Webview
2.14.7.Manage Beacons > URL
2.14.8.Manage Beacons > Launch
2.15.Manage Beacons > Edit/Delete Rules
2.16.Beacon Management > Manage Communication Type
2.16.1.Manage Communication Type > New Communication Type
2.17.Manage Beacons > Manage Maps
2.18.Analytics > Basic Analytics
2.18.1.Basic Analytics> Analytics
2.19.Analytics > History
2.20.Analytics > Maps
2.21.Company
2.21.1.Company > Edit Company
2.22.SDKs
2.23.User Settings


About BLEep BMS

BLEep Beacon Management System (BMS) is a web-based management tool which developers, media planners or basically anyone can utilize to manage app behavior with beacons.

Conventionally, an app owner must modify the source code in order to change the behavior of how the app interacts with beacons.

With BMS, an app owner is able to integrate the BLEep SDK easily by including the BMS API key which syncs up the app and BMS.
Through this enablement, an app owner does not need to re-upload the app to any stores after modifying the behavior nor edit the source code.


Features 
There are many features in BLEep BMS that users can take advantage of. Users can manage their apps and beacons from anywhere, anytime. BMS is mobile-responsive which grants you easy access to your data on any devices.

Creating an account
Users can create a 90 days free trial account in less than 30 seconds. User just need to enter the following details:

First name, Last name, Email, Password, Password confirmation, Company legal name, Company address, and Country.



Signing in

Users sign in with their e-mail address (keying it in the User ID field) and password they’ve set when creating an account.



Forgot Password


  1. Email
    1. Key in your Email address to reset your password.
  2. Submit/Cancel
    1. Click submit and BLEep we’ll send an email with instructions to reset your password.
    2. Cancel to discontinue.

Navigation



      
  1. Top Navigation
    1.  Purchase Beacons: This will direct you to our one-step order page.
    2.  User’s e-mail address:  bms_test@getbleep.com in this scenario). This will log you out if clicked on.
    3. Select Application: This function is useful for side navigation, including Beacon management and Analytics.
  1. Side Navigation
    1. Application: Set up, manage and edit your applications here.
    2. Beacon Management: Manage beacons, manage communication.
    3. Type and maps here.
      • Manage Beacons: Manage Beacon settings.
        • Add Beacons: Activate beacons.
        • Bulk Add Beacons: Activate beacons by uploading a CSV file. Sample CSV file can be downloaded from this page.
      • Manage Communication Type: Create new Communication Type.
      • Manage Maps: Upload and manage maps.
    4. Analytics: View analytics of your app's interactivity with your beacons here.
      • Basic Analytics:
        • Date Arrange Filter: Set up the length of days and time for your app's interactivity.
        • Logs: Data of total app's interactivity with your beacons.
      • History: Show history of analytics.
      • Maps: Show analytics on maps.
    5. Company: Manage and edit your company's profile here.
    6. SDKs: Retrieve the latest iOS and Android SDKs with release notes.
    7. User Settings: Manage and edit your settings here.


  1. Help:Throughout BMS, you will find valuable Help tool tips that will guide you.
  2.   Show [x] Entries: Display a number of entries (multiples of 5) to easily manage content comsumption.
  3.   Search: Search for anything relevant within that section.

Applications


  1.  New Applications: Click to set up and sync a new application with BMS.
  2.  Actions
    1. Edit App: Edit existing app.
    2. Delete App: Remove app to stop app and BMS relationship.

Applications > New Applications


  1. Key in your Package name/Bundle ID for the app.
  2. Update the time zone to the time zone you are in.
  3. Save to continue.

Applications > BLEep API Key

BLEep API Key

  1. A server generated API key will be provided after you’ve set up your app. Please use the API key given and implement it with the BLEep SDK.

Beacon Management > Manage Beacons

  1.  Add Beacons
    1. Activate beacons via a panel.
  2.  Bulk Add Beacons
    1. Activate multiple beacons by uploading a .csv file.

Beacon Management > Manage Beacons > Add Beacons


  1. Input information regarding your beacon.
    1. Assign a name to your beacon (tag).
    2. Please key in the UUID of your beacon.
    3. Followed by the Major number of your beacon
    4. Lastly, the Minor number of your beacon
    5. Determine the beacon's distance upper limit too. This is for the beacon itself, this is in case the range of the beacon is further than how you would actually like it to be.
  2. Activate/Cancel
    1. Activate to continue.
    2. Cancel to start over.

Beacon Management > Manage Beacons > Bulk Activate Beacons

  1. Choose a .csv file to upload.
  2. Upload.
  3. Sample format.
    1. Download a sample format.
    2. Please remove the first row of the .csv file(name uuid major minor) when you upload.
    3. Remember to convert it to a .csv file

Beacon Management > Manage Beacons

  1.  Edit Beacon
    1. Edit the name of your beacon (tag).
    2. Edit the UUID number.
    3. Edit the Major number
    4. Edit the Minor number
    5. Edit the beacon's distance upper limit
  2.  Delete Beacon
    1. Deleting beacon will also delete current rules and communication types.

Manage Beacons > Adding Rules and Pairing Communication

After activating your beacons, you'd need to add rules and determine how you want your app to interact with the beacon. Then after, pair a communication type which serves specific content when the app satisfies the rules that you've added.


Manage Beacons > Add Rules

  1. Add Rules
  2. Explanation of the rules
Distance upper limit
  • Number (decimals allowed) in meters.
  • Not applied if left blank or set to zero.
  • Specifies the upper bound of the distance range that will trigger detection.
Distance lower limit
  • Number (decimals allowed) in meters.
  • Not applied if left blank or set to zero.
  • Specifies the lower bound of the distance range that will trigger detection.
Time interval
  • Integer (seconds)
  • Before beacon is treated as new and triggers detection behaviour again
  • It’s the time interval after which the phone will treat the beacon as new. It is to ensure the phone doesn’t keep responding to the same beacon.
  • For instance, certain users want their beacons to have an interval time of a day. If the last time the phone responded to that beacon was less than 24hrs ago, nothing will happen.
  • If it’s more than 24 hrs, it’ll be as if the phone is seeing the beacon for the first time, so it’ll respond with the determined communication type. e.g. an alert.
Time Duration
  • How long this beacon has been in range before triggering this specific behaviour.
  • If left blank or set to zero, triggers immediately.
Event Type
  • Three types of Event Type
  • Entry: Triggers behavior when beacons enter range
  • Continuous: Triggers behavior repeatedly while beacon is within range.
  • Exit: Triggers behavior when beacons goes out of range (The app will execute the exit with the longest time duration if multiple exits with the same communication type for the same beacon are triggered at the same time).
Date Range
  • Current date must be between start and end date for trigger to work.
  • Local date on phone will be used as current date (to allow instant triggering without internet connection).
  • Requires SDK version 1.6 and above.
Days
  • Current day must be ticked for trigger to work
  • Local day on phone will be used as current day (to allow instant triggering without internet connection).
  • Requires SDK version 1.6 and above.
Time Range
  • Current time must be between start and end time for tigger to work.
  • If start time is later than end time, it will be considered overnight. E.g. 11pm-1am with only Fri ticked will be triggered between 11pm and midnight on Friday and between midnight and 1am on Saturday.
  • Local time on phone will be used as current time (to allow instant triggering without internet connection).
  • Requires SDK version 1.6 and above.
Live Response Type
  • If trigger is live, the phone needs to be connected to the internet upon beacon detection to:
    1. Retrieve the latest communication details from the server;
    2. Check the current time from server against the scheduling conditions this ensures that the response is up to date and that users cannot fake their phone time to trigger beacon actions outside their defined schedule.
  • If trigger is static, phones can respond to beacons using pre-downloaded content without internet connection (except to download media that is not stored in the phone and has not previously been cached).
  • Please note that this feature is currently being offered on a free trial but will likely be a paid feature later.
  1. Create Rules/Cancel
    1. Create rules to confirm the rules you've set for how the app interacts with the beacon.
    2. Cancel to restart

Manage Beacons > Pair Communications

You can only pair a communication type after adding rules.


Manage Beacons > Add Communications


Clicking on Add Communication will bring you to the page below.


Explanation of each of the different tabs:

Alert
  • The alert communication type serves as an alert when your app is in the foreground or a push notification when your app is in the background.
Image Advertisement
  • The image advertisement type serves an image to the phone when triggered.
Audio
  • This will get your phone to start streaming audio from the internet.
Video
  • This will get your phone to start streaming video from the internet.
Web
  • This will get your phone to open a webpage.
URL
  • This will get your phone to open a URL, not necessarily a webpage (you should use Web type for that). For instance, it can open YouTube links in the app if the user has it installed. This is a simplified version of Launch type.
Launch
  • This will get your phone to execute complex commands by using apple URL actions and Android intents. For instance it can dial a number, start composing an SMS to a number, open Google Maps to search for user input, etc.
Manage Beacons > Alert


 

 The Alert communication type serves an alert when your app is in the foreground or a push notification when your app is in the background. The Title and Message, plus overhead are counted in the byte limit. If your content plus overhead exceeds the byte limit, you will be warned that your message will be truncated.

  1. Title
    1. Determine the title of your alert.
  2. Message
    1. Determine the message of this communication type.
  3. Preview
    1. You see a preview of your alert to have an idea what you’ll be serving to your users.
  4. Confirm
    1. Click to confirm and continue.

Manage Beacons > Image Advertisement


 The image advertisement communication type serves an image to the client (mobile device) when triggered.

  1. Upload Image OR Image URL
    1. Please upload images that are .jpg and .png. OR upload by Image URL.
  2. Image mode
    1. Keep aspect, cover full screen.
    2. Keep aspect, show black space if extra.
    3. Don’t keep aspect, stretch to cover screen.
  3. Preview
    1. Preview how your image is shown on 5 mobile devices of different resolution.
  4. Confirm
    1. Click to confirm and continue.
Manage Beacons > Audio



 The Audio type communication will get your phone to start streaming audio from the internet.

  1. URL
    1. Enter URL to the audio file here.
  2. Notification message
    1. Shown if app is not in the foreground when triggered.
  3. Communication attributes
    1. For advanced users who wishes to fine tune the attributes of their communication
  4. Confirm
    1. Click to confirm and continue.

Manage Beacons > Video


The video type communication will get your phone to start streaming video from the internet.

  1. URL
    1. Enter URL to the video file here.
  2. Notification message
    1. Shown if app is not in the foreground when triggered.
  3. Communication attributes
    1. For advanced users who wishes to fine tune the attributes of their communication
  4. Confirm
    1. Click to confirm and continue.

Manage Beacons > Webview


The Webview type communication will get your phone to open a webpage from the internet.

  1. URL
    1. Enter URL to the webpage here.
  2. Notification message
    1. Shown if app is not in the foreground when triggered.
  3. Communication attributes
    1. For advanced users who wishes to fine tune the attributes of their communication
  4. Confirm
    1. Click to confirm and continue.

Manage Beacons > URL



The URL type communication will get your phone to open a URL, not necessarily a webpage (you should use Web type for that). For instance, it can open YouTube links in the YouTube app if the user has it installed. This is a simplified version of Launch type.

  1. URL
    1. Enter URL here.
  2. Confirmation Message
    1. Enter text here to ask user if he/she wants to execute the action.
  3. Failure Message
    1. Enter text here to show when the action fails.
  4. Communication Attributes
    1. For advanced users who wishes to fine tune the attributes of their communication.
  5. Confirm
    1. Click to confirm and continue.

Manage Beacon > Launch




The Launch type communication will get your phone to execute complex commands by using Apple URL actions and Android intents. For instance, it can open Mail, dial a number, start composing an SMS to a number, open Google Maps to search for user input, etc.

  1. Presets
    1. Select the different kinds of preset that you want.
      1. YouTube
      2. Dial number
      3. SMS
      4. Search Maps
  2. iOS: URL action
    1. For advanced iOS users who are familiar with programming, they can customize their own URL & actions with more specific features.
  3. Android: Intent Action
    1. For advanced Android users who are familiar with programming, they can customize their own actions with more specific features.
  4. Android: Intent URL
    1. For advanced Android users who are familiar with programming, they can customize their own URL with more specific features.
  5. Android: Intent Extras
    1. For advanced Android users who are familiar with programming, they can customize their own additional features.
  6. Confirmation Message
    1. Enter text here to ask user if he/she wants to execute the action.
  7. Failure Message
    1. Enter text here to show when the action fails.
  8. Communication Attributes
    1. For advanced users who wishes to fine tune the attributes of their communication.
  9. Confirm
    1. Click to confirm and continue.

Manage Beacons > Edit/Delete Rules



  1. Edit Rules / Delete Rules
    1. Edit rules will bring you back to App Rules Management page where you can change the rules of how the app interact with the beacon.
    2. Delete rules will delete current rules associate with how the app interact with the beacon.
    3. Deleting rules will also delete current communication types.
Beacon Management > Manage Communication Type


This page gives you the overview of all the communication types.

Alert The Alert communication type serves an alert when your app is in the foreground or a push notification when your app is in the background.
Image Advertisement The Image advertisement type serves an image to the phone when triggered.
Audio This will get your phone to start streaming audio from the internet.
Video This will get your phone to start streaming video from the internet.
Web This will get your phone to open a webpage.
URL This will get your phone to open a URL, not necessarily a webpage (you should use Web type for that). For instance, it can open youtube links in the youtube app if the user has it installed. This is a simplified version of Launch type.
Launch This will get your phone to execute complex commands by using Apple URL actions and Android intents. For instance, it can open Mail, dial a number, start composing an SMS to a number, open Google Maps to search for user input, etc.
Launch Your custom type.
URL Your custom type.
Manage Communication Type > New Communication Type


Set up your new communication type here.

  1. Type Name:
    1. Enter your Communication type name.
  2. Key:
    1. Enter your key here.
  3. Value:
    1. Choose your value type here from:
      1. String
      2. Number
      3. Boolean
  4.  Click this button to remove the entire Key.
  5.  Click this button to add Key.
  6.  Confirm/Exit
    1. Clicking confirm saves and confirms the data entry you made.
    2. Clicking cancel removes the data entry you made and brings you back to Manage Communication Type page.
Manage Beacons > Manage Maps



Upload maps the manage your Beacons. Click on the maps you've uploaded to plot beacon location.



Analytics > Basic Analytics



Basic Analytics > Analytics




  1. Date Range
  2. Select start date and end date to filter out analytics according to those dates.
  1. Time Range
  2. Select start time and end time to filter out analytics according to those timings.
  1. Filter
  2. Click filter to filter out the selected date and time range
  1. Logs

    1. Beacon name(tag)
    2. User
    3. Tiime In
    4. Time Out
    5. OS
    6. SDK Version
    7. Device Info
  1. Total Visits

Total amount times the app detected the beacon

  1. Average Dwell Time

Average time of app dwelling within the proximity of the beacon.

  1. Export Report
  2.  Export reports via .pdf OR .csv file.
Analytics > History

A detailed history log of your Beacon activities.

  1. You can set the Start date & End date range (a popup calendar will appear for easier selection).
  2.  Pressing the filter button will filter out data from outside the date range.

Analytics > Maps



A display of the maps and locations of the beacons that you have set.


Company
  1. Company
  1. See your company's profile at a glance.
    1. Company Legal name which you created during registration
    2. Company adddress which you created during registration
    3. Date created
  1. Actions
  1. Edit company to change your company’s profile.

Company > Edit Company



  1. Company Legal Name
    1. Edit your company's legal name.
  2. Company Address
    1. Edit your company's legal address
  3. Website Address
    1. Edit your company's website address.
  4. Country of Registration
    1. Edit the company's country of registration.
  5. Invoicing Contact Name
    1. Edit the maanger in charge of payment for BMS.
  6. Invoicing Address
    1. Edit the billing address.
  7. Invoicing Email
    1. Edit the email address that you will prefer to receive invoices to.

SDKs



  1. BLEep SDK for iOS
    1. Download the BLEep SDK for iOS package which includes;
    2. BLEep iOS SDK.
    3. BLEep iOS and Android integration guide.
    4. BLEep iOS sample apps.
    5. BLEep API documentation.
  2. BLEep SDK for Android.
    1. Download the BLEep SDK for Android package which includes;
    2. BLEep Android SDK.
    3. BLEep iOS and Android integration guide.
    4. BLEep Android sample apps.
    5. BLEep API documentation.
  3. All iOS Releases.
    1. Release notes are provided to give users an update on the improvements we’ve done to the BLEep SDK.
  4. All Android Release.
    1. Release notes are provided to give users an update on the improvements we’ve done to the BLEep SDK.

User Settings




  1. User Name
    1. Email Address which you’ve used to registered with.
  2. First Name
    1. Please input your first name.
  3. Last Name
    1. Please input your last name.
  4. New Password
    1. Input your new password should you wish to change it.
  5. Password Confirmation
    1. Confirm your new password by inputting it again.
  6. Confirm Current password
    1. Input current password to prove authenticity.
  7. Update
    1. Click to save and continue

Feedback and Knowledge Base