Dashboard Overview

The Dashboard is what we call the navigational and informational views of your Reach Projects. There are two levels:

  1. All your projects, listed at reach.urbanairship.com/projects. See Your Projects.

  2. An individual project, after you’ve opened it from the list of all your projects. See Reach Dashboard.

Your Projects

The top-level is a list of all your projects.

Each project’s pane displays its name and an icon indicating its type.

Click Getting Started Guide from right side of the page to reveal links to documentation. Click again to hide it.

When logged in to reach.urbanairship.com, you can return to Your Projects by clicking the Urban Airship logo or the Projects button in the left side of the navigational header.

Open an existing project by clicking its pane. Click either New Project button to create a new project. See Design Passes.

Reach Dashboard

When you open a project from your list of projects, you are taken to the Reach Dashboard, where you can configure the project, create passes, set up triggers, view activity reports, and more.

The primary view displays several metrics tracking the usage statistics of your passes, including a current snapshot of the number of passes that have been created, added, and removed in the history of this project.

  • Passes Created: The pass has been created, but has not yet been added or deleted.

  • Passes Added: The pass has been installed by the end user, and has not been removed or deleted.

  • Passes Removed: The pass has been removed by the end user, and not deleted.

These metrics reflect the current count of passes rather than net pass activity. For example, if a user adds a pass, then removes the same pass, then adds the pass again, the Passes Added count increases by one, while the Passes Removed count stays constant.

The Created metric only tracks Apple Wallet users.

Beneath the pass statistics is a per template breakdown of the same metrics.

The sum of each column equals the Project’s totals above. Click a template name to open its Activity Report.

Dashboard Menus

The project navigational header has four menus. Click to select.

  • Templates are the basis of the visual drag-and-drop interface of the Reach template editor, and they control the layout of Fields. A project can have multiple templates.

  • Reports show activity per template.

  • Triggers let you display content based on location or date.

  • Settings has your project and barcode details, and Associated App IDs.

Click Dashboard to return to the primary view.

Templates

The Templates in your current project are listed on left side menu. Click a template name to select.

If you’d like to create an additional template or change the content in the selected template, click the New Template or Edit Design button, respectively, then follow the steps in Create Templates.

The Basic Details pane displays the Template Description, Template ID, Custom ID, and creation date. Click the pencil icon to access the Template Settings.

The Expiration Details pane displays when an Apple Wallet pass will expire. These settings can prevent the accumulation of stale passes in your end users’ wallets. Click the pencil icon to Edit Pass Expiry.

Actions

Click to select from the Actions dropdown menu.

  • Sync Changes applies template changes to Apple Wallet passes that have already been distributed. See Sync Changes.

  • Batch Importer is used to generate pass URLs. See CSV Batch Importer.

  • Delete will remove the template from the project. Before the template can be deleted, you must expire or delete all passes associated with the template.

Sync Changes

While manual syncing is not supported for Android Pay, Android Pay passes will automatically sync any changes made to class fields. For a full list of class fields, please visit the Android documentation. Any field preceded by class constitutes a class field.

Apply template design changes to Apple Wallet passes that have already been distributed. Sync changes apply to:

  • Images

  • Logo text

  • Colors

  • Back of pass fields

With the exception of logo text, any changes made to fields on the front of the pass will not be applied to currently distributed passes.

The number of passes that will be updated by the sync is listed at the top of the Status section.

Click the Confirm & Sync Now button to apply template changes.

The status indicator will update to Sync in Progress. You will receive an email once the syncing process has completed, and the status indicator will update to Sync Successful.

Below the Status section, is the History of template sync attempts.

  • Sync Start Date is when the template syncing process was initialized.

  • Sync End Date is when the template syncing process ended.

  • Sync Status displays Successful or Error, depending on the outcome of the sync.

Template Settings

Make edits to any section, then click the Save Changes button, or Cancel to discard.

  • Basic Details lists your Template Name and Description.

  • Set a Custom Template ID displays the template’s auto-generated Default ID. Check the box to use a Custom ID that will override the Default ID, and enter your Custom ID in the field that appears.

  • Branch Integration enables you to create a deep link for a mobile customer that either links to his or her application, or as a fallback to a wallet pass. Talk to your sales representative for more information. Check the box to enable Branch Integration, and enter your Branch API Key in the field that appears.

