Docs
Search
Search
Help & Feedback
Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases
Working with Rules SDK
How-to guides for working with Rules SDK
Getting Started with the Utility Bundles
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Dependencies
: To get started, add the utility artifacts as Maven dependencies to your project's
`pom.xml`
.
Simple Usage
: Utility classes can be called directly from within your Rules. The most common helpers are static methods that take the
`Context`
object as a parameter.
Build Integration
: Once the dependencies are added,
`mvn clean install`
will automatically download the libraries and make them available to your project.
Explore the Docs
: This guide is the first step. For detailed information on every class and method, explore the other documentation articles and refer to the JavaDocs in your IDE.
Deploy and Run your Rules SDK project
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
A step-by-step guide to deploy your custom Rules Plugin and run the project.
A fully setup and functioning Fluent Account is required.
An API User with the
`DEVELOPER`
role (Note: If using a Training Account, the Account Admin already has this role applied)
Rules SDK - Debugging Rules
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
the best approaches to debugging your custom rules and plugins
Debugging locally in your IDE can be done as per standard Java practice while running rules in Unit Tests or with the TestExecutor.
Debugging on Sandbox - The primary mechanism for debugging on a deployed environment is by activity tracking or Orchestration Audit Events. You can easily query these for any context via the Event API, or the Admin Console.
Setup your Development Environment for Rules SDK
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
Step-by-step guide to setup Rule SDK in your local Environment.
Create a new Rules SDK Plugin Project
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
A step-by-step guide to creating Rule SDK Plugin Project.
The Rules SDK comes with a Maven Archetype for generating a new Rules Plugin Project, and a handy script file to run the project generation steps.
A fully setup and functioning Fluent Account is required as of this activity.
OMS Web App: Search order by ID using the Rules SDK
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
This is the use case where users can look up OMS orders using order ID.
Typically, the
`orderById`
GraphQL query is used to look up an order by ID. However, only one order can be searched at a time, and there is no wildcard search.
This article provides an alternative approach that allows users to search for orders by ID or even with a wildcard, leveraging the new
`ref2`
field on the order entity included in the
Enhanced Order Lookup and Tagging Capabilities
release.
Write your first custom Rule using the Fluent Rules SDK (Hello World)
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
A step-by-Step guide to creating your first custom Rule to log "Hello World"
Update your Plugin Project for JDK 17+
How-to Guide
Step-by-step guides to achieve a specific scenario or setup.
A step-by-step guide to update your plugin Project for SDK 17+