DX Engine for Algolia

The Algolia - Search Component Type invokes the client.multipleQueries() method in Algolia’s JavaScript SDK to search across one or more indices and/or facets with a single method call.

• https://www.algolia.com/doc/api-reference/api-methods/multiple-queries/?client=javascript

Within the Algolia - Search Component definition, you can configure multiple queries to process concurrently. See: https://www.algolia.com/doc/api-reference/api-methods/multiple-queries/?client=javascript#method-param-query-object

Connection Configuration

Before using the Algolia - Search Component Type, create and configure an Algolia Connection.

• Connections

To create the Algolia Connection in the DX Engine UI:

1. In the top navigation, click Settings, and then click Connections. The Manage Connections page appears.
2. Click Add Connection. The Create Connection wizard appears.
3. For Connection Code, enter a unique identifier for the Algolia Connection.
4. For Connection Name, enter a friendly name for the Algolia Connection.
5. Optionally, enter a Connection Description.
6. For Connector, select Algolia.
7. For API Key, enter your Algolia API key. You may choose to create a Secret to store this value.
8. For Application ID, enter your Algolia application ID.
9. Click Submit.

Component Configuration

To create an Algolia - Search Component in the DX Engine UI:

1. In the top navigation, click Manage Experiences, and then click Components. The Manage Components page appears.
2. Click Add Component. The Create Component wizard appears.
3. For Component Code, enter a unique identifier for the Algolia - Search Component.
4. For Component Name, enter a friendly name for the Algolia - Search Component.
5. Optionally, enter a Component Description.
6. Select the No Rules checkbox.
7. For Component Type, select Algolia - Search.
8. Click Submit.

To configure the Algolia - Search Component, in the Manage Components page:

1. Next to the Algolia - Search Component, click the Edit button. The Edit Component wizard appears.
2. For Connection, select the Algolia Connection created previously.
3. Enter query definitions.

You may define one or more queries, either using the form or through a JS Expression in the Queries Override field. If you define the Queries Override field, any other query definitions will be ignored.

To define queries using the form, for each query, enter the following values:

Parameter Name	Parameter Property	Description
Index Name	indexName	The name of the Algolia index.
Type	type	The type of the query. See: https://www.algolia.com/doc/api-reference/api-methods/multiple-queries/?client=javascript#method-param-type
Query	query	The value for which to query. You may use a Context Field to pass this value through the orchestration flow to this Algolia - Search Component. See: Context
Params	params	Algolia search parameters. See: https://www.algolia.com/doc/api-reference/api-methods/multiple-queries/?client=javascript#method-param-query-object

To define queries programmatically, use the Queries Override field and enter a JS Expression that evaluates to an array of query definitions. For example:

_.identity([
  {
    'indexName': 'my-index',
    'query': `${contextField('searchTerm') ? contextField('searchTerm') : ''}`, 
    'params': {
      'facets': ['*'],
      'attributesToRetrieve': ['Title', "ImageUrl"],
      'hitsPerPage': 5
    }
  }
])

4. Enter the Strategy and Request Options as follows:

Parameter Name	Parameter Property	Description
Strategy	strategy	The strategy for the query. See: https://www.algolia.com/doc/api-reference/api-methods/multiple-queries/?client=javascript#method-param-strategy
Request Options	requestOptions	Request options for the query. See: https://www.algolia.com/doc/api-reference/api-methods/multiple-queries/?client=javascript#method-param-requestoptions

5. Click Submit.