External Links

External Links enable you to set up a URL that the White Label App and Web Ordering can open for guests. It is currently used to provide an allergen information link which is shown at appropriate points in a guest's ordering journey.

The External Links Screen

The External Links screen lists all external links for the current brand, showing the link Name and available Actions. From here you can:

• Use the Search box to filter the list by link name

• Click Add External Link to create a link targeted at specific sites or site groups

• Click Configure Global link to create a single brand-wide link

  The Configure Global link button only appears when no global link exists yet. There can be only one global link per brand

Row behaviour:

• A global link, if present, is listed at the top and can be edited only. It cannot be deleted.

• Standard links can be edited or deleted. Deleting a link shows a confirmation prompt

Global Link

Configuring a Global Link

A global link is a single brand-wide link that applies to every site that does not have its own more specific link of the same type. There can be only one global link per brand.

1. Click Configure Global link or Click Edit on the Global External Link row, if a global link already exists

2. Select Allergens from the Type drop down

3. Enter the URL that guests should be taken to

4. Click Save Changes

Standard Link

Adding a Standard Link

A standard link applies to the specific sites and site groups you choose. Follow these steps to add one:

1. Click Add External Link

2. Enter a Link Name | select Allergens from the Type drop down

   The Link Name is free text, required, up to 500 characters. It is for your reference only and is not shown to guests

3. Enter the URL that guests should be taken to

4. Select either a site Group or click the Sites tab and select individual Sites the link applies to

   Each site can belong to only one external link at a time. If a site is already used by another link it will be disabled in the selector, with a tooltip naming the link that currently owns it

5. Click Save Changes

A given site or site group can be attached to only one external link at a time. To move a site to a different link, first remove it from the link that currently holds it, then add it to the new one. If you try to save a site that already belongs to another link, you will see a message such as "[Site] cannot be added to this external link as it is already attached to [other link]."

Enabling for White Label App or Web Ordering

Once the URLs have been configured in App Manager, the functionality must be enabled before it is shown in either White Label App or Web Ordering.

Follow these steps to enable:

1. Navigate to App Manager

2. Click Configure Style

3. Navigate to ordering > showAllergensButton and set to true, which enables the functionality.

4. Navigate to ordering > allergensTitleLabel and set an appropriate label, which is shown on button.

5. Navigate to ordering > missingAllergensMessage and set an appropriate fallback message when there isn't an external link configured.

Adding to a Home Screen

A global or site's external link can be shown on site's home screen.

Follow these steps to add:

1. Navigate to App Manager

2. Click Home Screen from the Configure Dropdown

3. Find or create the appropriate home screen profile.

4. Find or create the appropriate home screen banner.

5. Select "Allergens" from the Banner Call to Action dropdown.

6. Save the home screen profile.

Where the Link Appears to Guests

When a link of type Allergens is configured, both the White Label App and Web Ordering use its URL for the allergen button. If the allergen display is switched on but no matching link exists, guests see a "missing allergens" message instead.

It can be displayed on White Label App or Web Ordering in the following places along a guest's ordering journey:

• Venue Home Screen

• Portion Selector

• Allergen Banner (if configured)