Welcome

Welcome to the Apsima Dashboard User Guide.

Your touch-point for all Apsima dashboard configuration.  Whether you are a developer, marketer, or mobile product manager, you will use our Apsima web dashboard at some point for one or more of the following:

Create, schedule, and send notifications

Segment users based on user profiles

Configure geo-fencing and proximity based beacon groups

 Monitor mobile payments

Access and analyze app engagement metrics

Manage account settings

If you are new to Apsima, this user guide will help you navigate your way around. If by chance you don’t find what you are looking for, don’t hesitate to call or email us directly with your inquiry and we will get back to you right away.

 

We also provide YouTube videos as an additional resource, giving you a more comprehensive look into how to use the Apsima web dashboard and all its features. Visit our YouTube Channel:https://www.youtube.com/getapsima

Back To Top

Getting Started

Login to Apsima Dashboard

    1. To access the Apsima portal, open a web browser to:

http://dashboard.apsima.com

    1. You will be directed to the login screen. Enter your login credentials to continue.

apsima_Login

  1. Once you have logged in, you will see several tabs on the top of the screen including:
  1. Application
  2. Users
  3. Geofences
  4. Proximity
  5. Templates
  6. Notification
  7. Payments

 We will explain each of these in greater detail throughout the user guide.

  1. In the upper right corner, you will see the current logged in user listed.

tabs

Under this menu, you have the options to:

  1. Change your password
  2. Log out

Back To Top

Application

Application Tab

The application tab is used to monitor the different aspects of your application. Within the application tab you will find the following four sections: General, API, User Properties, and Metrics.

Back To Top

General

The general section shows the configuration settings for the application itself. These include the following:

application_general

  1. App Hardware ID: ID used as the Proximity UUID for all beacons used for this application – this value is automatically generated once and cannot be changed.
  2. Notification Callback URL: Any time a notification is sent, a Post http request is also made to this callback URL.  If this is unchecked, no http request is made.
  3. Beacon Callback URL: Any time a beacon is triggered, a Post http request is also made to this callback URL.  If this is unchecked, no http request is made.
  4. Admin Email Address: Reply email address for any emails sent to users.
  5. Change Password URL: This URL is used in the forget password (generate temporary password) email that is sent to the user.  The user will have the opportunity to click on this link to go to some web site which should allow him to login using the temp password and change his current password.

Back To Top

API

The API section is used for Application specific settings. These include notification services for Apple and Google services, as well as API keys. You will get Apsima specific settings from Apsima when you sign up for the service. To configure the Apple and Google settings, you must already have signed up with the Apple Push Notification Service (APN), or the Google Cloud Messaging service. These configuration values will need to be retrieved from your application that has been submitted to either the Google Play store, or the iTunes App store.

application_api

Apple Push Notification Service

You will need to get the following information from your Application Dashboard on the iTunes App Store:

  • App Name
  • Password
  • Certificate (If required)

 

Google Cloud Messaging

For the Google Cloud Messaging service, you will need the following information:

  • Project Number
  • App Key
  • Package

 

Domain Key

This is used to identify the domain with the Apsima backend. This will be assigned to you when you sign up for the Apsima service.

Back To Top

User Properties

The user properties section is used to define custom user properties for selecting an audience for segmentation. These can be defined for any kind of attribute to further refine your customer base.

application_user_properties_new

  1. To create a new Custom Property, click the new custom property button.
  2. Enter a Property name and a description.
  3. For Data type, you can select the following:
      1. Choice: This allows a user to choose from a predetermined set of variables. You add these using the Plus icon.

    application_user_properties_edit

    1. Text: Use this value for any property that will only include text (city, zip code, etc.)
    2. Integer: You can use this to define a range of whole number numerical values.
    3. Float:  Similar to integer, float can be used to define a numerical range that includes decimal places for a much more precise usage.
    4. Date: Use this to define a date range.

Back To Top

Metrics

The Metrics tab will help you monitor the effectiveness of your mobile campaigns.  This overview gives you a quick glance into overall audience engagement over a specified period, whether it be day, week, or month, depending on your preferences.  Here you will find analytical measures of the application, including but not limited to the following:

  • Application opens
  • New Application opens
  • New Users
  • Total Time in App
  • Notifications Sent
  • Total Payments
  • Average time spent in the application
  • Mobile Users per Platform
  • Etc.

application_metrics

Back To Top

Users

Users Tab

The users tab is used for managing the individual users of the application. You can display single or multiple users based on the filters that you set. You can filter on different tags that are setup for those users and your application. You can also send notifications to individuals or groups of users based on pre-existing templates, or you can create new ones as needed.

users_tab

The users tab consists of a listing of users, and filters, known as tags, that can be applied to those users to display users based on the tags that you define. This makes it easier to find specific users when the total number could be in the thousands.

Tags provide advanced user segmentation to select an audience, and can be saved to use again.

Back To Top

Tag Search/Saving a Custom Tag Filter

In order to create a new tag search, you can filter on existing fields or select user options to refine your search. By using user options, you can search for the users that you want, based on custom fields that have previously been created.

    1. To create a new tag, enter the search information that you want to search on. Once you have finished adding fields to the search, click the save button. You have the option to add additional, predefined search options by clicking the more button. Any user custom fields that have been created will display here. You can enable any custom fields by putting a check in the box.users_tab_search

 

    1. Once you have added the custom search option, you can define each option by clicking the option name, and entering search data based on the type of option.

users_tab_search2

    1. When you have finished entering all the search information, you can save your search. Click on Save, and a dialog box will appear that will let you name the search. Give your search a name, and click save.

users_tab_search3

    1. Once the search has been saved, you can access it in the future by clicking All, and scrolling down to your custom search.

