Rulecube Documentation

Appearance

v2.6

Create a Workflow ​

Introduction ​

This guide assumes you are familiar with workflows. If not, see the Tutorial: Using Workflows.

Procedure ​

Let's create a workflow for the earlier-mentioned loan application process:

Step 1: Create the basic workflow ​

  1. Create a new ruleset named LoanAssessment.
  2. Select Version settings from the left-side menu.
  3. Select the Workflow checkbox.
    ↳ Rulecube turns the ruleset into a workflow and adds the Workflow option to the left-hand menu, and creates the state input and the State entity:
  4. Create an input named LoanAmount
    1. Set its Type to number
    2. Check the "Add to state" checkbox.
  5. Select the State entity and click Add property.
  6. In the Name field, enter Status.
  7. In the Type list, select string.
  8. In the Default value (optional) field, enter new.
  9. Click Save.

Step 2: Add steps to the workflow ​

  1. Select Workflow from the left-side menu.
    ↳ Rulecube shows the Workflow canvas where you create the workflow by dragging en connecting steps.

  2. Drag a Swith step to canvas.
    ↳ Rulecube gives the step a default name.

  3. Select the Switch step.
    ↳ The Switch details section opens:

  4. In the Step name field, enter Assessment check.

  5. In the Description field, enter Requested loan amount larger than 100,000?

  6. Connect the Start step to the Assessment check step by clicking on the little circle in the Start step, holding your mouse, and dropping on the left circle of the Assessment check step.
    ↳ Rulecube adds a dotted blue line between the steps to indicate that they are connected:

  7. Drag an Action step to the canvas and set Step name = Assessment and Description = Accept or reject.

  8. Drag another Action step to the canvas and set Step name = Accept.

  9. Connect the Assessment check step to the Assessment step.
    ↳ Rulecube asks for a name for the connection, enter true, and click OK.

  10. Connect the Assessment check step to the Accept step.
    ↳ Rulecube asks for a name for the connection, enter false, and click OK. And now, the Assessment check (switch) step has proceedings for whether its condition is true or false.

  11. Drag a Wait step to the canvas and set Step name = Wait.

  12. Connect the Assessment step to the Wait step.

  13. Drag an Action step to the canvas and set Step name = Reject.

  14. Connect the Wait step to the Accept step and name the connection Accept.

  15. Connect the Wait step to the Reject step and name the connection Reject.

  16. Drag an End step to the canvas.

  17. Connect the Accept step and the Reject step to the End step.
    ↳ Maybe you have to rearrange the steps, but your workflow canvas should look like this:

  18. Save the workflow.

Step 3: Add processing to the steps ​

  1. Select the Start step and set its Expression to the following code:

    javascript
    state.LoanAmount = LoanAmount;
    return;

    Select the Assessment check step and set its Expression to the following code:

  2. return state.LoanAmount > 100000

    Explanation
    This code checks whether the loan amount is larger than 100,000 and results in either true or false.

  3. Select the Assessment step and set its Expression to the following code:

    javascript
    state.Status = 'under review';

    Workflow.createNextSignalUrl('Accept');
    Workflow.createNextSignalUrl('Reject');

    return;

    Explanation
    This code sets the status and creates the possible answers or responses (signals) for the assessor.

  4. Select the Accept step and set its Expression to the following code:

    javascript
    state.Status = 'accepted';

  5. Select the Reject step and set its Expression to the following code:

    javascript
    state.Status = 'rejected';

  6. Save your workflow.

Step 4: Call the workflow via its API ​

Basically, calling a workflow works the same as calling a ruleset. Only the URL is different:

<<Your rulecube URL>>/api/workflow/start

Some additional inspiration ​

The above procedure creates only basic signals for the assessor. In practice, you could include the signals (as URLs) in an e-mail so that the recipient can respond to them, thus completing the workflow. Then, the Expression for the Assessment step could look something like this:

javascript
let acceptUrl = Workflow.createNextSignalUrl('Accept');
let rejectUrl = Workflow.createNextSignalUrl('Reject');

let body = `Hi,
<br>
<a href="${acceptUrl}">Accept</a> or <a href="${rejectUrl}">Reject</a>`;

Mail.send({
    host: "SMTP_SERVER",
    port: 587,
    secure: false,
    auth: {

    }
}, {
    from: '"SENDER_NAME" <SENDER_EMAIL_ADDRESS>',
    to: [RECIPIENT_EMAIL_ADDRESS],
    subject: 'Loan assessment',
    html: body
})

⇨ Replace and add the values and parameters that apply to your situation.

With this, the Assessment step sends an email to the assessor. Until the assessor responds by clicking Accept or Reject in the email, the workflow waits and suspends itself. And when the assessor responds, the workflow resumes.