What is Rubiflow

Rubiflow is an integrated process designer to help users build and manage data flows with a visual, end-to-end event-based orchestrator. The data access engines of Rubiflow provide a powerful, easy-to-use user interface that facilitates seamless collaboration and reuse of processes and common metadata.
In Rubiflow, we handle data and perform data orchestration (check the accuracy of existing models) for which multiple models are available.

Creating a Workflow

To create a workflow, follow the steps given below.

  1. On the home page, click the Create icon (  ).
  2. Hover over the rubiflow tile and click the Create Workflow button.

    Figure: Creating a Workflow

    Create Workflow screen is displayed.

  3. Enter the Name for your workflow.
  4. Enter the name in the Project field to create a new project.

    (info)

    Notes:

    • The workflow is created under the entered project name.
    • You can also type the name of the existing project in the Project field to select the project.
    • Project name is mandatory.
  5. Enter the Description for your workflow.

  6. Review all fields and click Create.
    Figure: Create Workflow
    The workflow is created, and workflow canvas is displayed.

Understanding the Workflow Canvas

The workflow canvas is the area where you can build algorithm flows. When you open a workflow, the following icons and fields are displayed.

Figure: Workflow Canvas

The workflow screen has four panes as given below.

  1. Task Pane: This pane displays the datasets and algorithms that can be used in the workflow.
  2. Function Pane: This pane displays the various functions that can be performed on the workflow.
  3. Workflow Canvas: The work area where you can drag-and-drop algorithms and datasets to create workflows.
  4. VIEW LOG: This tab displays the logs and activity trace of the workflow execution.

The table given below describes the fields and icons present on the Workflow Canvas.

Table: Description of Fields for Workflow Canvas

Icons/Fields

 Description

Task pane


It displays the list of datasets and algorithms that can be used in the workflow.

Name of the workflow

It displays the title of the workflow.

Zoom

It helps to move your point of view closer to or further away from the canvas. It works as a screen magnifier which changes the detailing level of the canvas to be seen.

Minimap

It displays a scaled down version of the workflow.

Save

It saves your workflow.

Save As

It saves your workflow with a different name.

Run

It runs the created algorithm flow.

Hyperparameters

It is the set of values of the algorithm properties at which the algorithm gives the best results.

Snapshot

It takes the snapshot of the created algorithm flow. The snapshot can be restored later for version control.
For more information, refer to Using Snapshot for Version Control.

Schedule

It allows you to schedule your workflows. You can set a specific date and time to run it automatically and receive results.
For more information, refer to Using Rubiflow Scheduler.

Workflow Canvas


It is the area to experiment with your datasets and algorithms. You can use the drag-and-drop method to insert datasets and algorithms in the workflow canvas.

VIEW LOG


It displays the logs of the algorithm flow that are run.


Building Algorithm Flow in a Workflow Canvas

Building algorithm flow in a Workflow Canvas is similar to building algorithm flow in a Workbook Canvas. You can use your trained algorithms here.
To build algorithm flow in a Workflow Canvas, refer to Building Algorithm Flow in a Workbook Canvas.
Workflow canvas allows you to publish your models which can be used in final production. To publish your models, refer to Publishing Models.
Also, workflow canvas provides an additional facility to schedule your workflows. To schedule your workflows, refer to Using Rubiflow Scheduler.

Working with Workflows

Workflow are the production area where can use the trained algorithms. There are mainly four functions that can be performed with workbooks.

  1. Opening a Workflow
  2. Editing a Workflow
  3. Running a Workflow
  4. Deleting a Workflow

The following sections describe each of these functionalities in detail.

Searching a Workflow

You can search for a workflow by its name. It is especially helpful when the workflow list is long.

(info) Note:

Make sure you are in the correct Workspace, which includes the Workflow that you want to search.

