BrainGrid Controller
Workflow Builder
Events
Table Actions Event

Table Action Events

Table Action Events enhance the interactivity and functionality of your workflows by allowing you to configure how data is viewed, copied, shared, and managed. This documentation covers the various types of Table Action Events and their configurations.

View Event

The View Event allows you to display data from a table in different modes and with various input types. This is useful for presenting information to users based on their actions within the workflow.

Overview

The View Event can be configured with different modes and input types to control how and what data is displayed.

Configuring View Event

View Event with Current Input Type

To set up a View Event with the Current input type:

  1. Mode of View: Select "in page" to display data within the page.
  2. Input Type: Choose "Current" to use data from the currently selected row.

Example:

  • Title: Current Row View
  • Description: Displays data from the selected row within the page.
  • Mode of View: In Page
  • Input Type: Current

View Event with Constant Input Type

To set up a View Event with the Constant input type:

  1. Mode of View: Select "drawer" to display data in a drawer.
  2. Input Type: Choose "Constant" to use data from a specific row.

Example:

  • Title: Constant Row View
  • Description: Shows data from a specific row in a drawer.
  • Mode of View: Drawer
  • Input Type: Constant

View Event with Data Carry Input Type

To set up a View Event with the Data Carry input type:

  1. Mode of View: Select "modal" to display data in a modal.
  2. Input Type: Choose "Data Carry" to use data carried from a previous node.

Example:

  • Title: Data Carry View
  • Description: Displays carried data in a modal.
  • Mode of View: Modal
  • Input Type: Data Carry

Validating and Testing View Events

To ensure View Events are working correctly:

  1. Review Configuration: Confirm the mode of view and input type.
  2. Trigger Events: Simulate scenarios to verify data is displayed correctly based on the input type and mode of view.

Testing Examples:

  • Current Input Type: Check that data from the current row is displayed within the page.
  • Constant Input Type: Verify that data from a specific row appears in a drawer.
  • Data Carry Input Type: Ensure carried data is shown in a modal.

Copy Row Event

The Copy Row Event allows you to duplicate row data within a table, making it easy to replicate information or create new entries based on existing data.

Overview

The Copy Row Event can be configured to copy individual or multiple rows and can include data transformations during the copying process.

Configuring Copy Row Event

Basic Copy Row Event

To configure a basic Copy Row Event:

  1. Mode of Copying: Select the method for copying row data.

Example:

  • Title: Basic Copy Row
  • Description: Copies data from selected rows to new rows.
  • Mode of Copying: Standard Copy

Copy Row Event with Data Transformation

To configure a Copy Row Event with data transformation:

  1. Apply Transformation: Choose any data transformation rules to be applied during the copy process.

Example:

  • Title: Transformed Copy Row
  • Description: Copies and transforms row data based on specified rules.
  • Mode of Copying: Copy with Transformation

Validating and Testing Copy Row Events

To ensure Copy Row Events work as expected:

  1. Review Configuration: Confirm the mode of copying and any transformations.
  2. Trigger Events: Verify that the row data is copied correctly and that transformations are applied if configured.

Testing Examples:

  • Single Row: Ensure a single row is copied and a new row is created.
  • Multiple Rows: Verify that multiple rows are copied and new rows are created.
  • Data Transformation: Check that data transformations are applied during the copy process.

Share Event

The Share Event allows you to share data from rows in various modes, such as Drawer or Modal, providing options for how data can be shared.

Overview

The Share Event can be configured with different execution modes to control how share options are presented.

Configuring Share Event

Share Event in Drawer Mode

To configure a Share Event for Drawer execution:

  1. Mode of Execution: Select "Drawer" to display share options in a drawer.

Example:

  • Title: Drawer Share
  • Description: Opens a drawer with share options for the selected row.
  • Mode of Execution: Drawer

Share Event in Modal Mode

To configure a Share Event for Modal execution:

  1. Mode of Execution: Select "Modal" to display share options in a modal.

Example:

  • Title: Modal Share
  • Description: Opens a modal with share options for the selected row.
  • Mode of Execution: Modal

Validating and Testing Share Events

To ensure Share Events are functioning correctly:

  1. Review Configuration: Confirm the mode of execution.
  2. Trigger Events: Test that share options are displayed correctly based on the selected mode.

Testing Examples:

  • Drawer Mode: Ensure share options are presented in a drawer.
  • Modal Mode: Verify that share options are shown in a modal.
  • Multiple Rows: Test sharing options when multiple rows are selected.

QR Code Event

The QR Code Event allows you to generate and display QR codes based on various data input types. This feature is useful for encoding information in a scannable format.

Overview

The QR Code Event can be configured with different input types to generate QR codes with constant data or data carried from previous nodes.

Configuring QR Code Event

QR Code Event with Constant Data

To configure a QR Code Event with Constant data:

  1. Input Type: Select "Constant" to use predefined data.
  2. Enter Data: Specify the constant data to encode in the QR code.

Example:

  • Title: QR Code with Constant Data
  • Description: Generates a QR code with predefined constant data.
  • Input Type: Constant

QR Code Event with Data Carry

To configure a QR Code Event with Data Carry:

  1. Input Type: Select "Data Carry" to use data carried from a previous node.

Example:

  • Title: QR Code with Data Carry
  • Description: Generates a QR code with data carried from a previous node.
  • Input Type: Data Carry

Validating and Testing QR Code Events

To ensure QR Code Events are working correctly:

  1. Review Configuration: Confirm the input type and data.
  2. Trigger Events: Test that QR codes are generated correctly and match the input data.