Edit Pass Expiry

This feature is currently only available for Apple Wallet.

Control when a pass will expire. All passes generated from this template will expire according to the settings here.

Passes with no expiration set will expire according to a pass type defaults:

  • Boarding Pass/Event Ticket: Expires 30 days after pass creation.

  • Coupon: Expires 365 days after pass creation.

  • Loyalty/Member/Generic/Gift Card: Expires 730 days after pass creation.

Trial accounts can access this feature, but the account expiration override any expiry value that extends beyond the account expiration date.

  1. Click the pencil icon next to Expiration Details.


  2. Select the radio button for the desired expiration setting.

    Specify date: Set the date when passes generated from this template will expire.


    Click the date field and either use the date picker, or enter a date in MM-DD-YYYY format, then use the dropdown menu to select the time zone. Passes will expire at midnight on the specified date and time zone.

    Specify duration: Set the number of days after pass creation when the pass will expire.


    Pass creation occurs either via the API or the CSV Batch Importer. Active length can be between 7 and 1,825 days. The default is 365 days.

    Never: Passes generated from this template will never expire.


    This option is not available for boarding passes and event tickets.

  3. Click the Save Changes button, or Cancel to discard.

Expired Passes

Expired passes display a greyed-out barcode and text “this pass has expired.”

Expired passes can be un-expired by updating the pass expiration date via the API.

Reports

An Activity Report is a graph plotting the number of passes created, added, and removed over a selected time period. Unlike the overview statistics on the project’s Dashboard, the numbers in the Activity Report reflect net pass activity. In the example of a user adding, then removing, then adding a pass, the activity report counts this as two passes added and one pass removed.

An Activity Report is available for each template in the project. Display or hide a report by clicking the triangle to the right of the template name.

By default, the Activity Report displays 30 days worth of data. You may also select a filter option below the graph, or enter a custom range. To enter a custom range, click each date field and either use the date picker, or enter dates in MM/DD/YYYY format. Custom ranges must be between 7 days and 3 months.

The Export as CSV button sends a CSV file of the report data to the email address defined in your reach.urbanairship.com account. See Account Details if you need to change the address.

Triggers

Set Triggers to make pass-relevant text appear on a user’s lock screen based on location and/or date. Clicking the text opens the pass. Beacons may also be attached to Apple Wallet templates.

Relevant Location text is displayed on a user’s screen when the device is in the vicinity of certain location.

Proximity requirements differ between Apple Wallet and Android Pay, and by pass type for Apple Wallet. An Apple Wallet coupon, for example, will appear within 100 meters of the set location, and a boarding pass within 1,000 meters, while proximity for Android Pay is 150 meters for all pass types. See the Location Radius column in the Pass Types Reference table.

Relevant Date text is displayed on a user’s lock screen at a certain date and time. If only Relevant Date is used, the text displayed will be similar to “Today at 12:30”; if combined with Relevant Location, the Relevant Location text will be displayed instead.

The timing when the relevant text appears is determined by Apple Wallet and Android Pay and varies by pass type.

See the table in Pass Types & Layouts for available triggers per pass type, requirements, and location radius and date window information.

Relevant Location

You may add up to ten Relevant Locations per template.

  1. Click the Edit button, then the Add a Relevant Location button.


  2. Start typing an address in the Address field, then click to choose the address from the list of matches that appears.

    After selecting the address, its GPS coordinates will be listed next to the Location pane’s title.

  3. Optionally enter the Relevant Text that will appear on the lock screen when a passholder is near the Location, e.g., “Store nearby on 3rd and Main.”

    For Android passes, the Relevant Text is determined by Android, so it is not editable.

    If you would like to set multiple Locations, click the Add Another Location button and continue with your specifications. To remove an existing Location, click the X in the upper right corner of its pane.

  4. Click the Save Changes button, or Cancel to discard.

Relevant Date

  1. Click the Edit button, then the Add a Relevant Time button.


  2. Click the first Set Date and Time field and either use the date picker, or enter a date in MM/DD/YYYY format.

  3. Click the second Set Date and Time field and either select a time from dropdown menu, or enter a time in 24-hour notation, e.g., 16:47 for 4:47 p.m.

  4. Use the dropdown menu to select the time zone.

  5. Click the Save Changes button, or Cancel to discard.

