Create Custom Sourcing Condition

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

How-to Guide

Authors:

Kirill Gaiduk, Alexey Kaminskiy

Changed on:

16 Apr 2026

Key Points

Outcome: After completing this guide, you will know how to extend the Responsive Sourcing Framework with a Custom Condition and apply it in real Strategies
Minimal essentials: The process has four parts - implement the Condition, register it, expose it in the Setting, and verify behavior
Application: You will be able to influence sourcing decisions with your own logic, tailored to specific business contexts

Prerequisites

Responsive Sourcing Framework Overview

Sourcing Utilities Overview

Sourcing Conditions Overview

Getting Started with Reference Sourcing Conditions

Steps

Preliminary Setup

Start with your own custom module setup.1. Create a custom module.

Reminder

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

2. Include Sourcing Utilities in your plugin dependencies.Your plugin must have access to its own copy of `util-sourcing` at runtime so it can initialize its own local sourcing registries.You can include it in your project by:

Adding it as a dependency in your `pom.xml`

1<dependency>
2    <groupId>com.fluentcommerce</groupId>
3    <artifactId>util-sourcing</artifactId>
4    <version>${util-sourcing.version}</version>
5</dependency>

Using a provided JAR, depending on your build setup

Reminder

Each plugin runs in an isolated classloader. Your custom Sourcing Conditions / Criteria will only be available if `util-sourcing` is included in the same plugin where your custom logic is implemented and executed
General Utility Bundles guidelines also apply to Sourcing Utilities

3. Optionally, download the Sourcing Utilities Java source package to review reference implementations.

Implement a Custom Sourcing Condition Function

Create a class in your custom plugin that implements the `SourcingCondition` interface:1. Create your class, for example: `CustomSourcingCondition`.2. Implement the `SourcingCondition` interface.3. Add your business logic inside `evaluateWithContext` method.

1public class CustomSourcingCondition implements SourcingCondition {
2    
3    // Declare your parameters
4    @JsonProperty
5    protected String parameter1;
6
7    @JsonProperty
8    protected String parameterN;
9
10     /**
11     * Evaluates the sourcing condition using the provided context.
12     *
13     * @param sourcingContext a {@link JsonNode} containing data used for evaluation;
14     * typically includes fields related to the order, location,
15     * inventory, or product information, implements 
16     * {@link com.fluentcommerce.util.sourcing.context.SourcingContext}
17     * @return {@code true} if the condition is satisfied based on the context,
18     * {@code false} otherwise
19     */
20    @Override
21    public boolean evaluateWithContext(final JsonNode sourcingContext) {
22        // Add your business logic here
23        return true;
24    }
25}

Tips

Return only a boolean decision
Validate required fields from `sourcingContext` and handle missing/invalid data defensively
Mirror conventions from `DefaultSourcingCondition`:
- naming
- null handling
- logging

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 = "CustomCreateFulfilmentWithSourcingProfile",
3        description = "Applies Sourcing Profile {" + "profileRef" + "} to a sourcing request (Order, Fulfilment Option, etc.) and produces Fulfillment(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 CustomCreateFulfilmentWithSourcingProfile implements Rule {
10
11    static {
12        // register custom sourcing criterion
13        SourcingCriteriaTypeRegistry.register("company.sourcing.criterion.custom", CustomSourcingCriterion.class);
14        // register custom sourcing condition
15        SourcingConditionTypeRegistry.register("company.sourcing.condition.custom", CustomSourcingCondition.class);
16    }
17
18    @Override
19    public void run(Context context) {
20        SourcingProfile sourcingProfile = loadSourcingProfile(context);
21        if (sourcingProfile.getSourcingStrategies() != null) {
22            SourcingContext sourcingContext = loadSourcingContext(context, SourcingUtils::getUnfulfilledItems);
23            SourcingUtils.SourcingPlan plan = findPlanBasedOnStrategies(context, sourcingContext, sourcingProfile,
24                    ImmutableList.of("ACTIVE", "AT_RISK"), null);
25            if (plan.getFulfilments() != null) {
26                fillFulfilmentType(sourcingContext, plan.getFulfilments());
27                createFulfilments(context, sourcingContext, plan.getFulfilments());
28            }
29        }
30    }
31}

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 Condition Schema via Setting

Create (or update the existing) the Setting `fc.rubix.order.sourcing.conditions.custom` with your new Condition schema.

1mutation createSetting ($input: CreateSettingInput) {
2    createSetting (input: $input) {
3        id
4        name
5        valueType
6        lobValue
7        value
8        context
9        contextId
10    }
11}

1{
2  "input": {
3    "name": "fc.rubix.order.sourcing.conditions.custom",
4    "valueType": "JSON",
5    "lobValue": [
6      {
7      "name": "CustomSourcingCondition",
8      "type": "company.sourcing.condition.custom",
9      "tags": [
10        "Lorem ipsum"
11      ],
12      "params": [
13        {
14        "name": "parameter1",
15        "value": "Lorem ipsum"
16        },
17        {
18        "name": "parameterN",
19        "value": "Lorem ipsum"
20        }
21      ]
22      }
23    ],
24    "value": "",
25    "context": "RETAILER",
26    "contextId": 1
27  }
28}

1{
2    "data": {
3        "createSetting": {
4            "id": "13141",
5            "name": "fc.rubix.order.sourcing.conditions.custom",
6            "valueType": "JSON",
7            "lobValue": [
8                {
9                    "name": "CustomSourcingCondition",
10                    "type": "company.sourcing.condition.custom",
11                    "tags": [
12                        "Lorem ipsum"
13                    ],
14                    "params": [
15                        {
16                            "name": "parameter1",
17                            "value": "Lorem ipsum"
18                        },
19                        {
20                            "name": "parameterN",
21                            "value": "Lorem ipsum"
22                        }
23                    ]
24                }
25            ],
26            "value": "",
27            "context": "RETAILER",
28            "contextId": 1
29        }
30    }
31}

Verify the Condition Behavior

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

Create Custom Sourcing Condition

Key Points

Prerequisites

Responsive Sourcing Framework Overview

Sourcing Utilities Overview

Sourcing Conditions Overview

Getting Started with Reference Sourcing Conditions

Steps

Preliminary Setup

Implement a Custom Sourcing Condition Function

Introduce Custom Sourcing Rules

Expose the Condition Schema via Setting

Verify the Condition Behavior

Related artifacts

fc.rubix.order.sourcing.conditions

Related content

Responsive Sourcing Framework Overview

Getting Started with Reference Sourcing Conditions

Create Custom Sourcing Criterion

Kirill Gaiduk

Contributors:

Building Blocks

By Type

Helpful Resources

Quick Links