Skip to main content

Challenge

Adding an external data source to a data type

7 Tasks

30 mins

Visible to all users
Intermediate Pega Platform 8.4 Data Integration English

Scenario

Requests for roadside assistance must identify the vehicle so that a service provider can prepare for the service call. For example, certain vehicles may require a flat-bed tow truck or a higher octane blend of fuel. To better prepare service providers for a service call, stakeholders want to ensure that users only enter a valid combination of make, model, and model year for a vehicle. After evaluating several possible sources for vehicle models, stakeholders decided to source this information from a US National Highway Traffic Safety Administration (NHTSA) web service available at https://vpic.nhtsa.dot.gov/api.

Replace the current simulated data source with an integration to source the model information for passenger cars and trucks using a Representational State Transfer (REST) service provided by the NHTSA. Populate the D_VehiclemodelsList data page with NHTSA response data, based on the model year and make entered by the user.

Note: NHTSA data includes information on other types of vehicles, such as buses, that are not supported by GoGoRoad roadside assistance service. To display only relevant vehicle models, configure the integration to support two calls to the NHTSA service: one for passenger cars, and one for trucks.

 

The following table provides the credentials you need to complete the challenge.

Role Operator ID Password
Application Developer author@gogoroad pega123!

Challenge Walkthrough

You must initiate your own Pega instance to complete this Challenge.

Initialization may take up to 5 minutes so please be patient.

Detailed Tasks

1 Create a data object with an external data source

Create a new data object to query the NHTSA REST service for vehicle model information.

  1. In App Studio, from the left navigation pane, click Data > Data objects and integrations to open the Data objects and integrations landing page.
    Data Source - Challenge - Configure Data Type - Access Data Type
  2. In the upper-right corner of the landing page, click New to open the Data Object wizard and create a data object to access the NHTSA service.
  3. In the Data Object wizard, in the Data objects name field, enter NHTSA Model data.
  4. In the System drop-down, select Create new. The wizard updates to display additional fields to define the new data source.
  5. In the Name field, enter NHTSA vPIC.
  6. In the Description field, enter NHTSA Product Information Catalog Vehicle Listing.
    Configuration settings for naming the data object used to connect to the NHTSA data source.
  7. In the Endpoint URL field, enter https://vpic.nhtsa.dot.gov/api/vehicles/GetModelsForMakeYear/make/Ford/modelyear/2015/vehicletype/Truck?format=json to specify the URL for the NHTSA web service. The Parameters section expands to display the URL parts for the service URL.
  8. Using the following table, add parameters for the make, model year, and vehicle type parts of the service URL.
    URL part Parameter name
    Ford make
    2015 modelyear
    Truck vehicletype
    Connection settings for the NHTSA REST service, including parameter definitions
  9. Click Initialize call to call the REST service and advance to the second step of the wizard.

2 Map the response from the data source

View a sample of the response data from the NHTSA REST service and map the response to the data model for the data object.

Note: The response indicates seven results were returned and displays data for one of the seven results. The number of results returned varies according to the parameters passed to the service.
  1. In the SearchCriteria row, click Add new to map the SearchCriteria field from the REST response to a field for the data object. The contents of the row update to display the Map to field and a drop-down listing field types.
  2. In the SearchCriteria row, click the Add/Edit map to icon to accept the default mapping and create a text field named SearchCriteria in the data object.
    Add/Edit map to icon highlighted on the Data mapping step of the Data Object wizard
  3. Repeat steps 1 and 2 for the Results array and the Make_Name, Model_Name, and VehicleTypeName response fields.
    response data from the NHTSA REST service, mapped to the fields of the data object in Pega Platform
  4. Click Next to complete the data mapping and advance to the third step of the wizard.

3 Define the endpoint settings for the integration

Enter the integration settings to finish configuring the integration to the NHTSA REST service.

Note: The NHTSA does not require user authentication to access the service and receive response data. Other data providers may require authentication. Verify any authentication requirements when you configure an integration to a web service.
  1. Under Endpoint URL, in the Name field, enter GetVehicleModels_BaseURL to identify the connection settings.
  2. Under Stage, in the Base URL field, enter https://vpic.nhtsa.dot.gov to complete the URL used after migrating the application to a staging system.
  3. Under Prod, in the Base URL field, enter https://vpic.nhtsa.dot.gov to complete the URL used after migrating the application to a production system.
  4. Under Authentication, in the Name field, enter AuthProfile_NHTSA_vPIC.
    Environment settings for accessing the NHTSA REST service
  5. Click Submit to complete the configuration of the data object and REST integration.

4 Aggregate the responses from the data source

Configure the current simulated data source to call the NHTSA REST service twice to obtain a listing of vehicle models for both passenger cars and trucks.

  1. In Dev Studio, from the left navigation pane, click Data types to list the data objects defined for the GoGoRoad application.
  2. Expand the Vehicle model entry to list the data views configured for the data object.
  3. Click List vehicle models to open the D_VehiclemodelsList data page, which caches a listing of vehicle models.
  4. Clear the Simulate data source check box to remove the simulated data source from the data page.
  5. In the Source drop-down, select Aggregate sources to source the data page using two REST calls.
  6. In the Aggregate source name field, enter NHTSA vPIC to identify the data source for the data page.
  7. In the Source drop-down, select Data transform.
  8. Click Add source to add a second source for the data page.
  9. In the second Source drop-down, select Data transform.
    Data page configured with an aggregate source consisting of two data transform calls

5 Configure the source data transform

