Skip to main content

Use parameters

After you install the Yext integration, the following parameter types are available. You can use these to incorporate content from Yext into your components and compositions.

Parameter typeDescription
Yext Entity QuerySpecify search criteria that is used to select a single or multiple entities from Yext.
Yext Entity SelectorSelect one or more entities from Yext.

Yext Entity Query

This parameter type allows a Uniform user to configure a query that will determine the Yext entities that are retrieved.

Add parameter to component

In order to allow a user to configure a query to determine the entities from Yext to retrieve, you must add a parameter to a component. The parameter is used to store the query settings used to perform the search.

  1. In Uniform, navigate to your component.

  2. Add a new parameter using the parameter type Yext Entity Query.

    parameter-config
    Yext Entity Query parameter configuration.
  3. Enter the following values:

    FieldDescription
    Experience KeyThe key for the search experience you want to use to perform the search.
    Vertical KeyThe key for the vertical used in the search.
  4. Click Check.

    check
    The specified keys are valid.
  5. The following fields provide you with more control over how users will be able to interact with the parameter:

    FieldDescription
    Display fieldThe name of the search entity field to display. If no value is specified, the name field is used.
    Line 1Determines the text that is displayed under the Display field value. If no value is specified, no value is displayed.
    Line 2Determines the text that is displayed under the Line 2 value. If no value is specified, no value is displayed.
    Constrain the selection to the following facets:Selected vertical facets will be available for the user to limit the search to include only those entities that match the selected facets.
    parameter-values
    1. Parameter Name
    2. Facets
    3. Display field
    4. Line 1
    5. Line 2

Edit parameter value

When you use a component with a Yext Entity Query parameter, by default no query parameters will be specified. Configuring this parameter type involves specifying the way an entity search should work.

  1. Click Edit Value.

  2. A preview of the search results are displayed. You can control the search by changing the following values:

    FieldDescription
    CountThe maximum number of search entities that are retrieved.
    Filter by termText used to limit the search entities that are retrieved.
    FacetsThe dropdown lists that are displayed depend on how the parameter was configured in the component.
  3. Click Save to save your changes.

Configure an enhancer

When an entity query is configured, Uniform only stores the search criteria, not the results of the search. Your front-end application must perform the search using that criteria. Uniform provides an enhancer to simplify this process.

tip

Using the enhancer provided by Uniform saves you from having to write logic to interact directly with Yext.

How Uniform stores the search criteria

The following is an example of what Uniform stores for the parameter.

{
"type": "yext-entity-query",
"value": {
"options": {
"count": 5,
"searchText": "",
"verticalKey": "######################",
"experienceKey": "######################"
}
}
}

The entity search criteria is stored as the value.

Add the enhancer

Uniform provides an enhancer so you don't need to write the API calls to Yext to perform the entity search.

tip

For more information about the enhancer, see the package documentation.

  1. Add the following npm packages to your front-end application:

    @uniformdev/canvas
    @uniformdev/canvas-yext
  2. In a text editor, open the file where you retrieve the composition definition from Uniform.

    About this step

    You are looking for the code calls the async function getComposition. The code below assumes the object returned is set in a variable composition.

  3. Add the following import statements:

    import { EnhancerBuilder, enhance } from '@uniformdev/canvas';
    import {
    createEnhancer,
    YextClient,
    YEXT_PARAMETER_TYPES,
    } from '@uniformdev/canvas-yext';
  4. Add the following code:

    const client = new YextClient({
    apiKey: [!!! YOUR YEXT API KEY !!!]
    });
    const yextEnhancer = createEnhancer({ clients: client });
    About this step

    We recommend you moving the Yext credentials to environment variables rather than hard-coding them in the front-end app.

  5. Add the following code:

    await enhance({
    composition,
    enhancers: new EnhancerBuilder().parameterType(
    YEXT_PARAMETER_TYPES,
    yextEnhancer
    ),
    context: {},
    });
    About this step

    This registers the enhancer to be used for any occurrence of the Yext Entity Query parameter.

Next steps

Now the parameter value in the composition is mutated to include the field values for the Yext entities returned when the search runs (instead of just being settings).

Yext Entity Selector

This parameter type allows a Uniform user to select one or more Yext entities.

Add parameter to component

In order to allow a user to select entities from Yext, you must add a parameter to a component. The parameter is used to store the identifier to the selected entities when the user selects one or more entities.

  1. In Uniform, navigate to your component.

  2. Add a new parameter using the parameter type Yext Entity Selector.

  3. The following values can be specified:

    NameDescription
    Constrain the selection to the following folders:Select the folders you want ot limit the search to.
    Allow multiselectIndicates whether the user can select only one entity (the default), or more than one entity.
    Display field (optional)If not specified, the name field is used.
    RequiredIndicates whether the value is required when the component is used.
    add-parameter-to-component
    Yext Entity Selector parameter configuration.

Edit parameter value

When you use a component with a Yext Entity Selector parameter, by default no entity will be selected. You are prompted to select an entity (or entities, if you have allowed multi-selection).

  1. Click Edit Value.

  2. Click Select.

    edit-value-default
  3. Click the entity(s) you want to select.

    edit-value-filters
    About this step

    A couple of filters are available. The dropdown allows you to filter by category. The text box allows you to filter by entity name (note: this filter is case-sensitive).

  4. Click Accept to save your selection.

    edit-value-saved
    About this step

    After your selection is saved, you unselect an entity by clicking Unlink.

Configure an enhancer

This parameter type uses the same enhancer as the Yext Entity Query parameter type.

note

The following is an example of what Uniform stores for the parameter.

{
"type": "yext-entity-selector",
"value": {
"entityIds": [
"######################",
"######################",
"######################"
]
}
}