VL CheckService Module

Introduction

VL CheckService is a System Screen module in Template Builder. It powers an area availability page — the site looks up the customer’s current IP and zip, then shows whether the service is available in that area.

This page is optional. It is not a built-in step in sign-in, locate, search, or checkout. Customers see it only after you publish a System Screen with this module and link that path (for example from the footer or a help article).

This article explains how to create the Check Service page in Template Builder, configure VL CheckService, publish it, and verify the experience on the web.

Purpose

The purpose of this article is to help you:

• Create a Check Service System Screen in Template Builder
• Add and configure VL CheckService
• Edit available / not-available copy, IP and zip labels, and copy-to-clipboard text
• Understand what customers see on the website
• Publish and verify the live Check Service page

Scope

This article covers:

• Creating a System Screen page for Check Service in Template Builder
• Adding VL CheckService to the page layout
• Module settings: Localization labels
• How the Check Service page appears on the website

It does not cover:

• VL Locate (onboarding share-location at /locate)
• VL Location (account page to view or change a saved home location)
• Plan lists or checkout (VL ViewPlans, VL Checkout 01)
• Building the menu or footer link that opens this page

Prerequisites

Before you begin, ensure you have:

• Access to Template Builder for your site
• Copy ready: congratulations and sorry titles, available / not-available lines, IP and zip labels
• A place to link the page (footer, help, or another published page) so customers can open it

Example used in this article
Throughout the steps below we use a page named Check Service at path /check-service. Replace the sample path with your own. For a sports site you might use this page so fans can confirm City United coverage in their zip.

Check Service flow overview (website)

The flowchart below shows the typical customer journey on the website when VL CheckService is published.

Notes

• The site uses the customer’s network location (IP) to find zip and coordinates. It does not ask the browser for location permission.
• Back returns to the previous page. That label comes from site generic messages (default Back), not from this module.
• Available and not-available use different header colors on the website.
• Copy buttons write the IP, the zip, or both to the clipboard.

Step 1: Open Template Builder

1. Log into ViewLift Tools.
2. Open AppCMS → Edit Template Builder (or open Template Builder for your site from your usual entry point).
3. Confirm you are on the correct site and language (if localization is enabled, use the language selector on the Template Builder home screen before editing page copy).

Template Builder home. From here you create pages and open System Screens.

Step 2: Create the Check Service System Screen

The Check Service page must be a System Screen so that VL CheckService is available in the module picker.

1. In Template Builder, go to Pages.
2. Select + ADD NEW (or Create a New Page).
3. Enter New Page Name: Check Service (or your preferred name).
4. In New Page Type * Developers Only, select System Screen.
5. Optionally set Target Language (If localized Page) if you are creating a language-specific page.
6. Select CREATE.

Set the page path

1. On Page Settings, set a stable path (for example /check-service).
2. Confirm the page type is System Screen.
3. Save page settings if prompted.

Page Settings. Choose a stable path and use that same path in any footer or help link.

Tip: There is no reserved Check Service path. Do not use /locate or /location — those pages are VL Locate and VL Location.

Step 3: Add VL CheckService to the layout

1. Open the Check Service page.
2. Select Edit Layout.
3. Select Add a New Module.
4. Because the page is a System Screen, the picker shows system modules.
5. Search for or select VL CheckService.
6. Insert the module into the page layout.

Edit Layout → Add a New Module. Search for and insert VL CheckService.

Check Service System Screen layout with VL CheckService placed on the page.

System Screens typically use a single primary system module.

Step 4: Configure Localization — Labels

Open the VL CheckService module settings. Expand Localization → Labels.

Share Location Text is the field name in Template Builder. On the website it is the error message if the area check cannot run (for example if location lookup fails).

Step 5: Save and publish the Check Service page

1. Save the module settings.
2. Review the page layout once more.
3. Publish the Check Service page.
4. Add a link to this path from the footer, help, or another published page if customers should find it.

Until the page is published, the live site will not show your latest labels.

Changes can take several minutes to appear because of caching. To verify sooner, use a private window, another browser, or clear cookies and cache.

Step 6: How it looks on the website

After publish, open your page path, for example:

https://www.example.com/check-service

Header

• Back (site generic back label; default Back)
• If available: Positive Title Label and Positive Subtitle Label
• If not available: Negative Title Label and Negative Subtitle Label

The header color changes for available vs not available.

Details

• Current IP Label and the detected IP, with a copy control
• Current Zip Code Label and the detected zip, with a copy control
• Copy Button Label to copy both

If the value is missing, the website can show -.

Copy to clipboard

• Copy IP uses Copy IP Text plus the IP
• Copy zip uses Copy Zip Code Text plus the zip
• Copy both uses both lines together

Error

If the site cannot finish the check, customers see Share Location Text.

Website Check Service page when the service is not available in the detected area.

Verification checklist

• Check Service page exists as a System Screen
• Page path is stable and is not /locate or /location
• VL CheckService is on the layout
• Available and not-available titles and subtitles are reviewed
• IP, zip, and copy labels are reviewed
• Share Location Text is a clear error message
• Page is published
• A link to the path exists if customers should find the page
• An in-area visit shows Congratulations (or your positive copy), IP, and zip
• An out-of-area visit shows Sorry (or your negative copy)
• Copy IP, copy zip, and Copy both write the expected text
• Back returns to the previous page

Troubleshooting

Best Practices

• Use one Check Service System Screen at a stable path.
• Link the page from footer or help if customers should use it.
• Keep available / not-available copy short and accurate for your coverage rules.
• Do not reuse /locate or /location.
• Localize titles, subtitles, and copy labels when the site has multiple live languages.
• Test an in-area and out-of-area visit before launch.
• Publish after every meaningful change.

FAQs

Q. What page type should I use?
System Screen. Choose a stable path such as /check-service.

Q. What is the module name in the picker?
VL CheckService (this is the Template Builder caption for VL Check Service 01).

Q. How do customers open this page?
Only if you link the published path. Sign-in, locate, search, and checkout do not send customers here automatically.

Q. How is this different from VL Locate and VL Location?
VL Locate sets home location during onboarding. VL Location lets an account view or change that saved home area. VL CheckService only reports whether the service is available for the current IP / zip.

Q. Does the page ask for browser location?
No. The website uses the customer’s network location.

Q. Where is the Back label edited?
In site generic messages (back CTA). Default on the website is Back.

Important Information

• Search the picker for VL CheckService.
• Place the module on a System Screen.
• Create the page, add the module, configure labels, publish, then link the path.
• Cache can delay frontend updates by several minutes.

Glossary

Contact Support

If you need help beyond this article, contact the ViewLift support team.

• Email: techsupport@viewlift.com
• Phone (US): +1-800-859-0420
• Phone (UK): +44-203-014-8921

Support hours: B2C requests are handled Monday to Friday. B2B support is available 24/7.