Rubiscape provides the facility to declare a variable at the workbook level. You can add a variable, edit its value, and also delete it when it is no longer required. You can use this variable in Custom Components and even in conditional task execution.

You can define a variable or add result of an algorithm as a variable.

Adding a Variable

You can add your own variable which can be used anywhere in the workbook or workflow. The below steps mention how to add a variable in a workbook. Similar steps can be performed to add a variable in a workflow.

To add a variable at the workbook level, follow the steps given below.

  1. Open the required workbook or create a new workbook. Refer to Opening a Workbook or Creating a Workbook. 
    The selected workbook canvas is displayed.
  2. Click (x) Variable in the Function Pane of the workbook.

    Figure: Variable Option in Function Pane
    Manage Variable page is displayed.
  3. Click Add Variable.

    Figure: Add Variable Screen
  4. Enter the variable name in the Variable field, the default value of the variable in the Default Value field, and its current value in the Current Value field.

    (info) Notes:
    • The value entered for the Current Value can be different from the Default Value if you want to use the current value in a particular task and the default value for the workbook's remaining tasks.
    • By default, Rubiscape uses the current value every time the variable is used in a workbook or workflow.
  5. Click Save ().
    Figure: Adding a Variable
    A confirmation message is displayed and the variable is added to the workbook.
  6. Click Close () to close the window.
    You are redirected to the workbook canvas.

    (info) 

    Notes:

    • This user-defined variable can be used in any task in the workbook as a tuning parameter.
    • The current value replaces the default value of the variable in the selected task to be executed.
    • To add more variables, repeat steps 3 to 5.
    • Edit icon ( ) and Delete icon ( ) appear after you add a variable.

Adding Result as a Variable

Along with defining a workbook level variable, you can also add the result of a regression or classification algorithm as a variable. This result added as a variable can be used in the workbook for further processing.

To add the result of an algorithm as a variable at the workbook level, follow the steps given below.

  1. Open the required workbook or create a new workbook. Refer to Opening a Workbook or Creating a Workbook. 

    The workbook canvas is displayed. 

  2. Add a Reader.
  3. Add any Regression or Classification algorithm.
  4. Connect the Reader node to the algorithm node.
  5. Select the algorithm node. From the right pane, select its properties.
  6. Click Add result as a variable drop-down.

    A list of variables available for the selected algorithm is displayed.

    Note:
    • This option is available only for Regression and Classification algorithms.
    • Select the Select All checkbox to add all parameters as variables.
  7. Select the checkboxes corresponding to the parameters you want to add as variable and click Done.
    Figure: Selecting Variables to be Added as Result
  8. Save the workbook.
  9. Run the algorithm.

    After successful execution, the selected parameters are added as variables.

    To view the variables, Click (x) Variable in the Function Pane of the workbook.
    Figure: Newly added variables
    You can use these variables in any task in the workbook as tuning parameters.

Editing a Variable

To edit a variable, follow the steps given below.

  1. Open the required workbook. Refer to Opening a Workbook.
    The selected workbook canvas is displayed.
  2. Click (x) Variable in the Function Pane of the workbook.
    Figure: Variable Option in Function Pane
    Manage Variable page is displayed.
  3. Locate the variable you want to edit and click the Edit icon () corresponding to it.
    Figure: Editing a Variable
  4. Edit the Default Value and Current Value as required.

    (info) Note:

    Use the Reset icon ( ) to reset the Current Value to Default Value.

  5. Click Save ().

    The values are updated and a confirmation is displayed.

  6. Click Close ( ) to close the window.
    The values are updated and you are redirected to the workbook canvas.


Deleting a Variable

To delete a variable, follow the steps given below.

  1. Open the required workbook. //Cross reference to Opening a Workbook
    The selected workbook canvas is displayed.
  2. Click (x) Variable in the Function Pane of the workbook.
    Figure: Variable Option in Function Pane
    Manage Variable page is displayed.
  3. Locate the variable you want to delete and click the Delete icon () corresponding to it.
    Figure: Deleting a Variable
    A confirmation is displayed and the variable is deleted.
  4. Click Close ( ) to close the window.
    You are redirected to the workbook canvas.


Table of Contents