To search a project, follow the steps given below.

  1. Open the Workspace that includes your project. Refer to Changing Workspace.
  2. On the home page, click Workflows.
    Recent Workflows for the selected workspace are displayed
  3. Type the workflow name in the Search field.
    As you start typing, the list of workflows whose name or description match with the search string is populated, as shown in the figure below.

Figure: Searching a Workflow

(info)Notes:

  • Click the ellipsis corresponding to a project, to Run or Delete the workflow. Refer to respective topics for more information.
  • To open a workflow, hover over the workflow tile and click View.

Opening a Workflow

To open a workflow, follow the steps given below.

  1. On the home page and click Workflows.
    Recent Workflows for the selected workspace are displayed.
  2. Hover over the workflow you want to open and click View.

Figure: Opening a Workflow

Your selected workflow canvas is displayed.

Editing a Workflow

To edit the workflow, follow the steps given below.

  1. On the home page, click Workflows.
    Recent Workflows for the selected workspace are displayed.
  2. Hover over the workflow you want to edit and click View.
    The workflow canvas is displayed.
  3. Edit the workflow using the drag-drop method to insert datasets and algorithms from the task pane.
    For more information, refer to Building Algorithm Flow in a Workflow Canvas.
  4. Once the workflow editing is complete, click the Save ( ) icon on the function pane.

Changes to the workflow are saved.

(info)Note:

To save the workflow with a different name, click the ellipsis ( ) on the function pane and then click Save As icon (  ).

Running a Workflow

You can run the existing workflow.
You can run a workflow either from Card View or from Workflow Canvas.

(info)Note:

After you have run the workflow, check the logs for more information about execution details. Refer to Viewing Logs in Workflow.


Running from Card View

To run a workflow from card view, follow the steps given below.

  1. On the home page, click Workflows.
    Recent Workflows for the selected workspace are displayed.
  2. Hover over the workflow you want to run, click the vertical ellipsis (  ), and then click Run.

    (info) Note:

    To stop the execution before completion, click the ellipsis and click Abort.


    Figure: Running a Workflow
    After the run is successfully completed, the status of the Workflow is displayed as Completed on the card.
    Figure: Status of Workflow
    The other status is displayed as,
  • Running: The run has initiated
  • Failed: The run has failed and could not be completed

Running from Workflow Canvas

To run a workflow from the workflow canvas, follow the steps given below.

  1. Open a Workflow. Refer to Opening a Workflow.
    Workflow canvas is displayed.
  2. Click the Run icon (  ) located in the top-right corner on the function pane.

The workflow execution starts.
After the run is completed, the result is displayed with following icons:

— The algorithm flow has run successfully.

— The algorithm flow has failed to run.


(info) Note:

To stop the execution before completion, click the Abort icon (  ).

Viewing Logs in Workflow

When you run an algorithm, rubiscape generates a log of the tasks that are performed in background. The log shows task name, type, duration, and status. The logs and activity trace are particularly helpful for troubleshooting.
To view log, follow the steps given below.

  1. Open a Workflow. Refer to Opening a Workflow.
  2. Click the Run icon (  ) located in the top-right corner on the function pane.
    The workflow execution starts.
  3. During the execution or after completion, Click VIEW LOG.
    Logs are displayed as shown in the figure below.

Figure: Workflow Log

Log: It displays the details such as Task Name, Task Type, Status, and so on.
Trace: It displays the details of execution. You can track the error if your execution fails.


Figure: Workflow Log Trace

The log trace shows more details such as the username, workbook name, and timestamp of each of the activities.
The log status can have one of these values: Yet to Start, Running, Completed, and Failed.

Deleting a Workflow

To delete a workflow, follow the steps given below.

  1. On the home page, click Workflows.
    Recent Workflows for the selected workspace are displayed.
  2. Hover over the workflow you want to delete, click the vertical ellipsis (  ); and then click Delete.

    Figure: Deleting a Workflow
    A message to confirm your action is displayed.
  3. To delete the workflow, click Delete.
    The selected workflow is deleted and a confirmation message is displayed.