To remove an existing Date and Time, click the X in the upper right corner of its pane.

Beacons

Apple Wallet supports the addition of up to ten Beacons per template. For information about implementing Beacons, please see our iBeacons Topic Guide.

  1. Click the Edit button, then the Add a Beacon button.


  2. Enter the Beacon’s UUID

  3. Optionally enter the Beacon’s Major and Minor values, if any.

  4. Enter the Relevant Text that will appear on the lock screen when a passholder is near the Beacon.

    If you would like to set multiple Beacons, click the Add Another Beacon button and continue with your specifications. To remove an existing Beacon, click the X in the upper right corner of its pane.

  5. Click the Save Changes button, or Cancel to discard.

Settings

Settings has three submenus. Details and options for each are below.

Project Details

The Basic Details pane displays the Project Name, Description, iOS Certificate, Project ID, Custom ID, and creation date.

Click the Actions dropdown menu to choose Edit Details or Delete Project. Deletion includes a confirmation step.

You may edit the Project Name and Description. If your account has multiple Apple Pass Type Certificates, you may change the selection in the iOS Certificate dropdown menu.

If you have created any passes for a project and then change the certificate, Reach will be unable to interact with or update those passes. The certificate authorization will fail on those passes and they will be in an orphaned state. See additional information about setting the project’s default Apple Pass Type certificate

The Project ID is auto-generated. Check the box to use a Custom Project ID that will override the default Project ID, and enter your Custom ID in the field that appears. Click the Save Changes button, or Cancel to discard.

Barcode

The Basic Details pane displays information about your project’s barcode format and associated default values. You may change your barcode choice here, as well as edit the default values. Click the Edit button, make your desired changes, then click the Save Changes button, or Cancel to discard.

Each heading is defined on the page. When editing, you can hover over the question mark icon near each element for more detail.

Encoded Barcode Value

  • If the barcodes should be the same for every pass, set the default barcode value here.

  • If the barcodes should be dynamic, differing for each pass, you must add specific keys to the header in the API.

Associated App ID

This section only applies to Apple Wallet only.

If you have an iOS app that works with your pass, you can add a link to the app from the back of a pass. Enter the app’s iTunes Store Identifier (ADAM ID) here to create an association between the app and the project.

This places the link to the app on the back of the pass.

  • If the app isn’t installed on the device, the link opens the app’s page in the App Store.

  • If the app is already installed, the link will open the app.

There are two steps to enable this feature:

  1. Enable the iOS app for use with passes. See Configure the App ID.

  2. Create an association between the app and the project by entering the app’s iTunes Store Identifier (ADAM ID). See Add the ADAM ID.

Configure the App ID

Make sure you perform these steps using the same Apple Developer account that is associated with your app’s Apple Pass Type Certificate.

  1. Log in to your Apple Developer account, navigate to Certificates, Identifiers & Profiles, select App IDs from the left side menu, then click the row of app you want to edit. You should then see a list of services associated with the app.

  2. Click the Edit button at the bottom of the page.


  3. Check the box for Wallet, then click the OK button to confirm..


Although this change may take a few hours to propagate throughout Apple’s system, you do not need to resubmit your app for approval. You can now add the ADAM ID to your project.

Add the ADAM ID

  1. Click the Edit button.


    Existing ADAM IDs are listed in individual panes. Click the X in the upper right corner of the pane to delete.


  2. Click the + Add An ADAM ID button.

  3. Enter the ADAM ID.


    A quick way to find the ADAM ID is to copy the numbers at the end of the app’s iTunes URL. If the URL is https://itunes.apple.com/app/id123456789, the ADAM ID is 123456789. Another way is to navigate to iTunes Connect in the iOS Dev Center, find your app, and copy the Apple ID.


    If you have another app to associate with the project, click the +Add An ADAM ID button to create an additional field. They will be listed as ADAM ID 1, ADAM ID 2, etc.

    When using multiple ADAM IDs, list them in order of priority, as only the first app that is compatible with the device will be used.

  4. Click the Save Changes button, or Cancel to discard.