Boost recurring donations this giving season with the new upsell prompt!Learn How >>

Soapbox Engage Check-in App Installation Guide

updated

Pre-Install

  1. Ensure your Campaign object has at least one record type


Install

  1. Click the following link and go through the standard Salesforce installation process: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t6e000000opcS
    SoapboxEngageCheckinAppScreen-AppExchange.png


Post-Install

  1. Ensure that you have an object that represents a "ticket", and includes at least the following fields
    1. first name custom field (text)
    2. last name custom field (text)
    3. email address custom field (email)
    4. lookup field to the Campaign object (lookup)
    5. attended custom field (checkbox)
  2. Go to Setup, in the Quick Find box in the upper-left, type "Lightning App Builder" to go to the Lightning App Builder

    SoapboxEngageCheckinAppScreen-LightningAppBuilder.png

  3. On the Lightning App Builder page, click the New button

    SoapboxEngageCheckinAppScreen-LightningAppBuilder.png

  4. For the first step of the "Create a New Lightning Page" process, choose "App Page" and click the Next button

    SoapboxEngageCheckinAppScreen-CreateNewLightningPage-1.png

  5. For the second step of the "Create a New Lightning Page" process, enter for the Label field "Soapbox Engage Check-in" and click the Next button

    SoapboxEngageCheckinAppScreen-CreateNewLightningPage-2.png

  6. For the third step of the "Create a New Lightning Page" process, choose "One Region" and click the Finish button

    SoapboxEngageCheckinAppScreen-CreateNewLightningPage-3.png

  7. On the Lightning App Builder layout page, under the "Custom-Managed" section on the bottom left of the page, drag the "Soapbox Engage Check-in" Lightning component to the "Add Component(s) Here" section of the page layout

    SoapboxEngageCheckinAppScreen-PageBuilder1.png

  8. After adding the Soapbox Engage Check-in Lightning component to the new Lightning page, update the parameters on the right side of the Lightning Page Builder screen with the fields you have created for the object in Salesforce that represents tickets for your organization, using the field name that ends with “__c”.  Note, if you're using Soapbox Engage's Events app, you won't need to change any of these parameters.

    SoapboxEngageCheckinAppScreen-PageBuilder2.png

  9. To configure the QR Code scanner, in the Scanner Matching Field option, enter the field name that you want the scanner to match on the decoded QR code. For instance, if your QR codes translate to a Soapbox Engage Events App Ticket ID, enter "sbxe1__sbx_SoapboxTicketId__c" in this field. Note: for most organizations using Soapbox Engage's own digital wallet tickets, we recommend using "sbxe1__sbx_SoapboxTicketId__c" as the matching field.

    SoapboxEngageCheckinAppScreen-PageBuilder2.png

  10. On the Lightning App Builder page, click the Save button when you've finished making your customizations

    SoapboxEngageCheckinAppScreen-PageBuilder2.png

  11. In Setup, in the Quick Find box in the upper-left, type "Tabs" to go to the Tab manager

    SoapboxEngageCheckinAppScreen-Tab-1.png

  12. On the Tab page, scroll down to the Lightning Page Tabs section, and click the New button

    SoapboxEngageCheckinAppScreen-Tab-1.png

  13. On the first step of the New Lightning Page Tab page, for the Lightning Page dropdown, select the Soapbox Engage Check-in; for the Tab Label, enter "Soapbox Engage Check-in", and for the Tab Name, use "Soapbox_Engage_Check_in", and click the Next button

    SoapboxEngageCheckinAppScreen-Tab-2.png

  14. On the second step of the New Lightning Page Tab page, choose the tab visibility you'd like, and click the Finish button.
  15. In Setup, in the Quick Find box in the upper-left, type "Salesforce Navigation" to go to the Mobile Navigation page.

    SoapboxEngageCheckinAppScreen-Navigation.png

  16. On the Mobile Navigation page, move "Soapbox Engage Check-in" from the Available to the Selected column, and make sure to move up the "Soapbox Engage Check-in" tab to be anywhere above the "Smart Search Items" to ensure it appears at the top of the Salesforce mobile app's navigation, and click the Save button.

    SoapboxEngageCheckinAppScreen-Navigation.png

  17. For testing purposes, if you don't already have a Campaign that represents an event you'd like to have viewable in the app, create a few Campaign records using the record type(s) you created earlier to represent the Campaigns that you'd want to see in a list of viewable Campaigns in the Soapbox Engage Check-in app
  18. For testing purposes, if you don't already have a Campaign that represents an event you'd like to have viewable in the app, add a few "ticket” object records, ensuring that each record has at least a first name, last name, email address, and lookup to a Campaign record
  19. Test on your mobile device by opening the Salesforce mobile app on your mobile device, and click the hamburger (the three horizontal lines in the upper-left) to view your apps, including the Soapbox Engage Check-in app.
  20. When on the Soapbox Engage Check-in app page, confirm you can view the Campaign(s)
  21. Click on one of the Campaigns you see in the initial view of the Soapbox Engage Check-in page, and confirm you can see the list of the “ticket” records you’ve created, with first name, last name, and email address displayed
  22. Try swiping left on one of the ticket records to checkmark the attended checkbox field and having the UX note this by the left side of the ticket now displayed with a green vertical mark
  23. Try swiping left on the ticket you just checked-in to remove the check-in for that ticket
  24. Click on one of the tickets to be taken to a detail view of the ticket
  25. Dance!
Have more questions? Submit a request
Article is closed for comments.