Understanding the Passport Draggables
The Passport Container allows you to create a new Digital Passport for your app. You can have multiple Passports in a single app. The Container is where you determine the properties of the Passport you are creating.
These properties include:
- Naming the Passport
- How you want the Passport items to display
- The Titlebar action you want the Passport to have
- Creating the Passport levels of achievement
- Determining the check-in types allowed in the Passport
More information about the Passport Container is available in the "Building Your First Passport" topic below.
The Passport Item is how you add the various points of interest to your Passport. You can edit the following properties on the Passport Item:
- Item name
- Item layout
- Item location
- Check-in options for the Item
More information about the Passport Items is available in the "Add Passport Item to the Container" topic below.
You can use the Passport Property to turn an existing container into a Passport Container. For example, you can add the Passport Property to a Places Container already set up in your app. This saves you time because you don’t need to recreate all of the Passport Items a second time.
The Check-In Property works similar to the Passport Property in that it turns existing Items into Passport Items. Adding the Check-In Property to an Item allows you to set the check-in options and setting for that Item.
Building Your First Passport
Add the Passports Container to your app.
Passport Container - By the Numbers
- Passport: This is the name of your Passport. It will display in your app’s menu, and in the header once the Passport is selected.
- Layout Options: This lets you determine how you want your Passport Items to display in your app.
- Subtitle: You can explain your Passport Items in more detail here. The subtitle will display in certain layout options.
- Titlebar: This lets you choose which action you want to appear in the top right hand corner of your Passport.
- Add New Level: This is where you determine the levels you want your Passport to have. More information about the Passport Container is available in the "Create Your Passport Levels" topic below.
- Add New Input: This is where you determine which check-in types you want to make available in your Passport. More information about the Passport Container is available in the "Configure the Check-in Types for Passport Items" topic below.
Create Your Passport Levels
Levels are how you gamify and incentivize your Passport users to continue checking-in to your Passport locations. You can have multiple levels of achievement for your passport, however, you must set up at least one level. The more check-ins a user makes, the higher status they earn. Levels allow you to reward engaged Passport Users for reaching a defined number of check-ins.
You can name your levels anything you’d like, but we recommend giving them fun names. For example, the VisitDallas Margarita Mile (https://apps.apple.com/us/app/margarita-mile/id787643032) passport’s first level is called ‘Rita Rookie. To add a name, select the field next to ‘Add New Level’ and type in your name there.
After giving your level a name, you will need to select the ‘+’ symbol on the far right-hand side. Doing so will officially add it to your Passport and make more options available to edit.
Check-ins Required: This allows you to designate the number of check-ins that must be logged before the user achieves the level. This can be any number you choose. As you add consecutive levels, the number of check-ins required will need to increase.
For example, If your first level requires five check-ins to achieve the status, your second level will need to require six check-ins or more. If you entered a smaller number, such as four, the levels would automatically reorder themselves so that the level with the smallest number of needed check-ins would be first. In other words, level check-in counts build upon each other.
URL: You can use the URL field to place a website link, if you would like a page to open up once the level has been achieved. You can use this as a way to congratulate the passport user, or to collect more information from them by placing a form on the webpage.
Select Check-in Types for the Passport
Check-ins are how your Passport users inform you that they have visited a location, or completed an activity as specified in your Passport. It’s essentially how they verify that they should receive a virtual stamp for that location.
There are a few different types of check-ins. You are able to determine which types you want available in your Passport.
Add New Input: This lets you select which type of check-ins you will accept in your Passport. For each Passport Item, you can specify which types of check-ins you want to allow for that specific item. Your options include the following:
- Geolocation: The geolocation check-in option lets users share their location with the app to prove that they are at a specified location. We recommend using a radius of 300 feet surrounding your point of interest as a good place to start.
- Text: This can be used for a secret password type of check-in. Text submissions are case sensitive.
- Number: This will accept numerical characters (i.e. digits 0-9). This check in type is identical to the Text type with the exception that users will be prompted with a 10 digit numeric keypad when they tap it, instead of the alphabetical keyboard that the text field brings up.
- Image Upload: This lets users submit photos to prove their check-in at a location. In order to upload a photo check-in, the app will ask for permission to access both the microphone and photo library. This is because these are considered part of the camera app on most phones.
The images taken in the Passport will be saved to the phone’s camera roll. However, there is no way to upload photos directly from the phone’s library. This prevents users from sharing photos, or using old photos, to submit as check-ins.
Add Passport Item to the Container
To add a new Passport Item, simply select the Passport Item draggable and drag it below your Passport Container.
Once the Item is added, open it up by selecting on the icon or the ‘New Item’ label.
You can name your Passport Item by selecting the ‘New Item’ field and changing the text.
You can also change how the item displays by selecting a different layout, if you wish.
To add geolocation information to the Passport Item, fill in the Item’s address. You can then select the green map point icon, in order to find the location’s exact latitude and longitude.
Configure the Check-in Types for Passport Items
You can choose which check-in types you’d like activated for each Passport Item. For each activated check-in type, you will be able to determine the following settings:
- Label: This allows you to provide instructions or information to your Passport users.
- Placeholder: This will cue the Passport user with an example response to the check-in.
- Match Value: This field will display for both Text and Number check-in types. This is where you place the correct answer for the check-in. Keep in mind that text answers are case sensitive.
- Range (in feet): This will display for the Geolocation check-in type. It allows you to set the radius distance of acceptable location submissions. The geolocation range will be the radius surrounding the Passport Item’s latitude and longitude. We recommend a range of at least 300 feet.
- Combine: This option requires users to combine two or more check-in types to submit a check-in. For example, if both Geolocation and Image Upload are selected, a user would need to check-in both with their location and an image to qualify their check-in.
When check-in types are combined, the app will display them with an ‘and’ phrase. If only one check in type is needed, the app will display an ‘or’ phrase.