Testing Examples:

  • Constant Data: Verify that the QR code encodes the constant data and displays correctly.
  • Data Carry: Ensure the QR code encodes the carried data and displays correctly.
  • Scanning: Check that scanned QR codes match the original input data.
  • Error Handling: Ensure the system handles invalid data gracefully and provides appropriate error messages.

Copy Data Event

The Copy Data Event allows you to duplicate data across nodes or workflows, enabling easy replication of information.

Overview

The Copy Data Event can be configured to copy constant data or data carried from previous nodes, with options for error handling and validation.

Configuring Copy Data Event

Copy Data with Constant Data

To configure a Copy Data Event with Constant data:

  1. Input Type: Select "Constant" to use predefined data.
  2. Enter Data: Specify the constant data to copy.

Example:

  • Title: Copy Data with Constant Data
  • Description: Copies predefined constant data.
  • Input Type: Constant

Copy Data with Data Carry

To configure a Copy Data Event with Data Carry:

  1. Input Type: Select "Data Carry" to use data carried from a previous node.

Example:

  • Title: Copy Data with Data Carry
  • Description: Copies data carried from a previous node.
  • Input Type: Data Carry

Validating and Testing Copy Data Events

To ensure Copy Data Events work as expected:

  1. Review Configuration: Confirm the input type and data.
  2. Trigger Events: Verify that the data is copied correctly and that any error handling is effective.

Testing Examples:

  • Constant Data: Ensure the constant data is copied accurately.
  • Data Carry: Verify that carried data is copied correctly.
  • Data Integrity: Check that copied data matches the original data.
  • Error Handling: Ensure invalid data is not copied and appropriate error messages are displayed.

Manage Schedule Event

The Manage Schedule Event allows you to schedule and manage events within your workflow, providing options for configuring, viewing, and validating schedules.

Overview

The Manage Schedule Event includes features for adding, editing, deleting, and restoring schedules, as well as validating schedule conflicts and permissions.

Configuring Manage Schedule Event

Add Schedule for Configured Event

To add a schedule for a specific event:

  1. Select Event: Choose the event to be scheduled.
  2. Set Schedule Details: Specify the schedule details.

Example:

  • Title: Add Schedule for Event
  • Description: Adds a schedule for the specified event.
  • Details: Includes time, date, and recurrence options.

View All Schedules

To view all configured schedules:

  1. Navigate to Manage Schedule: Access the Manage Schedule section.

Example:

  • Title: View All Schedules
  • Description: Displays all existing schedules for events.

Edit Existing Schedule

To edit an existing schedule:

  1. Select Schedule: Choose the schedule to edit.
  2. Update Details: Modify the schedule details as needed.

Example:

  • Title: Edit Existing Schedule
  • Description: Updates details of an existing schedule.

Delete Existing Schedule

To delete an existing schedule:

  1. Select Schedule: Choose the schedule to delete.

Example:

  • Title: Delete Existing Schedule
  • Description: Removes the selected schedule.

Restore Deleted Schedule

To restore a deleted schedule:

  1. Select Deleted Schedule: Choose the deleted schedule to restore.

Example:

  • Title: Restore Deleted Schedule
  • Description: Restores a previously deleted schedule.

Validating and Testing Manage Schedule Events

To ensure Manage Schedule Events are functioning correctly:

  1. Review Configuration: Confirm the schedule details and options.
  2. Trigger Events: Test schedule addition, editing, deletion, and restoration.

Testing Examples:

  • Add Schedule: Verify that schedules are added correctly and confirm with a notification.
  • View Schedules: Ensure all configured schedules are displayed accurately.
  • Edit Schedule: Check that updates are saved and reflected.
  • Delete and Restore Schedules: Confirm schedules can be deleted and restored as expected.

Discussion Forum

The Discussion Forum module allows users to interact by creating, replying to, editing, and managing discussion threads. It also includes features for searching, filtering, and reporting content.

Overview

The Discussion Forum includes functionalities for viewing, creating, and managing discussion threads and replies, with options for user interaction and content management.

Using the Discussion Forum

View Existing Discussion Threads

To view existing discussion threads:

  1. Navigate to Forum: Access the Discussion Forum module.

Example:

  • Title: View Existing Threads
  • Description: Displays all discussion threads.

Create New Discussion Thread

To create a new discussion thread:

  1. Enter Title and Message: Provide a title and initial message.

Example:

  • Title: Create New Thread
  • Description: Saves a new discussion thread with the provided title and message.

Reply to a Discussion Thread

To reply to an existing thread:

  1. Enter Reply Message: Provide a reply message.

Example:

  • Title: Reply to Thread
  • Description: Saves and displays a reply within the thread.

Edit a Discussion Thread

To edit a discussion thread:

  1. Update Title or Message: Modify the title or message of the thread.

Example:

  • Title: Edit Discussion Thread
  • Description: Updates the thread details.

Delete a Discussion Thread

To delete a discussion thread:

  1. Select Thread: Choose the thread to delete.

Example:

  • Title: Delete Discussion Thread
  • Description: Removes the selected thread.

Restore a Deleted Discussion Thread

To restore a deleted thread:

  1. Select Deleted Thread: Choose the deleted thread to restore.

Example:

  • Title: Restore Deleted Thread
  • Description: Restores a previously deleted thread.

Validating and Testing Discussion Forum Features

To ensure the Discussion Forum features are working as intended:

  1. Review Configuration: Confirm forum settings and user permissions.
  2. Trigger Features: Test thread creation, replies, edits, deletions, and restorations.

Testing Examples:

  • Create and Edit Threads: Verify that threads can be created and edited successfully.
  • Reply Management: Check that replies are saved and displayed correctly.
  • Search and Filter: Ensure threads can be searched and filtered as expected.
  • User Interaction: Test features like mentioning users and uploading attachments.