Skip to main content

Form Brick

PurposeLearn about the various configurations and parameters required for the Form Brick to function correctly.
Last updatedAugust 02, 2024

What is a Form Brick?​

These Bricks are employed to manually trigger the Playbook. They operate by connecting the output and dragging the arrow to the new Brick.

There are two ways of creating Forms. The first one is by going to the Form App and selecting the "ADD FORM" button. This will open a tab called "Form editor" where you can:

  • Name the Form
  • Add a description
  • Incorporate different elements based on what the Form is meant to accomplish

The second way to configure Forms is by tasks, which is a way to set up Forms automatically from another software (like Python). You can add a task in two different ways, the first one would be by clicking on the three dotted button located at the top right corner of each Playbook in the main pane, the second way would be by adding "/tasks" after the webpage URL, for example:

https://raven.dtact.com/playbook/{PLAYBOOK_ID}/tasks

This will take you to a new tab showing:

  • All tasks within the form
  • Node where the task is located
  • Status: Is the task running, paused or is there an error
  • RunAt: which tells when the task is supposed to run
  • CreatedAt: tells you when the task was created

By clicking on a specific task, you can see the progress of the tasks and subtasks. At the same time, next to the name of the task, we can see some icons which, when clicked, will show the configuration and data going through the tasks.

These tasks are very useful for debugging since they show what is happening in the Brick.

Form Brick configuration supporting video​

Form Brick Parameters​

  1. Form URL: Through this URL the form shared to the different end users to fill.

Once the form is filled and submitted the playbook will be triggered.

  1. Label: This is where the user can provide a name for the brick.

  2. Form: Here is where the user selects the previously created form which will be in use and connected to the URL for the end user to fill and submit.

Form Brick output format​

In this section of the documentation the user will learn where are the outputs of the brick stored and its format.

  1. Name of variable: form

    • Format:
      • data (dictionary): Data stored inside the form

  2. Name of variable: user

    • Format:
      • user_id (String): A unique identifier for the user, represented as a UUID.
      • full_name (String): The full name of the user.
      • email (String): The email address of the user.

  3. Name of variable: organisation

    • Format:
      • organisation_id (String): A unique identifier for the organisation.
      • name (String): The name of the organisation.