Configure a data transform to populate the data page with results from the NHTSA service.

  1. For the first source, in the Data transform field, enter MapModels.
  2. Click the open icon to create the data transform.
  3. Click Create and open to accept the default settings and open the data transform rule form.
  4. Define parameters for the data required by the NHTSA service.
    1. Click the Parameters tab to define three parameters needed by the NHTSA service.
    2. On the Parameters tab, click the add icon to add a row to define a parameter.
    3. In the empty parameter row, in the Name field, enter make.
    4. In the Required drop-down, select Yes.
    5. Repeat steps b-d to add two more parameters to the data transform, using the information in the following table.
      Name Required
      modelyear Yes
      vehicletype Yes
  5. Add information to resolve references to pages accessed by the data transform.
    1. Click the Pages & Classes tab to identify the pages used by the data transform and the class of each page.
    2. On the Pages & Classes tab, in the Page name field, enter Primary.pxResults to identify the page that contains the output of the data transform.
    3. In the Class field, enter or select GoGo-GoGoRoad-Data-VehicleModels to identify the class of the output page.
    4. Click the Add item icon to add a second row to the Pages & Classes tab.
    5. In the Page name field, enter D_NHTSAModelData.Results to identify the page that contains the output of the data transform.
    6. In the Class field, enter or select GoGo-GoGoRoad-Data-NHTSAModelData-Results to identify the class of the output page.
      Pages & Classes tab of the MapModels data transform, demonstrating the page references required to map data from the NHTSA response to the data page that populates the drop-down of vehicle models
  6. Configure the data transform logic.
    1. Click the Definition tab to configure the data transform logic.
    2. For step 1, in the Action drop down, select Append and Map to to create a new results page for each result returned. The data transform adds a child row labeled 1.1 below step 1.
    3. For step 1, in the Target field, enter Primary.pxResults.
    4. In the Relation drop-down, select each page in.
    5. In the Source field, enter D_NHTSAModelData[vehicletype:param.vehicletype,modelyear:param.modelyear,make:param.make].Results to pass the required parameters to the data page that calls the NHTSA service and caches the response.
    6. For step 1.1, in the Target field, enter or select .Make to set the value of the Make property on the target page.
    7. In the Source field, enter or select .Make_Name to identify the property to copy to the target.
    8. Click the plus icon twice to add steps 1.2 and 1.3 to the data transform.
    9. Complete the fields of steps 1.2 and 1.3 by using the information in the following table.
        Action Target Source
      1.2 Set .Model .Model_Name
      1.3 Set .VehicleType .VehicleTypeName
      Definition tab of the MapModels data transform, demonstrating the completed configuration
  7. Click Save to complete the configuration of the data transform.

6 Parameterize the data page to configure both service calls

Add parameters to the D_VehiclemodelsList data page and configure parameters for the aggregated data sources.

  1. In Dev Studio, click the D_VehiclemodelsList tab to return to the data page rule form.
  2. On the D_VehiclemodelsList data page rule form, click the Parameters tab to add parameters to the data page.
  3. In the empty row, in the Name field, enter make to define a parameter for the make to pass to the data transform.
  4. In the Required drop-down, select Yes to mark the parameter as required.
  5. Click the add icon to add a second parameter to the data page.
  6. In the second row, in the Name field, enter modelyear to define a parameter for the model year to pass to the data transform.
  7. In the Required drop-down, select Yes to mark the parameter as required.
  8. Click the Definition tab to resume configuration of the aggregate sources.
  9. For the first aggregated source, set values for the parameters passed to the data transform.
    1. Below the Data transform name field, click Parameters to open a dialog box for setting values to pass to the data transform.
    2. In the dialog box, in the Value field for the make parameter, enter param.make to pass the value of the make parameter passed to the data page.
    3. In the Value field for the modelyear parameter, enter param.modelyear to pass the value of the model year parameter passed to the data page.
    4. In the Value field for the vehicletype parameter, enter "Passenger Car" to pass a constant string.
    5. Click Submit to close the modal dialog and save the parameter configuration.
  10. For the second aggregate source, in the Data transform name field, enter or select MapModels to call the data transform a second time to populate the data page.
  11. Press the [Tab] key to exit the field. The Parameters link is displayed below the Data transform name field.
  12. Repeat step 9 for the second aggregated source to add parameter values for the MapModels data transform by using the information in the following table.
    Parameter Value
    make param.make
    modelyear param.modelyear
    vehicletype "Truck"
  13. Click Save to complete the configuration of the data page.

7 Confirm your work

  1. In App Studio, click Preview application to return to the Case Manager.
  2. Create a new Assistance Request case.
  3. Advance the case to the Identify Vehicle view, completing any required fields.
  4. On the Identify Vehicle form, click the Configure this view icon to configure the Model drop-down list to pass the required parameters to the data page. A configuration pane is displayed on the right side of the browser window.
    Configure this view icon presented on the Identify vehicle view
  5. Click the Model drop-down to display the properties of the containing view in the pane.
  6. Configure the Model drop-down to display values sourced from the NHTSA web service.
    1. In the configuration pane, hover over the Model drop-down, and then click the Edit icon to configure the field.
    2. In the List source section, clear the contents of the Data Page field.
    3. In the Data page field, enter or select D_VehiclemodelsList to re-select the page and update the properties pane to display the required parameters.
    4. In the Value field for the make parameter, enter or select .Make.
    5. In the Value field for the modelyear parameter, enter or select .ModelYear.
    6. In the Property for value field, enter or select .Model.
      Configuration of the Model drop-down to display the list of vehicle models based on the make and model year provided by the user
    7. In the upper right corner of the pane, click Apply to complete the configuration of the drop-down.
    8. Close the pane to return to the case.
  7. In the Model year field, enter 2015.
  8. In the Make field, enter Ford.
  9. Click the Model drop-down to display a list of vehicle models, grouped by vehicle type.
    The Models drop-down, populated with data from the NHTSA REST service


Available in the following missions:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

50% found this content useful

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice