Adding Passbook Templates
You can create the following pass templates:
- Boarding Pass Template: This template is appropriate for passes used with transit systems such as train tickets, airline boarding passes, and other types of transit. Typically each pass corresponds to a single trip with a specific starting and ending point.
- Coupon Pass Template: This template is appropriate for coupons, special offers, and other discounts.
- Event Ticket Template: This template is appropriate for passes used to gain entry to an event like a concert, a movie, a play, or a sporting event.
- Store Cards Pass Template: This template is appropriate for store loyalty cards, discount cards, point’s cards, and gift cards.
- Membership Pass Template: This template is appropriate for storing membership cards.
To add a Passbook Template, follow these steps:
-
Click the Add Pass Template button to open the Add Passbook Template screen.
The Add Passbook Template screen appears. By default, the Basic step is set to active.
-
Adding a Passbook Template involves following procedure:
- Entering Basic Details
- Entering Appearance Details
- Entering Front Layout Details
- Entering Back Layout Details
- Entering Relevance Details
- Entering Languages Details
- Entering Rules Details
Note: When you create a new pass, options relevant to the specific pass type are displayed.
Entering Basic Details.
-
Select Pass Type: You can view five blank Pass Type templates on screen. The distinct design of the template is at the top edge of the pass: Event tickets have a small cutout, and coupons have a perforated edge.
-
Based on your requirement, click the required template.
Note: The preview of the Pass Template can be seen on the right side.
The Front view and Back view of the selected Pass template are displayed as a thumbnail.
Note: By default, the Front view is set to active. You can view the Back view through the Forward arrow. You can view the Front part through the Backward arrow.
-
Template Name: Enter an appropriate name for the Pass Template.
- Organization Name: Enter the name of the organization that issues the pass type.
- Pass Description: Enter a description for the pass that defines its objective.
-
Pass Certificate: Select the required certificate from the drop-down list. By default, the option is set to None.
Note: Log in to developer.apple.com to create a pass certificate.
-
Pass Serial Number: The serial number is a string that uniquely recognizes the pass within the scope of its pass type. Select the required Pass Serial Number option from the drop-down list. By default, the option is set to an auto-generated serial number.
Note: Serial number uniquely identifies the pass. No two passes with the same pass type identifier can have the same serial number
-
Group Identifier: Enter the unique pass group identifier. The option is applicable only for boarding and event passes.
Note: Based on your requirement as a pass sender, you can define a group name. For example, a user has booked flight tickets through makemytrip.com, so you as an admin from makemytrip defines a group identifier as makemytripBoarding. All passes with the group identifier as makemytripBoarding are grouped on the device.
You can also define different logical groups for sending multiple passes.If a grouping identifier is specified, passes with the same style, pass type identifier, and grouping identifier are displayed as a group. Otherwise, passes are grouped automatically.
-
Pass Timezone: Based on your location, select the timezone from the drop-down list.
-
App Linking: App Links is an open standard for deep-linking between mobile apps. Enter following details for App Linking if needed:
- iTunes Identifier(s): Enter the iTunes Store item identifiers for the associated app.
- App Launch URL: Enter a URL, which needs to be passed to the associated app when launching the app.
- Custom JSON Data: Enter the user information in custom JSON data.
Note: Custom JSON data pertains to customer information for companion apps. The data is not displayed to the user.
For example, a pass for a cafe can include information about the user’s favorite drink and sandwich in a machine-readable form for the companion app to read, making it easy to place an order from the app.-
Send Notification when Pass Issued: Select the option as SMS or Email when a pass is issued.
The SMS and Email checkbox option fields appear.
Note: By default, the latest pass is sent to the user by push message subscription.
-
SMS: Select the SMS option. The system displays the SMS Template drop-down list and the SMS Message text field.
- SMS Template: Select the required template from the drop-down list.
- SMS Message: Enter a message. * Email: Select the Email option. The system displays the Email Template drop-down list, Email Subject text field, and the Email Message text field.
- Email Template: Select the required template from the drop-down list.
- Email Subject: Enter an appropriate subject for the email message.
- Email Message: Enter the message.
Note: You need predefined Email and SMS templates to compose messages. However, you can compose a new message from the text boxes provided.
Important: Using #Email Pass link in the composed email message, will auto embed a link to download the pass.
Similarly for SMS: #SMS Pass Link in the composed SMS message, will auto embed a link to download the pass.
-
-
Click Next to continue.
Entering Appearance Details.
The Add Pass Template – Appearance screen appears.
Adding Pass Template – Appearance involves the following details:
-
Background Color: To modify the default background color, click in the Background Color field.
A pop-up window of color swaths appears.
-
Select the color you want from the color palette.
The color value "#XXXXX" appears in the Background Color field. The color preview appears in the front view of the Pass template.
-
Label Text Color: To modify the default label text color, click in the Label Text Color field.
A pop-up window of color swaths appears.
-
Select a color from the color palette.
The color value "#XXXXX" appears in the Label Text Color field.
-
Value Text Color: To modify the default text color value, click in the Value Text Color field.
A pop-up window of color swaths appears.
-
Select a color from the color palette.
The color value "#XXXXX" appears in the Label Text Color field. The color preview appears in the Label Text field of the Pass template.
-
Icon Image: You can insert an icon image in the pass template through the two options: URL and Upload.
- URL: Enter the URL, from where you can upload the image.
-
Upload: Select the Upload option.
The + Add button to upload the image appears.
-
Click Plus Add to navigate to the location of icon and select it.
The selected icon appears in the placeholder.
Note: To remove the image, place your mouse over the image. The X icon appears in the extreme right corner of the image. Click the icon to remove the image.
-
Logo Image: You can insert a logo image in the pass template through the two options: URL and Upload.
- URL: Enter the URL, from where you can upload the image.
-
Upload: Select the Upload option.
The + Add button to upload the image appears.
-
Click +Add to navigate to the location of logo and select it.
The selected logo appears in the placeholder. The preview appears at the specified location in the pass template.
Note: To remove the image, place your mouse over the image. The X icon appears in the extreme right corner of the image. Click the icon to remove the image.
-
Footer Image: You can insert a footer image in the pass template through two options: URL and Upload.
- URL: Enter the URL, from where you can uplaod the image.
-
Upload: Select the Upload option.
The + Add button to upload the image appears.
-
Click +Add to navigate to the location of image and select it.
The selected image appears in the placeholder. The preview appears at the specified location in the pass template.
Note: To remove the image, place your mouse over the image. The X icon appears in the extreme right corner of the image. Click the icon to remove the image.
Note: Based on the selected pass type, the images option varies as Follows:
Pass Template Type Image options Boarding Pass Icon Image Logo ImageFooter Image Coupon Pass/ Store Card Icon ImageLogo Image Strip Image Event Ticket Logo ImageBackground ImageThumbnail Image Membership Icon ImageLogo ImageThumbnail Image
-
Suppress Shine Effect: To remove the shining effect from the uploaded image, select the checkbox.
Note: Fields with a red asterisk are mandatory fields.
Note: The Supress Shining effect option is available only for the storecard passes.
-
Click Next to continue.
Entering Front Layout Details.
The Add Pass Template – Front Layout screen appears.
Adding Pass Template – Front Layout involves following details:
Important: You can click pointers displayed on the right side of the Pass Template to navigate the respective sections, such as Header, Primary, Secondary and Barcode.
Header
-
Header: By default, fields pertaining to Header are displayed on the screen. Enter details for the following fields:
- Logo Text: Enter a text for logo.
- Header Field Name 1: Enter a name for the Header Field Name. The name should be unique throughout the pass.
- Field Label: Enter a value for the field label.
-
Field Data: Enter a value for the field data.
Note: The entered value appears in the Label placeholder on front layout of the pass template.
You can align the text left, center, or right in the field. -
Change Message: Enter a change message in the Change Message field.
-
Advance Settings: Based on your requirement, select the option from the Data Type drop-down list.
Text
Based on your requirement, select the advanced data type as Text.
Number
- Select the advanced data type as Number. The Number Format drop-down list appears.
-
Based on your requirement, select the option as Decimal, Percentage, Scientific or Spell Out.
Currency
- Select the advanced data type as Currency. The Currency drop-down list appears.
-
Based on your requirement, select the required currency from the drop-down list.
Date or Date and Time
- Select the advanced data type as Date or Date and Time. The Date/Time Format drop-down list, Display relatively checkbox and Ignore timezone checkbox appear.
- Based on your requirement, select the Date/Time Format as Short, Medium, Long, Full or None.
- Display relatively: If checked, the label’s value is displayed as a relative date; otherwise, it is displayed as an absolute date.
-
Ignore timzone: To ignore the current timezone, select the checkbox.
-
Based on your requirement, click the Add Field button to add additional header fields
-
Click the Delete icon to remove the added fields.
Primary
Click the Primary pointer displayed on the left side of the pass template.
-
The primary fields appear. Enter details for the following fields:
-
Transit Type: The transit type option is available for the boarding passes only. Select the required mode of transit from the drop-down list. The available options are: Generic, Train, Bus, Boat, and Air.
-
Primary Field Name 1: Enter a name for the Primary Field Name 1.
- Field Label: Enter details for the following fields:
- Value: Enter a value for the field label.
- Field Data: Enter details for the following fields:
- Value: Enter a value for the field label.
- Field Data: Enter details for the following fields:
- Value: Enter a value for the field label.
- Change Message: Enter a change message in the Change Message field.
- Advance Settings: For more details refer, Advance Settings
- Based on your requirement, click the Add Field button to add additional header fields.
-
-
Click the Delete icon to remove the added fields.
-
Click the *Auxillary* pointer displayed on the left side of the pass template.
Auxiliary
-
The auxiliary fields appears. Enter details for the following fields:
- Auxiliary Field Name 1: Enter a name for the Auxiliary Field Name 1.
- Field Label: Enter details for the following field:
- Value: Enter a value for the field label.
-
Field Data: Enter details for the following field:
- Value: Enter a value for the field data. The added text appears in the auxillary section of the pass template.
- Change Message: Enter a change message in the change message field.
-
Advance Settings: For more details refer, Advance Settings
Secondary
-
Click the *Secondary* pointer displayed on the left side of the pass template. The secondary fields appear. Enter details for the following fields:
- Secondary Field Name 1: Enter a name for the Secondary Field Name 1.
- Field Label: Enter details for the following field:
- Value: Enter a value for the field label.
- Field Data: Enter details for the following field:
- Value: Enter a value for the field label.
- Change Message: Enter a change message in the Change Message field.
- Advance Settings: For more details refer to, Advance Settings
- Based on your requirement, click the Add Field button to add fields.
-
Click the Delete icon to remove the added fields.
Barcode
-
Click Barcode pointer displayed on the left side of the pass template. The Barcode fields appear. Enter details for the following fields:
-
Barcode Type: By default, the barcode type is set to UTF-8 Code. Based on your requirement, select the required barcode type.
Note: The Aztec, and QR are the square type barcodes. The PF417 is a rectangular type barcode. Select the Do not display a barcode option, if a barcode should not be displayed.
-