App engagement, back in Slate

See how your guides are really being used, right in Slate. The Guidebook App Usage Data integration sends engagement from your guides to Slate every hour. That includes downloads, time in the app, schedule adds, content views and form responses, all tied to each person's event registration. Only users who have given privacy consent are included.

Please note that if you are looking for real-time metrics during an event, please look to the Attendance tab within Builder.

How the Guidebook App Usage Data Integration Works

You choose which guides send data. The list includes the guides linked to a Slate folder on the instance, and all of them are selected by default. At least one must stay selected. Archived guides and guides with strict user privacy turned on are never sent, even if selected. Within each guide, data is sent only for named, logged-in users who have a Slate record on the instance and have answered Yes to the guide's privacy consent. Users who haven't answered are treated as having said No. Consent is checked on every run, so if someone withdraws consent, their data stops being sent from that point on.

What's sent and when. For each guide and person, Guidebook sends the following to a custom dataset in Slate:

• When the guide was downloaded
• App sessions and time spent in the app
• Which sessions were added to their schedule
• Menu item, list item and session views
• Form responses, including which form, the answer and when it was submitted

Each record identifies the guide's Slate event and the person's Slate record, so Slate can attach it to the right registration. Data is collected hourly and posted to Slate in batches shortly afterward. The first export includes the guide's full history, and after that only changes are sent. Data flows one way, from Guidebook to Slate.

Managing the export.

Pausing the integration skips the hourly export. When you resume, it catches up automatically. Removing the integration stops the export for that connection.

Before you can set up the Slate App Usage Data integration within Guidebook Builder, you will need the following:

From Slate: A Slate Dataset + Source format imported via a Guidebook provided suitcase and a service account with credentials. Steps to set this up are outlined below.

AND

From Guidebook: Both a Person Data Connection and an Event & Session Data Connection from the same instance you are configuring.

In Slate, you will need to import one Suitcase for the App Usage Data Source Format

1. Import the Guidebook App Usage Data Suitcase ID via the Database “Suitcase Import”. Suitcase ID: 39ab737c-cf79-41e2-ac01-bf612906bc2b:gdb

   

2. Select “Import” and choose the New Names for both the Dataset and the Source format.

   

3. Validate success by locating the Source format you imported in the list of Source formats. You may see an initial empty post which was used to test the connection:

   

4. This Suitcase/Source format comes with a set of predefined field mappings based on the custom Dataset included in that Suitcase. Only remap these if you are confident about what this implies about the data flow.

   

5. Back on the Source Format, click “View” next to Web Service to collect the Webservice URL, this will be needed later in the Builder configuration, be sure to save it.

   

6. Next we will need to create/collect the credentials for a Slate Service account, click “New User” in the User Permissions tab:

   

7. Fill out the following fields to create a Service User Account, please record the username and password as they will be used in Guidebook Builder. Note that if you select an expiry date you will have to re-do parts of this process once it expires.

   

8. A successful account creation will look like the below:

   

Now that you have your Slate web service URL, log in to Builder and open your guide's Integrations settings.

1. Find the Slate integration in your Organizations “Integrations” tab and click Set up. Choose App Usage Data, and press “Connect”

   

2. Paste in your Web service URL and Security key. Include the Service account username and password you noted earlier (DO NOT include your personal Slate account login credentials, this will not work)

   

3. Please ensure that both the Person and Event & Session Data dependencies are connected and functional as below:

   

4. Ensure that the Person Data Connection and the Event & Session Data Connections have the mappings you want and expect for the App Usage Integration. Note that changing any mapping here changes the underlying map on that connection:

   

5. As the administrator, you also have the ability to select which guides are exporting App Usage data. In this example we see one enabled, one disabled. Proceed with “Next” when ready:

   

6. We are now ready to review the entire connection. Press “Save” or go back until satisfied with the configuration:

   

7. Rows will appear in your Source Format as below. Row entries that appear as 0/0 are periodic connection tests from Guidebook and will not alter data in the database:

   

8. The final state of a configured App Usage Data connection will look like so:

   

Once the Slate App Usage Data integration is set up, Guidebook pushes data to your Slate web service regularly so you can see the Guidebook App Usage metrics in Slate.

From the Integration settings you can:

• Update credentials: if your Slate URL or security key changes, update them here. Saving a new URL or key triggers an immediate re-sync.
• Pause the integration: stopping the flow of data from Guidebook to Slate