Malachyte Portal/Recommend

Components

How to create and manage components

Overview

Use Components to apply business rules to the recommendations that appear on the site. Clients can launch custom strategies from pre-defined templates while controlling:

  • Eligibility: Which products are eligible to appear.
  • Ranking: How products are ordered and prioritized.

Components combine eligibility logic and merchandising controls into a single configurable layer.

How to Create a Component

  1. Go to the Components tab.
  2. Click Create Component.
  3. Fill out the required fields:
    • Name: Give the component a recognizable title.
    • Description: Internal notes on the component's purpose.
    • Strategy: Select a strategy (e.g., Recommended For You).

Once created, rules can be added to define specific business logic and fine-tune recommendations. See the Adding Rules section for more details.

Manage Components

The Component Table displays all current components. Use Columns to show or hide columns, Filters to narrow the list, and Search to find a component by name.

Component Table Overview:

ColumnDescription
NameA unique name for the component.
DescriptionMore details about the component, i.e. any business rules that are applied.
StrategyThe strategy the component uses, shown as its ID. For example, Recommended For You appears as recommended-for-you.
StatusShows if the component is Active or Inactive.
RulesThe number of business rules applied.
Last updatedWhen the component was last changed.
Updated byWho last changed the component.

Edit Components

Follow these steps to update an existing component:

  1. Locate the component in the Component Table and click Edit.
  2. Update any of the following parameters:
    • Strategy: Swap the core logic (e.g., switch from "Recommended Products" to "New And Coming Soon").
    • Advanced Customizations: Refine filters (e.g., exclude discounted items).

Changes are saved instantly. Please allow up to 10 minutes for updates to be reflected in the Playground environment.

Removing a Component

Components can't be deleted from the Portal. To stop a component from showing on the site:

  • Shopify: In the Shopify theme editor, remove the Malachyte Recommendations block for that component from the live theme. Once it's off the theme, Shopify no longer requests recommendations for it.
  • Headless: Stop sending API requests with that component's component_id.

To have a component removed from the Portal entirely, contact the Malachyte team.