Querying the Petfinder API

Part II - Building the Home Web Page

Building the Home Web Page’s UI

It's time to start building the pet adoption app’s UI. In this section, we will focus on the first Web Page.

  1. Toggle over to Web Flows Builder, and double click on the recently-added Web Flow to rename it to “Adopt a Pet”.
  2. Add a Web Page to the Web Flow by clicking on the ‘+’ icon to its right and selecting Web Page.
546546
  1. Rename that first Web Page to "Home Web Page" and click on the ‘+’ icon next to it to add new Web Controls. First, we're going add a Label.
888888
  1. Since the first Label will be for the title, let’s change its text to “Adopt a Pet”. In the Inspector, go to General > Control Properties > Text and change the text in the associated string.
12411241

You can also change the Variant of the Label under Style > Variant.

  1. This Web Page will include three prompts:
  • The first one will be used to ask users what type of pet they're looking to adopt, so:
    • Add a Label and change the text to “What type of pet do you want to adopt?”.
    • Add a Dropdown List Web Control underneath.
  • The second one will be used to choose the pet’s gender, so:
    • Add a Label and change the text to “Select gender”.
    • Add a Dropdown List Web Control underneath.
  • The last one will ask users for their zipcode, so:
    • Add a Label and change it to “Enter zipcode”.
    • Add a Text Input Web Control underneath.
  1. Add a Button that reads "Next". Your Home Web Page will look something like this:
957957

You can change the Variant of each Web Control by Inspecting the Control and selecting one of the Variant under Style > Variant.

The dropdown lists will be later populated with information from the Petfinder API.

Creating a Data Flow that Queries the Petfinder API

In this section, we will create a Data Flow that returns the data we want to use to populate the Dropdown List Controls. It will do so by querying the Petfinder API.

  1. Toggle over to to Connections Builder and click on Data Flow to create your first Data Flow. Then select Create Blank and rename it to “Get Pet Types”.
541541
  1. Click on the ‘+’ icon between the Start and End sections of the Stage. From the Data Operation options that appear, select the HTTP Request Data Operation.
11871187
  1. Select the Petfinder Integration as the Source and GET as the method. Then designate "https://api.petfinder.com/v2/types" as the URL.
638638
  1. Under Run Results, press the Run button. The Data Operation should retrieve a list of pet details:
597597
  1. Follow the HTTP Request Data Operation with a a Transform Data Operation by clicking on the ‘+’ icon directly below. In the Transform Expression, enter:
result.types
607607
  1. In the End section, pass transform as the output.
610610

Creating the Variables

The Variable Tree is accessible in all parts of the Studio, regardless of which Builder you're in. We're going to use it now to add six Variables to our application.

  1. Open the Variable Tree by clicking on the Variables button at the bottom of the Studio, to the right of the Builder Bar.

  2. Click on Activity Group Variables and then on the ‘+’ icon.

  3. Then select the corresponding variable type and Web Flow for each of them.

802802

Rename them as follows:

Three Variables of type Text to be renamed as:

  • pet_type_selected
  • pet_gender_selected
  • zipcode

Three Variables of type Any to be renamed as:

  • pet_types
  • pet_gender
  • pets
What is an Activity Group Variable?

An Activity Group is a container of smaller Activities. A Web Page is a type of Activity, and a Web Flow is a type of Activity Group.

An Activity Group Variable is a variable that is only accessible within a particular Activity Group. An Activity Group Variable that's associated with a particular Web Flow, for instance, can only be referenced within that Web Flow. This contrasts with, for instance, global variables, which can be referenced at any point throughout a Journey.

Technically, Activity Group Variables can be accessed under the activityGroup namespace, but this is the presumed namespace by default. An Activity Group Variable designated pets can be accessed both as activityGroup.pets or simply pets, provided it's been referenced within the appropriate Activity Group.

📘

This application flow consists of only a single Web Flow, "Adopt a Pet", and so this is the Web Flow that all these Activity Group variables will be associated with.

When you're done, Variable Tree should appear approximately as follows:

10231023

Binding Data

  1. Toggle back to Web Flows Builder. Select the “Adopt a Pet” Web Flow and click on the Actions Tab in the Inspector.

  2. Click on the ‘+’ icon next to Web Flow Added and select Run Data Flow from the Action options. This will run the data flow when the Web Flow is navigated to.

583583
  1. Then choose the Get Pet Types Data Flow you created previously and bind the output to:
activityGroup.pet_types
765765

The output of the Data Flow will now be stored to the pet_types Activity Group Variable as soon as the user navigates to this Web Page.

Configuring the Home Web Page Controls

The next step is to configure the Dropdown List, Text Input, and Button Controls.

Pet type Dropdown List

  1. Either on the Stage or Tree section, click on the Pet Type List Dropdown List.
  2. Go to the General tab in the Inspector and in Data Binding > Value, select activityGroup.pet_type_selected.
  3. Then change the Type of List to Custom Expression and, under Data, add the following syntax:
FROM
  pet
IN
  activityGroup.pet_types
SELECT
  pet.name
  1. Then for both Display Text and Value Text, enter the variable item.
363363
  1. Now go to the Actions tab and click on the ‘+’ icon next to Value Change to add the Set Variable action from the Data options. Then, enter activityGroup.pet_gender as the Variable and add the Value as follows:
FROM
  pet
IN
  activityGroup.pet_types
WHERE
  pet.name = pet_type_selected
SELECT
  pet.genders
401401

Gender Dropdown List

  1. Either on the Stage or Tree, click on the Gender List Dropdown List.
  2. Go to the General tab in the Inspector and, under Data Binding , select the value activityGroup.pet_gender_selected.
  3. Then change the Type of List to Custom Expression and, in Data, add the following syntax:
FLAT(
  activityGroup.pet_gender
)
  1. Then for both Display Text and Value Text, enter the variable item.
340340

Zipcode Text Input

  1. Either on the Stage or Tree, click on the Zipcode Text Input.
  2. Go to the General tab in the Inspector and in Data Binding add:
activityGroup.zipcode
306306

Next Button

  1. Either on the Stage or Tree, click on the "Next" Button.
  2. Go to the Actions tab and click on the ‘+’ icon next to Clicked. Select the Navigate to Web Page Action.
579579
  1. Choose Add Web Page. A new Web Page will appear under the Home Web Page for you to continue building.
754754

Previewing the Home Web Page

Save your progress and click on the Preview to check that the Home Web Page of your app is running smoothly. Click on the website icon and check what options are available for selection from the Dropdown menus.

540540

You've now built out a homepage that behaves dynamically based on the data provided by an external system! Next, we're going to build a second page that displays pets of interest based on the information users provide in the homepage.


Did this page help you?