Algolia management
      Back to home
      1. Help Center
      2. 5 - Commerce plugins
      3. Algolia management

      Configure and sync data to Algolia

      Enhance the search capabilities of your front-end applications

      You must be given explicit permission to access the Algolia management plugin.
      Managed role having this permission: Plugin admin.

      Overview

      Selecting product info for sync    Syncing product information    Syncing CMS Info

      Search testing    Statistics    Setup and configuration

      Overview

      The Algolia management plugin allows synchronization of Bluestone PIM data to Algolia, ensuring up-to-date product catalog information and the ability to enhance the search capabilities for your front-end applications. The plugin includes functionality such as;

      • Syncing product info
      • Syncing CMS info
      • Search testing
      • Statistics

      Note: To configure and use the Algolia management plugin, an Algolia subscription is required.

      You can find the Algolia management plugin as a separate module in the main navigation bar:

      Tip! Find out how to customize the menu bar.

      Selecting product info for sync

      In the 'Product info' section you select the product data to be synced to your Algolia application. 

      Catalogs

      Select the catalogs to be synced. The categories that reside in the given catalog will be included. Multiple catalogs may be selected. Any new catalogs will automatically be displayed in the Algolia management UI.

      Attributes

      Choose the attributes to be synced to Algolia. Click the relevant attribute group from the left panel and select the relevant attributes. You can also use the Search function to find specific attributes. 


      Product and Category metadata

      These sections list the metadata providers registered for your organization. This enables syncing data from for example the External media, Price management and Campaign management plugins.

       

      Syncing product information

      Select the relevant context and click the sync icon in the top right corner. Information about the last sync is presented.

      Click Start to initialize a new sync. Then confirm the operation by clicking Confirm in the pop-up.

      First, a report is generated. The report provides information about the differences from the last sync.

      By default 'All' changes are listed. Go to the different sub-sections to filter by 'Added', 'Changed', 'Deleted' or 'With issues'.

       

      Click Sync to start the syncing process.

      You can view the status of the sync process from the Sync history page. Please see the below section.

      Tip! Product information can automatically be synced to Algolia when products are synced to PAPI via 'Products'. Please see Configuration and setup for details.

      Sync history

      Provides information about initiated/performed syncs. Click View in the Report column to view details. A sync session may have the following statuses:

      • Published: The sync has been completed successfully.
      • In progress: The sync is in progress.
      • Report ready: The sync report is generated, but data is yet to be synced.
      • Report canceled: The sync was initiated, but canceled during report generation.
      • Failed: The sync session failed.


        Syncing CMS info

        Data from the  Content management plugin can be synced to Algolia. The content must have status 'Active' and the state must be 'Published' for it to be synced.

        Go to the CMS info section. Select the relevant context and click the sync icon in the top right corner.

         

        Search testing

        Algolia search can be tested directly within the plugin. The Algolia management plugin will request your registered Algolia index for the available data, and present the results.

        Select whether to search for Product, Category and/or CMS data by ticking the relevant checkboxes. Enter a search phrase in the input field. The results are categorized by Product, Category and CMS data.

         

        Statistics

        This section provides statistics from searches performed in Algolia, and will give insights such as;

        • Top 10 most popular searches.
        • Top 10 searches with no results.
        • Top 10 countries.

        The statistics can be filtered by Product, Category and CMS.

        Setup and configuration

        Algolia management can be configured from the Settings section. Values need to match the setup in Algolia.

        Product index name Name of the index where your PIM product data will be stored in Algolia.
        Category index name If applicable, name of the index where your PIM category data will be stored in Algolia.
        CMS index name If applicable, name of the index where your PIM CMS data will be stored in Algolia.
        Application ID The unique identifier of the Algolia application where your indices are located.
        Admin API key The API key needed for sending PIM data to your Algolia indices. It can be found in Algolia below 'Settings' | 'API Keys'.
        Analytic API key The API key needed for fetching statistics from Algolia. Referred to as the 'Usage API Key' in Algolia.
        Sync product relations Optionally enable sync of product relations to Algolia.
        Media type Optionally select the PIM media type(s) to be synced.
        Auto-sync on PIM published Optionally enable automatic sync to Algolia when a product has been published and synced to PAPI in Bluestone PIM.
        Record size limit (Byte) Define a record limit in bytes. The value cannot exceed the limit in your Algolia payment plan.
        Attribute identifier Select whether name or number should be used as the attribute identifier.

         

        Back to top