Create Custom Sourcing Criterion

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Author:

Kirill Gaiduk

Changed on:

3 Mar 2026

Key Points

Outcome: You’ll extend the Responsive Sourcing Framework with a Custom Criterion and apply it in real Strategies
Minimal essentials: Implement the Criterion → register it → expose it in the Setting (auto-generate or manual) → verify behavior
Application: Influence Location ranking (exclusion) with domain-specific scoring that fits your business

Prerequisites

Responsive Sourcing Framework Overview

Sourcing Utilities Overview

Sourcing Criteria Overview

Getting Started with Reference Sourcing Criteria

Steps

Preliminary Setup

Custom Sourcing Criterion creation requires modifying the Sourcing Utilities bundle:1. Prepare your module that contains Order Reference Module assets.

Reminder

Check the Module Recipe - Plugin Setup and Installation Guide for details.

2. Download the Sourcing Utilities Package (Java source code).3. Add Sourcing Utilities as a dependency in your project's `pom.xml` file.

Reminder

General Utility Bundles guidelines also apply to Sourcing Utilities.

Implement a Custom Sourcing Criterion Function

Create a class that enforces your ranking (exclusion) logic:

Implement `SourcingCriterion` (or extend `BaseSourcingCriterion`)
Put computation in `execute(CriterionContext ctx)` (when extending `BaseSourcingCriterion`)
Parse configuration in `parseParams(JsonNode params)` if needed
(Optional) Override `normalize(min, max, rating)` when your metric is “lower is better” (e.g., distance)

1@SourcingCriterionInfo(
2    name = "mySourcingCriterion",
3    type = "company.sourcing.criterion.my",
4    tags = { "ATS-agnostic" } // or "ATS-dependent", "Exclusion"
5)
6public class MySourcingCriterion extends BaseSourcingCriterion {
7
8    @SourcingCriterionParam(name = "value", component = "integer")
9    private Integer threshold;
10
11    @Override
12    public void parseParams(final JsonNode params) {
13        // parse threshold, lists, units, etc.
14    }
15
16    @Override
17    protected float execute(final SourcingCriteriaUtils.CriterionContext ctx) {
18        // Return:
19        //  -1f to exclude a location,
20        //   0..1f (or any float) to score/rank a location.
21        return 0.75f;
22    }
23
24    // Override normalize(...) only if the default doesn’t fit your scale
25}

Note

Return only a float (use -1f for “exclude”)
Validate required data from the context; handle nulls defensively
Mirror conventions from reference Criteria (naming, logging, units)

Introduce Custom Sourcing Rules

Introduce custom versions of the Sourcing Rules that will execute your sourcing logic inside your plugin.

Note

Custom type registration and Rule execution must be initialized within the same plugin module.Creating custom Rules ensures that your Sourcing Condition or Criterion type is available during runtime evaluation.

1. Copy the reference Sourcing Rule implementation:

2. Rename the class3. Register your custom Sourcing Condition or Criterion inside the Rule class

1@RuleInfo(
2        name = "SampleCreateFulfilmentWithSourcingProfile",
3        description = "Applies Sourcing Profile {" + "profileRef" + "} to a sourcing request (Order, Fulfilment Option, etc.) and produces Fulfilment(s)",
4        accepts = {@EventInfo(entityType = "ORDER"),
5                @EventInfo(entityType = "FULFILMENT_CHOICE")}
6)
7@ParamString(name = "profileRef", description = "Profile reference to apply.")
8@Slf4j
9public class SampleCreateFulfilmentWithSourcingProfile implements Rule {
10
11    static {
12        // register custom criteria
13        SourcingCriteriaTypeRegistry.register("fc.sourcing.criterion.customCriteria", CustomCriteria.class);
14        // register custom condition
15        SourcingConditionTypeRegistry.register("fc.sourcing.condition.customCondition", CustomCondition.class);
16    }
17
18    @Override
19    public void run(Context context) {
20        SourcingCriteriaTypeRegistry.getTypeNameToClassMap().forEach((key, value) -> log.info("registered: {}", key));
21        SourcingProfile sourcingProfile = loadSourcingProfile(context);
22        if (sourcingProfile.getSourcingStrategies() != null) {
23            SourcingContext sourcingContext = loadSourcingContext(context, SourcingUtils::getUnfulfilledItems);
24            SourcingUtils.SourcingPlan plan = findPlanBasedOnStrategies(context, sourcingContext, sourcingProfile,
25                    ImmutableList.of("ACTIVE", "AT_RISK"), null);
26            if (plan.getFulfilments() != null) {
27                fillFulfilmentType(sourcingContext, plan.getFulfilments());
28                createFulfilments(context, sourcingContext, plan.getFulfilments());
29            }
30        }
31    }
32}

4. Replace the reference Rule in your Workflow configuration with your custom Rule

Reminder

Each plugin initializes its own Sourcing registries.To ensure correct registration and runtime resolution of custom Sourcing Conditions or Criteria, your custom Rule must:

Include `util-sourcing` in the plugin’s `pom.xml`
Register custom types inside the same plugin where the Rule executes

Expose the Criterion Schema

Create (or update the existing) the Setting `fc.rubix.order.sourcing.criteria.custom` with your new Criterion schema, similar to Conditions.

Schema Autogeneration

Sourcing Criteria support annotation-driven generation of the Setting JSON.

How it works

The generator scans all classes registered in `SourcingCriteriaTypeRegistry`.
Reads `@SourcingCriterionInfo` + `@SourcingCriterionParam` annotations
Produces a complete JSON (name, type, tags, params, including select options)

