Fluent Commerce Logo
Docs
Sign In

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)

Steps

Step arrow right iconDeploy your custom Rules Plugin

First, you need to version and package your custom .

In your pom.xml file, update the project version to `0.0.1` and package your using `mvn clean package`.

This will create a JAR file in the project's `target` directory.

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

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


Step arrow right iconAdd your custom Rule to a Workflow

Using the Modeller, add your LogHelloWorld to the CC CREATE .

No alt provided

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


Step arrow right iconFire an Event to execute your Rule

To execute your LogHelloWorld , you will need to the CC CREATE .

Do this by creating a new CC for the Retailer using a  `createOrderWithCustomer` mutation.

This should successfully create the new in your , and fire the CREATE to execution of your .

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

No alt provided


Step arrow right iconWhat's next?

You have now completed the Getting Started guide.

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