Guides

Edit Templates

In this page you'll learn how to edit a pass template.

To access this page, expand the menu item Loyalty and click in Pass Designer:

menu

Then click, from the list of pass templates, click in the template you want to update:

template in list

In that page you'll find the pass template wizard, which is divided in four different tabs like shown below:

tabs

Setup

In this tab, you can always change the name of your template:

name

Optionally you can change the organization name. This text will be shown in the lock screen and notification center messages your passes might generate. If left blank we will use the organization name in the Pass Type ID certificate:

organization

Optionally you can also change the description. This text will be shown as the title of your pass, if left blank we will use the app's name:

description

And you will have to change the pass style:

style

To learn more about these styles please read our guides located here.

If you select the Boarding style, you will also need to provide the transit type you want to use:

transit

If you select the Ticket type, you can optionally define if it should have a thumbnail:

thumbnail

Design

In this tab you will be uploading the artwork needed for your template as well as selecting the colours used in your pass. Depending on your pass style you will need to provide a certain number of images for your template:

artwork

You will also need to provide the colours we should use for the template:

colours

Please note that you should upload images that fill the allotted space available for each one of them. Sizes are presented in points so you will want to convert to pixels and optimize them for high density screens (usually 2 or 3 times bigger).

Fields

Optionally you can add fields to your pass. This is the only way you have to present data in your passes so in most cases and depending in the style you choose, you'll want to add them strategically.

If you wish to provide a text to be displayed next to your logo, use the following field:

logo text

Then you can add one or more fields for each type available: Header, Primary, Secondary, Auxiliary or Back fields. Once again, understanding pass styles is crucial before deciding what fields to create.

Each one of them will let you add a field from a selector like the one below:

header fields

There are three types of fields, String, Date and Number. For all types you'll always have to provide a Key, this should have a unique value for each field you create:

key

Please note that each field's key should not use reserved names. Here's a complete list of reserved names:

relevant_date
expiration_date
voided
barcode_message
barcode_alt_text
barcode_show_alt_text
barcode_format
barcode_message_encoding
description
beacon_proximity_uuid
beacon_major
beacon_minor
beacon_relevant_text
location_latitude
location_longitude
location_altitude
location_relevant_text
location_region_id
location_region_major
message
title
subtitle
user_info
app_launch_url
associated_store_identifiers
max_distance
background_color
foreground_color
grouping_identifier
label_color
logo_text
suppress_strip_shine
nfc_message
nfc_encryption_public_key
transit_type
redeem_type
redeem_limit

You will also have to always provide the Label, which will be visible to the user:

label

And you should always provide the alignment of field, which can be Left, Right, Center, Natural:

text alignment

Optionally every field will support a Modified Message, when provided it will generate a lock screen message whenever the value of the field changes. Use the placeholder %@ in your text to show the new value:

modified message

If you choose Date as your field type, you should also provide the Date Style and Time Style:

date time styles

For Date fields you can also make sure the date displayed is shown in the device's timezone by ignoring the timezone included in its value. To do that toggle the following option:

ignores timezone

And finally, for Date fields you can also show a relative date instead of an absolute one. For that toggle the following option:

relative date

If you choose Number as your field type, you should also provide the Number Style, which can be Decimal, Percent, Scientific or Spell Out:

number style

For the Number field type, if you using it to display a money value, you should instead provide the ISO 4217 currency code in the following field. Adding a Currency Code will hide the Number Style:

currency code

Also note that the order of the fields in each list can be changed by simply dragging the following icon and dropping the field into the new position:

drag icon

Barcode

In this area you will be specifying which kind of barcode you will want to use for your passes. Your choice will depend in the type of scanners your company will use to scan these passes. You can always change the type of barcode in the following field:

barcodes

You can choose between QR Code, PDF417, 1D (a.k.a. Code128) or Aztec. You should obtain information about your scanning capabilities before choosing the type of barcode to use in your passes.

You can also change the encoding for the value of the barcode. By default we will use iso-8859-1 but depending on your scanning infrastructure you can choose another encoding format:

barcode encoding

Finally if you wish to show or hide the human readable text of the barcode in your pass, toggle the following option:

show human readable

As you create your template, you can obtain a preview by clicking in the Preview button:

preview button

This will open a window like the one below, allowing you to preview how your template looks like:

preview modal

And once you are ready to save the changes to your template, click in the Save button:

save button

In this page you can also quickly clone a template. To do that simply expand the Options menu and click in Clone:

options clone

It is also possible to delete a template. To do that simply expand the Options menu and click in Delete:

options delete

You are now ready to start creating passes based on the templates you've designed. Jump to our guides located here to learn how to create passes.