Run it

Command: `java -jar <path>util-sourcing-<version>-sources.jar`
Output: SourcingCriteriaSetting.json in the same folder as the JAR/classes
Use this JSON to populate `fc.rubix.order.sourcing.criteria.custom` Setting

When to use

Any time you add/update Sourcing Criteria or their `params` - regenerate to keep UI configs in sync

Verify the Criterion Behavior

Use the Sourcing Profile GraphQL API to add the new Criterion to a Sourcing Strategy.
Test against different Sourcing Requests and confirm the expected outcomes.

Related artifacts

fc.rubix.order.sourcing.criteria

Related content

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Implement a Custom Sourcing Criterion Function

Create a class that enforces your ranking (exclusion) logic:

Implement `SourcingCriterion` (or extend `BaseSourcingCriterion`)
Put computation in `execute(CriterionContext ctx)` (when extending `BaseSourcingCriterion`)
Parse configuration in `parseParams(JsonNode params)` if needed
(Optional) Override `normalize(min, max, rating)` when your metric is “lower is better” (e.g., distance)

1@SourcingCriterionInfo(
2    name = "mySourcingCriterion",
3    type = "company.sourcing.criterion.my",
4    tags = { "ATS-agnostic" } // or "ATS-dependent", "Exclusion"
5)
6public class MySourcingCriterion extends BaseSourcingCriterion {
7
8    @SourcingCriterionParam(name = "value", component = "integer")
9    private Integer threshold;
10
11    @Override
12    public void parseParams(final JsonNode params) {
13        // parse threshold, lists, units, etc.
14    }
15
16    @Override
17    protected float execute(final SourcingCriteriaUtils.CriterionContext ctx) {
18        // Return:
19        //  -1f to exclude a location,
20        //   0..1f (or any float) to score/rank a location.
21        return 0.75f;
22    }
23
24    // Override normalize(...) only if the default doesn’t fit your scale
25}

Note

Return only a float (use -1f for “exclude”)
Validate required data from the context; handle nulls defensively
Mirror conventions from reference Criteria (naming, logging, units)

Introduce Custom Sourcing Rules

Introduce custom versions of the Sourcing Rules that will execute your sourcing logic inside your plugin.

Note

1. Copy the reference Sourcing Rule implementation:

2. Rename the class3. Register your custom Sourcing Condition or Criterion inside the Rule class

1@RuleInfo(
2        name = "SampleCreateFulfilmentWithSourcingProfile",
3        description = "Applies Sourcing Profile {" + "profileRef" + "} to a sourcing request (Order, Fulfilment Option, etc.) and produces Fulfilment(s)",
4        accepts = {@EventInfo(entityType = "ORDER"),
5                @EventInfo(entityType = "FULFILMENT_CHOICE")}
6)
7@ParamString(name = "profileRef", description = "Profile reference to apply.")
8@Slf4j
9public class SampleCreateFulfilmentWithSourcingProfile implements Rule {
10
11    static {
12        // register custom criteria
13        SourcingCriteriaTypeRegistry.register("fc.sourcing.criterion.customCriteria", CustomCriteria.class);
14        // register custom condition
15        SourcingConditionTypeRegistry.register("fc.sourcing.condition.customCondition", CustomCondition.class);
16    }
17
18    @Override
19    public void run(Context context) {
20        SourcingCriteriaTypeRegistry.getTypeNameToClassMap().forEach((key, value) -> log.info("registered: {}", key));
21        SourcingProfile sourcingProfile = loadSourcingProfile(context);
22        if (sourcingProfile.getSourcingStrategies() != null) {
23            SourcingContext sourcingContext = loadSourcingContext(context, SourcingUtils::getUnfulfilledItems);
24            SourcingUtils.SourcingPlan plan = findPlanBasedOnStrategies(context, sourcingContext, sourcingProfile,
25                    ImmutableList.of("ACTIVE", "AT_RISK"), null);
26            if (plan.getFulfilments() != null) {
27                fillFulfilmentType(sourcingContext, plan.getFulfilments());
28                createFulfilments(context, sourcingContext, plan.getFulfilments());
29            }
30        }
31    }
32}

4. Replace the reference Rule in your Workflow configuration with your custom Rule

Reminder

Each plugin initializes its own Sourcing registries.To ensure correct registration and runtime resolution of custom Sourcing Conditions or Criteria, your custom Rule must:

Include `util-sourcing` in the plugin’s `pom.xml`
Register custom types inside the same plugin where the Rule executes

Create Custom Sourcing Criterion

Key Points

Prerequisites

Responsive Sourcing Framework Overview

Sourcing Utilities Overview

Sourcing Criteria Overview

Getting Started with Reference Sourcing Criteria

Steps

Preliminary Setup

Implement a Custom Sourcing Criterion Function

Introduce Custom Sourcing Rules

Expose the Criterion Schema

Schema Autogeneration

How it works

Run it

When to use

Verify the Criterion Behavior

Related artifacts

fc.rubix.order.sourcing.criteria

Related content

Responsive Sourcing Framework Overview

Getting Started with Reference Sourcing Criteria

Create Custom Sourcing Condition

Kirill Gaiduk

Building Blocks

By Type

Helpful Resources

Quick Links

Preliminary Setup

Implement a Custom Sourcing Criterion Function

Introduce Custom Sourcing Rules

Expose the Criterion Schema

Schema Autogeneration

How it works

Run it

When to use

Verify the Criterion Behavior