App Preview App Preview

App Preview

Chandra Bergmann Chandra Bergmann

The Preview button allows you to explore how your in-progress Airkit Apps would behave if deployed as-is. Previewing your application fully emulates everything you've built out so far, allowing you to test every channel, every interaction, and every pathway your users can take.

In addition to simulating how a user might interact with your app, previewing your app also provides the option to peak under the hood and ensure that your app is meeting all of your quality and testing standards.

Accessing and Using App Preview

You can preview your application at any point throughout the process of building it out in Airkit Studio. Clicking on the Preview button to the upper right of the Studio will open up your App Preview in a separate tab.

2021-07-09_15-22-33__1_.gif

To ensure your App Preview will emulate all components of your app build, you'll need to save your app before previewing; if you don't, you will receive a reminder to do so upon clicking the Preview button. You will need to click on the Preview button again after saving in order to open an App Preview tab.

There are two fundamental components to the App Preview: 

  • Previews - Emulate how users will experience your app.
  • Viewers - Examine how your application behaves under the hood when you emulate various interactions your app might have with the outside world.

The Viewers window can be opened or closed by clicking on the double arrow icon ('<<' or '>>' respectively) on the upper right of the Previews window. 

anatomy_of_app_preview.png

Previews

The Previews window is where you can simulate all the external feedback your application might respond to and see exactly how your app responds. The most fundamental tab is Device Preview, which allows you to experience how your app's interactive UI appears and responds to users. Additionally, other tabs within the Previews window allow you to simulate what happens when Events are triggered (even if said Events are only triggered by external sources via, ie, webhooks). 

Toggling through the different Preview tabs is as simple as clicking on the name of the desired tab, all of which appear on the top left of the Previews window.

Previews_Window.png

Device Preview

The Device Preview tab is what will be opened automatically when you first access your App Preview. It simulates an interactive Journey through your application from the perspective of a hypothetical user. This provides a reasonable approximation of how users will perceive your app.

A dropdown menu at the top of the Previews window allows you to change the simulated device on which your application Journey is emulated. You can choose to see your Journey framed by a variety of smartphones and tablets as well as in Full Screen mode, which approximates the experience a user would have if accessing your application from their desktop or laptop computer. 

2021-07-09_15-49-20__2_.gif

The 'rotate' icon to the immediate right of this dropdown menu simulates rotating the device between landscape and portrait views.

Within the Device Preview, there are icons at the bottom that indicate different channels. Currently Airkit Supports Voice, Text, and Web Channels. Because Journeys have consistent state across channels, you can switch which channel you are viewing and the state will be preserved across the other channels. To switch channels, simply click on the the relevant icon channel.

The following example shows how these icons will appear when accessing the Web Channel. Note that the Web icon is highlighted in pink:

icon_channels.png

The Device Preview is entirely interactive. Enter text responses, click buttons, or reply to texts as they appear inside of your simulated device. Associated Actions will fire just as they would within a deployed app.

The following example shows how the Device Preview can be used to view different channels. The example Journey begins on the Web. Pressing a button on the first web page activates a Chat Bot, and the text it sends can be accessed via the Text channel:

2021-07-13_15-32-45__1_.gif

Note the warning in the Text Channel that the Actor is not set up. When an app is deployed, initializing the Actor is a crucial component of activating a Voice or Chat Bot from a web app, because it tells your application which phone number to send the voice or chat message to. The App Preview warns you when this is the case, but it nevertheless allows you to simulate sending voice or chat messages without requiring the Actor to be initialized, because all calls and texts can only be sent to the emulated device, which does not, itself, have an associated phone number. 

API

The API tab is used to simulate relevant HTTP Events. After an HTTP Event has been simulated, you can toggle back to Device Preview to see how the HTTP Event would impact the user's Journey through your app.

To learn more about HTTP Events, check out Creating an API for your Airkit App

Webhooks

The Webhooks tab is used to simulate data updates from external sources. After an an update from an external source has been simulated, you can toggle back to Device Preview to see how it would impact the user's Journey through your app.

A webhook is a Subscription service that automatically informs your application if a change is made to an external resource. For more on webhooks and Subscriptions, check out Passing Data from External Systems.

Links

The Links tab provides a list of all web links relevant to your application. Clicking on a web link allows you to simulate what a user will experience if they click on a link to that URL.

Outside of App Preview, these web links are managed in Connection Builder and woven into your application using Journey Builder. It is not at all uncommon for a web app to only have a single relevant web link: the one that begins a user's Journey

Timers

Timers are used to run Actions at designated times. (For instance, a common use case of timers is to send a text reminder a short time before a scheduled appointment.) The Timers tab allows you to keeps track of any timers that are set throughout the course of your emulated Journey.

Many timers are associated with Actions that will not occur for hours or even days after the timer is set. For testing purposes, this is far too long to reasonably wait, and so the Timers tab also provides the means to trigger timers early, allowing you to see their effects in the Device Preview without needing to wait the full length of the timer.

Viewers

The Viewers window provides a means to examine how your application behaves under the hood when you use the functionality in the Previews window to emulate various interactions your app might have with the outside world. Updates to the Viewers window occur simultaneously to changes made in the Previews window.

Whenever the Viewers window is open, it will display two Viewers: Event Log Viewer on top and the State Viewer on bottom.

Viewers.png

Event Log Viewer

The Event Log Viewer contains a chronological list of all the events that occur during the simulated execution of your app. Each event is accompanied by a description and a time stamp. Depending on the nature of an event, it might also contain an expansion toggle to indicate that the event is really a combination of multiple steps.

Selecting an event will open its state in the State Viewer.

State Viewer

The State Viewer displays the state of your application at the time of a specific event. Selecting an event to examine is done in the Event Log Viewer.

The State Viewer has three different tabs. The Diff tab displays only the change in state that occurs between the selected event and the previous; accessing the Diff tab cuts down on noise in cases when you are only interested in the state changes immediately associated with the selected event. The Current tab shows the state within the current context. The Entire tab displays the entire application state at the time of the event.