users_tab_search4

    1. Deleting a search: To delete the search, first select the custom search from the dropdown, then click delete from the dropdown to the right of the custom search.
      users_tab_delete_search

 

  1. To send a notification that has previously setup, you can click the “Send notification” button in the upper right corner. This will open the send notification dialog box which is covered in the Notifications section later in this document.

Back To Top

Geofences

Geofences Tab

Geofencing allows you to specify the location of the property, which will enable the property to appear when the client device is within the pre-determined location to enable client-side functions. This is a required configuration step in order to make a location active in the system.

    1. To begin, click the New Geofence button on the upper right side of the page. The New Geofence window will open.
    2. Enter a name for the Geofence. This will be used for the specific site, so it is recommended that you name it something relevant to the site.
    3. Select the Geofence type, which defines the style of the Geofence. You have the following choices:
        1. Radial: This creates a radial Geofence using the location defined, and a radius that is set.

      geofences_Tab_new1

      1. Polygonal: This lets you place points on the map, and create a more defined Geofence. This type is good for properties that have irregular shapes that would not be properly represented by a radial Geofence.

geofences_Tab_new2

  1. Once you have defined your Geofence, you can click create. This will enter your information into the system. Once the Geofence has been entered, you can click the edit button to edit the location or Geofence type, or delete to remove the Geofence from the system.

Back To Top

Proximity

Proximity Tab

The proximity tab is for setting up and administrating beacons, or location based notifications to a mobile device.

    1. To begin, you must create a group. Click the add icon next to the All Groups listing on the left.

proximity_tab_new1

    1. This will open the new group dialog box. Give the Group a name, and a description, and click Create.

proximity_tab_new2

    1. Next, click the new Beacon button on the upper right corner.

proximity_tab_new3

    1. This will open the new beacon dialog box.

proximity_tab_new4

  1. You have the following options:
    1. Beacon Name: This is for the Name of your particular beacon, e.g., Front door, rear display, etc.
    2. ID: This is the ID of the beacon itself, which is individual to the beacon.
    3. Latitude and Longitude: This is the physical location of the beacon, which will be determined by software. You normally will not need to enter this data manually.
    4. Activity: This is to enable or disable the specific beacon.
    5. Groups: This is to add the beacon to a Group. The existing groups will auto populate this field when you begin to type.
    6. User Info: This is a field for custom developer entries, and should not be modified unless given specific information to populate this field. Adding anything to this field could cause your beacon to not function properly.
  2. Once you have entered all the information for the beacon, click the Create button. The beacon will now be added to the specified group, and its status will be shown in the Proximity tab listing.

Back To Top

Templates

Templates Tab

Templates are used to define an announcement that can be sent to the client, such as coupons, or a notification. Templates can contain images and text, and also support HTML markup.

    1. To begin template creation, click the new template button. This will open the new template dialog box.

templates_tab_create1

    1. Start with the general tab: Give the template a name, and a description. You can also choose to upload an image by clicking the choose image button.
    2. Next, you can click the Design tab. This tab has a preview section, as well as a Content section. You can paste your HTML in the content section, and format the code, or preview the code in the preview window.

templates_tab_design

  1. Once you are satisfied with your template, you can click the create button, and your template will be saved.
  2. The templates you have saved will be listed in the Templates tab. You can edit, delete, or create a new notification from any saved template by clicking the buttons to the right of the template name.

Back To Top

Notifications

Notifications Tab

The notifications tab is where you create and manage current and future notifications for the property. The notification will be listed by title, description, active date, expiration date, current status, the keywords that have been selected, and the platforms that are supported.

You can also view the engagement metrics for each individual notification sent by clicking the eye icon that appears to the right of platforms by scrolling your mouse.

notifications_tab_metrics

 

    1. To create a new notification, click the new notification button.

notifications_tab_create

    1. The New notification dialog box will open.

notifications_tab_dialog

  1. You have the following options when you create a new notification
    1. Use this template for this notification. You can select the template to use for this notification.
    2. Target these platforms for this notification. You can specify to send this to iOS or Android devices, or both.
    3. Reach users using any/all the following tags. This is how you select the users to which you will be sending the notification to. You can use a combination of Tags if needed.
    4. Use this trigger to send notification Now/Scheduling/Geofencing/Proximity. This is what will activate the notification to be sent. The following section describes the different triggers.
        1. Now. Once you click the create button it will be processed and sent immediately.

      notification_tab_create_click

        1. Scheduling. This allows you to set the date and time in which to send the notification. You can set the date and time via the pull-down menu.

      notifications_tab_scheduling

        1. Geofencing. When Geofencing is selected, the pre-defined Geofences are used as the trigger. The notification will be sent when the client app enters or leaves any of the entered Geofence areas.

      notifications_tab_geofencing

        1. Proximity: A client device coming within range of a beacon that has been defined in one of the entered proximity groups will trigger the notification to be sent to that device. Proximity only works with proximity groups that have been pre-defined.

      notifications_tab_proximity

    5. Notification is Valid: This is used to set the validity period of the notification. You can set the start and end time you would like this notification to be active.
    6. Call global notification callback URL: If you check this box, when the notification is sent, a POST HTTP request is made to the callback URL which has been defined in the General settings.

Back To Top

Payments

Payments Tab

The payments tab is used to list the pending and processed payments from the application. You can sort via the processed time using a specified date or date range, Status, or a specified search.

payments_tab

  1. To search, you can use one of the following drop-down options.
      1. Processed Time: You can search via specific time frames, such as within the last month, or between a date range. You can clear the search and list all payments by clicking the “Clear All” link.

    payments_tab_search

    1. Status: You can search using the status of the payment. You can search using the three types of status, Pending, Processed, or Voided.
    2. You can also perform a search for the Order ID, or any other field by using the search box. To clear your search, click the “Show all” link.