https://github.com/alexreich/RulesEngineEditor
Editor for Microsoft RulesEngine - Blazor UI library intended for integration in Web or Desktop
https://github.com/alexreich/RulesEngineEditor
blazor-component engine expression-evaluator rules rules-engine rules-engine-editor workflow
Last synced: about 1 year ago
JSON representation
Editor for Microsoft RulesEngine - Blazor UI library intended for integration in Web or Desktop
- Host: GitHub
- URL: https://github.com/alexreich/RulesEngineEditor
- Owner: alexreich
- License: cc-by-4.0
- Created: 2021-09-02T11:48:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T23:25:34.000Z (about 1 year ago)
- Last Synced: 2025-03-26T23:29:15.909Z (about 1 year ago)
- Topics: blazor-component, engine, expression-evaluator, rules, rules-engine, rules-engine-editor, workflow
- Language: C#
- Homepage: https://github.com/alexreich/RulesEngineEditor
- Size: 146 MB
- Stars: 416
- Watchers: 17
- Forks: 91
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Rules Engine Editor
Editor for Microsoft Rules Engine - Blazor UI library intended for integration in Web or Desktop
[![CC BY 4.0][cc-by-shield]][cc-by]
## Overview
Rules Engine Editor is a library/NuGet package for use with [Microsoft Rules Engine](https://github.com/microsoft/RulesEngine) which itself is a package for abstracting business logic/rules/policies out of a system.
## Installation
To install this library, download the latest version of [NuGet Package](https://www.nuget.org/packages/RulesEngineEditor/) from [nuget.org](https://www.nuget.org/).
## How to use it
There are several ways to populate workflows for the Rules Engine Editor as listed below.
Rules are based on the [Microsoft Rules Engine schema definition](https://github.com/microsoft/RulesEngine/blob/main/schema/workflow-schema.json) and can be stored in anything deemed appropriate like Azure Blob Storage, Cosmos DB, Azure App Configuration, [Entity Framework](https://github.com/microsoft/RulesEngine#entity-framework), SQL Servers, file systems etc. For RuleExpressionType `LamdaExpression`, the rule is written as a [lambda expressions](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/statements-expressions-operators/lambda-expressions).
The Rules Engine Editor can also use a format for [Input Rule Parameters](https://github.com/microsoft/RulesEngine/wiki/Getting-Started#ruleparameter) based on the [schema defintiion](schema/inputRuleParameter-schema.json) and can likewise be stored as the aforementioned workflow schema. Input Rule Parameters allow the seeding of arbitrary input data to be used in the Rules Engine. Consider Input Rule Parameters like interactive "unit tests" which allow for "What-If" type analysis.
## Live Demo
### WebAssembly
https://alexreich.github.io/RulesEngineEditor
> This can also be installed as a standalone PWA and used offline.
### With Sample Data
https://alexreich.github.io/RulesEngineEditor/demo
## Features
* Works in conjunction with [Microsoft Rules Engine](https://github.com/microsoft/RulesEngine)
* Real-time evaluation
* Add, Edit, Delete in form view, JSON or switch between them
* Drag, Drop objects to change order
* Current Workflow dropdown, switch between workflows as well as [pass in current workflow as a parameter](https://alexreich.github.io/RulesEngineEditor/demo/Test%20Workflow)
* Nested Rule support
* Import, Download [compliant Workflow json](https://github.com/microsoft/RulesEngine/blob/main/schema/workflowRules-schema.json)
* Import, Download [compliant Input Rule Parameter json](schema/inputRuleParameter-schema.json)
* Entity Framework support for load and save ([example in Server project](https://github.com/alexreich/RulesEngineEditor/blob/main/demo/RulesEngineEditorServer/Pages/DemoEF.razor))
* Design Time Support:
* Pass pre-constructed instance of Rules Engine
* Supports 2-way binding of Workflows
* "Starter" Input Rule Parameter JSON
* Allows for non-supported types in Rules Engine Workflow JSON
* .NET 6 Support
## Usage
Simple:
```csharp
```
Complex:
```csharp
```
Complex (EF Supported):
```csharp
```
## Install
[](https://www.nuget.org/packages/RulesEngineEditor/)
### Blazor WebAssembly / Client-side Blazor
1. In `Program.cs` add
```csharp
builder.Services.AddRulesEngineEditor();
```
2. In `_Imports.razor`
```csharp
@using RulesEngineEditor.Pages
```
3. Add relevant styles, either add css included to `site.css` or inside the `` element of `wwwroot/index.html` with the following statements:
```html
```
### Server-side Blazor
1. In `Startup.cs` add
```csharp
services.AddRulesEngineEditor();
```
2. In `_Imports.razor`
```csharp
@using RulesEngineEditor.Pages
```
3. Add relevant styles, either add css included to `site.css` or inside the `` element of `Pages/_Host.cshtml` with the following statements:
```html
```
#### Entity Framework Demo Setup
1. Ensure SQL Express is set up
`c:\> sqllocaldb`
3. Create an instance of the test database
>`sqllocaldb c "RulesEngineEditorDB" -s`
3. Open Package Manager Console (View > Other Windows > Package Manager Console)
`Add-Migration init`
`
Update-Database`
#### Suppress top level Buttons
Any/all of the following menu buttons can explicitly disabled:
`NewWorkflows, DownloadWorkflows, ImportWorkflows, AddWorkflow, NewInputs, DownloadInputs, ImportInputs, AddInput`
See [DemoEF](https://raw.githubusercontent.com/alexreich/RulesEngineEditor/main/demo/RulesEngineEditorServer/Pages/DemoEF.razor) for example usage.
## What's Next
* More UI Updates - large field data (rule name, success, expression) autosize?
* Pretty JSON Expression Handling - Prism Live?
* PDF Printing, XSLX Export
* Support for more types (ActionInfo, RuleActions, etc.)
* Continued synchronization with releases of Microsoft Rules Engine
* Blazor Desktop
***
This work is licensed under a
[Creative Commons Attribution 4.0 International License][cc-by].
[![CC BY 4.0][cc-by-image]][cc-by]
[cc-by]: http://creativecommons.org/licenses/by/4.0/
[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg
[:heart: Sponsor](https://github.com/sponsors/alexreich)