Using Rubiflow Scheduler

The Rubiflow Scheduler helps you to schedule workflows to run at pre-decided time intervals. The scheduled workflows execute at the set time without any user intervention. This makes it easy to automate certain processes.
To schedule your workflow, follow the steps given below.

  1. Open the workflow that you want to schedule. Refer to Opening a Workflow.
  2. Click the ellipsis (  ) located on the function pane.
  3. From the options displayed, click the Schedule ( ) icon.
    Schedule List is displayed.
  4. Click Create Schedule.

    Figure: Schedule List

    (info) Note:

    To Edit or Delete the scheduled run, Click the ellipsis ( ) corresponding to it.

    Create Schedule page is displayed.

  5. Enter/select the required fields.

    Figure: Creating a Schedule

    The table given below describes the fields and buttons present on the create schedule screen.

    Table: Description of Fields on Create Schedule
    FieldDescription
    NameEnter the title for the scheduled run.
    DescriptionEnter a short description for the scheduled run.
    Schedule



    Schedule to run data

    Select the time period on which it should be run - monthly, weekly, or daily.

    Active

    Select active check box to keep your schedule active.

    Start Date/End Date

    Select the date from when you want to schedule the run till the date where you want to end it.

    SELECT DAY

    In case of weekly schedule, select the day of the week for the run.

    Run Time

    Enter the time that you want to set for scheduled run. Please note, this time is in UTC.

    Notify Run Status


    IN-APP NOTIFICATION

    Select IN-APP NOTIFICATION check box to enable the notifications; clear it otherwise.

    EMAIL NOTIFICATION

    Select EMAIL NOTIFICATION check box to enable the notifications via email; clear it otherwise.

    Email Address

    Enter the email address where you want the notification to be sent.

    Message

    Enter the message to be used in the notification email.

  6. Click Create.
    Upon successful creation, your schedule is displayed in the schedule list and the workflow runs at the schedule time.

Building Recursive Workflow

Rubiscape provides a feature that enables execution of a complete workflow inside another workflow. This helps to execute multiple workflows with a single click.

To build a recursive workflow, follow the steps given below.

  1. Open the Workspace where you want to create your workflow. Refer to Changing Workspace.
  2. Create a Workflow. Refer to Creating a Workflow.
  3. Drag and drop Workflow Task on the canvas.

    Figure: Workflow Task in rubiflow

    (info)

    Notes:

    • Workflow task does not require any predecessor or successor. It can be used without connecting to a reader or any other algorithms.
    • You can connect reader nodes and other algorithm nodes to Workflow Task, if required. However, this is optional.
  4. Select Workflow Task.
    Properties are displayed in the right pane.
  5. From the Select Workflow drop-down, select the name of the workflow you want to execute in recursion.
    Figure: Selecting Workflow Task
  6. Save the workflow.
  7. Run the workflow.

    First, the workflow selected in step 6 is executed, and then the tasks in the current workflow are executed.

    After successful completion of all workflow execution, a confirmation message is displayed.

    (info)

    Notes:

    • You can only use workflows that belong to the same project.
    • You can add multiple workflows for recursive workflow task execution.
    • If you add more than one recursive workflow tasks in a workflow, you need to connect them to determine the execution sequence.
    • Adding predecessor or successor node to Workflow Task is optional. Even if you add predecessor or successor node, Workflow Task doesn’t take any input from its Predecessor and also does not give any output to its Successor
    • If the Workflow Task has any connecting nodes (predecessor or successor), the workflow task is executed first, and then the rest of the nodes in the workflow are executed.
    • The workflow execution sequence is LIFO – Last In Fast Out.
      For example, If Workflow1 calls Workflow2, and Workflow 2 calls Workflow3 and you run Workflow1, then the execution sequence is - Workflow3 is executed first, followed by Workflow2 and in the end Workflow1 is executed.
    • If Workflow Task fails, then its successor will not be executed.

Table of contents