Raven Forms
| Purpose | To gain a better understanding of Forms, how they work and what they can do for you read the following documentation. |
|---|
| Last updated | October 24, 2024 |
|---|
What are Forms
Forms are interactive tools that allow users to capture and submit data to initiate or support automated workflows within the Raven Portal. Forms are used for gathering specific input from users, which can then be used to execute actions, gather insights, or fulfill workflow requirements. Each form is customizable, containing various components (like text fields, checkboxes, file uploads, etc.) to meet the needs of different data collection scenarios.
Forms as Bricks
In the Raven Portal, Forms are integrated into workflows as Form Bricks.
A Form Brick is a special type of action within a Playbook that triggers an event or task when the form is completed and submitted. As part of a Playbook, Form Bricks allow users to manually trigger workflows by linking outputs from the form to subsequent actions, therefore moving data seamlessly to the next step in the workflow.
By setting up forms as Bricks, SOC analysts and other users can easily gather input and start workflows with user-provided data, streamlining the data collection and execution process.
Forms App Overview
Accessing Forms
The Forms app can be found in the Action Module. This is where users can manage and review all pre-created forms. It includes essential details about each form:
- Name: Identifies the purpose or type of the form.
- Description: Provides a summary of the form's purpose or context.
- Creation Date and Last Updated Date: Tracks when the form was initially created and last modified.
Action Buttons
At the top-right corner of each form:
- Preview (Eye Icon): Allows users to view a preview of the form.
- Three-dot Menu: Options to edit or delete the form.
Main Interface Actions
In the main interface, there are additional buttons:
- New Form: Opens the Form Editor to create new forms.
- Display Mode: Allows users to toggle how forms are displayed.
Creating and Editing Forms
Creating a New Form
The New Form button opens the Form Editor, where users can:
- Name the form by adding a title.
- Add extra information by giving a description.
- Add components.
After filling in the required and desired fields, the user can save the form by selecting the Save Changes button located at the top right corner of the interface.
Form Components
Various components can be added based on the intended functionality of the form.
Each Form can include the following components:
- Text: For short text inputs.
- Text Area: For longer text entries.
- Date: Allows date selection.
- Select and MultiSelect: Dropdown options for single or multiple selections.
- File Upload: Lets users attach files.
- Checkbox and Radio: Options for single or multiple selections.
- Number: For numeric inputs.
- Image: Enables image upload and display.
- Switch: A toggle for on/off options.
- Markdown: Allows formatted text using simple markup.
- Divider: Adds a visual break between form sections.
From the Component pane, users can easily drag components into the Layout pane, where all selected elements are displayed in a clear preview. This setup allows users to see the structure and layout of the Form exactly as it will appear to end users.
Once a component is placed in the layout, clicking on it will display the field details, allowing you to customize specific properties. This includes the following options:
-
name: Defines the internal name of the field, which may be used for data tracking or integration purposes. -
label: The visible label users will see, helping them understand the purpose of each field. -
placeholder: Text that appears inside the field, guiding users on what to enter (disappears once they start typing). -
required: Indicates whether the field must be filled out before the Form can be submitted.
Editing Forms
The user has the flexibility to edit any form created. This can be done in two different ways: by clicking directly on the form or choose the Edit option from the three-dot menu icon associated with the form in the main Forms page.
In edit mode, users can adjust the form's content or settings as needed. Any changes will activate the Save Changes button, allowing the form to be updated with a click.
If at any point they decide that the changes are no longer required, they can quickly revert to the original version by clicking the Reset Changes button located in the top-right corner of the interface. This option provides an easy way to discard edits and maintain the form’s original setup without needing to manually undo each change.
Using a Form
To start using a form, it must be activated.
Activating a form makes it live and usable within a playbook, allowing it to collect input as part of a workflow. This setup enables the form to serve as a manual trigger for specific actions.
To activate a Form, follow these steps:
- Create a new playbook: Begin by creating a new playbook within the Playbooks app.
- Add a Form brick: Search for the Form brick and drag it into the playbook. This action opens a configuration pane on the right side of the page.
- Select the form: Under the Form label, use the dropdown menu to choose the desired form to attach to the Form brick.
- Copy the Form URL: At the top of the configuration pane, locate the form’s URL. Click the link to copy it to the clipboard.
- Paste the URL into a new tab: Open a new browser tab and paste the URL, this will enable access to the form in a separate window.
After following these steps, the form is fully set up and ready to be used within workflows!