Deploy and Run your Rules SDK project

How-to Guide

Author:

Lesley Dean

Changed on:

1 July 2024

Key Points

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)

Prerequisites

Setup your Development Environment for Rules SDK

Create a new Rules SDK Plugin Project

Write your first custom Rule using the Fluent Rules SDK (Hello World)

Steps

Deploy your custom Rules Plugin

First, you need to version and package your custom Rule plugin.

Warning

While SNAPSHOT versions are possible, it cannot be used as is with the

`-`

separator, so we recommend using a simple SemVer such as

`0.0.1`

In your pom.xml file, update the project version to

`0.0.1`

and package your Plugin using

`mvn clean package`

This will create a JAR file in the project's

`target`

directory.

Plugins are deployed using the Plugin REST API, and include 3 simple steps:

Make sure you have authenticated a user with the DEVELOPER role to perform the above steps.

Tip

You can use the Postman Collection and Environment file packaged within the SDK to perform these steps.

Add your custom Rule to a Workflow

Using the Workflow Modeller, add your LogHelloWorld rule to the Order CC workflow CREATE Ruleset.

For additional help with the above, see the building workflows documentation.

Fire an Event to execute your Rule

To execute your LogHelloWorld Rule, you will need to trigger the Order CC workflow CREATE Ruleset.

Do this by creating a new CC Order for the Retailer using a GraphQL

`createOrderWithCustomer`

mutation.

This should successfully create the new Order in your Account, and fire the CREATE Orchestration Event to trigger execution of your Rule.

You can view the Orchestration Audit Events log to see the custom Log Action produced by your Rule using the OMS Events Search:

What's next?

You have now completed the Getting Started guide.

You are now ready to learn more about implementing Rules with the following topics:

Related content

Rule Structure

Edited 381 days ago

Rules are written using Java, and contain a specific structure and metadata for describing and validating the Rule. Rules are designed to be building blocks for workflow logic, and typically produce a single outcome or action. The Rules SDK also provides a number of built-in dependencies for implementing Rules, including working with GraphQL and other Utilities.