📖
Rulecube documentation
v2.4
v2.4
  • Overview
  • Quick Start
  • Tutorial
    • Getting started
    • Create and Run Your First Ruleset
    • Use Constants and Methods
    • Create and Call Functions
    • Adding Testcases
    • Using Lookup Tables
    • Using Entities
    • Using Forms
  • How-to Guides
    • Logging in and Authorization
      • Activate Your Account From an Invitation
      • Log in to Rulecube
      • Change Your Password
      • Recover Your Password
      • Two-factor authentication (2FA)
      • Invite Other Users to Rulecube
      • Edit a User's Role
      • Delete a User
    • Ruleset Development
      • Create a Ruleset
      • Set the Input for a Ruleset
      • Create a Rule
      • Generate Alerts
      • Try out a Ruleset
      • Call a Ruleset from Your Software
      • Entities
        • Create an Entity
        • Drag and Drop a JSON Schema or XSD to create entities
        • Entity instantiation
        • Persisted Entities
      • Constants
        • Constant Tables
      • Functions
      • Built-in Functions
      • Create and Run a Testcase
      • Delete a Ruleset or Components
      • Debugging your Ruleset
    • Create a Workflow
      • Workflow step types
      • Working with documents in a workflow
    • Work with (Environment) Variables
    • Call a Ruleset via Its API From Postman
    • Creating input from JSON Schema
    • Use a Ruleset from Your Software
    • Ruleset Productivity Tips
    • Create an Ockto workflow
    • Alert aggregation
    • Forms
      • Introduction and overview
      • Create a Data table
  • Language Reference
    • Global
    • Array
    • Compression
    • Crypto
    • Date
    • Encryption (deprecated)
    • Finance
    • Http
    • Mail
    • MongoDB
    • Ockto
    • PDF
    • SQL
    • Statistics
    • System
    • UserStore
    • Workflow
Powered by GitBook
On this page
  • Creating a Ruleset
  • Adding input
  • Adding a rule
  • Saving your work
  • Trying it out
  • Adding extra rules

Quick Start

If you want to have a really quick start using Rulecube, you can use this guide.

PreviousOverviewNextTutorial

Last updated 2 months ago

To follow along with this guide, it is recommended to open Rulecube in a new browser window or tab.

For this guide we're assuming you're already logged in to Rulecube.

Creating a Ruleset

  1. Go to your Services page.

  2. Click on the + CREATE button to the right of the Ruleset services header.

  3. Pick 'Blank ruleset'.

  4. Enter a name, e.g. My first Ruleset.

Congratulations, you've created your first Ruleset!

You should be presented with this screen now:

Adding input

For your first Ruleset, we will create a simple service with 2 inputs and one output.

  1. Click on the + in the menu on the left next to Input.

  2. Name this input A.

  3. Click the + again to create another input.

  4. Name the new input B.

A message appears that the inputs are unused in this Ruleset. Let's fix that with the next step.

Adding a rule

Now let's create the output for our service. We do this by creating a Rule.

  1. Click on the + in the menu, but this time the one next to Rules.

  2. Name the rule Sum.

  3. Click inside the editor below Expression.

  4. Type the following expression: A + B.

We're done for now. Let's save our hard work!

You should have a set-up like this now:

Saving your work

You'll need to save your changes first to use your Ruleset service.

  1. Click on the SAVE button in the bottom right of your screen.

  2. Enter a comment, e.g. Initial setup.

    1. You may also check "Do not ask again" if you do not want to see this dialog every time you save!

  3. Click OK.

Trying it out

You've just successfully saved your first Ruleset service. Let's see if it works!

  1. Click on the TRY IT OUT! button.

You will now see the Sandbox page in a new tab or window. Don't worry; your Ruleset editor is still on the other tab.

The left side of the screen lists all the inputs. You will find input fields for the A and B inputs.

The right side has the EXECUTE button and will show the results.

Let's try our Ruleset service and see if it can calculate the sum of A and B!

  1. Fill in the input field for A: 2

  2. Fill in the input field for B: 3

  3. Hit the EXECUTE button

If all goes well, you should see Sum with the value of 5 appear on the right.

Adding extra rules

Let's create another rule. This time we'll multiply A and B.

  1. Go back to the My first Ruleset tab in your browser.

  2. Click on the + in the menu next to Rules.

  3. Name this one Multiply.

  4. Enter the following expression: A * B.

  5. Save your work.

  6. Return to the Sandbox tab.

Now we're getting in the flow of working on your Ruleset service and trying it out! This is how you'll be developing and testing your ruleset.

Try out a few other numbers in the input and execute again.

  1. Hit EXECUTE again.

Notice how Multiply has appeared in the result?

This is the end of this quick start tutorial. As an exercise, try adding more Rules to your ruleset!

Scroll to the top of the page