BrainGrid Controller
Workflow Builder
Events
Delete a Record Event

Delete Record Event Setup

The Delete Record Event feature allows users to automate the process of deleting records within the system. This feature supports configuring events to delete records using the current form, a custom form with constant records, or a custom form with filters and data carry options. The configuration also allows specifying how the deletion should be handled.

Overview

This feature enables users to define events that delete records based on form submissions, predefined records, or specific filters, and can also handle data carry from previous processes. This helps ensure that records are deleted consistently and accurately based on the defined criteria.

Configuring a Delete Record Event

Configure Delete Record Event with Current Form and Ask User to Select Record

To set up an event that deletes a record using the current form:

  1. Title: Enter a descriptive title for the event.
  2. Description: Provide a description of the record deletion.
  3. Form: Select "Current Form."
  4. Record Deletion Method: Choose "Ask User to select and delete the record."
  5. Filters: Choose not to apply filters.
  6. Data Carry: Choose not to carry data.

Steps:

  1. Alice Johnson is setting up a "Delete Record" event.
  2. Enter the following details:
    • Title: Delete User Record
    • Description: Delete an existing user record
  3. Select Current Form.
  4. Choose Ask User to select and delete the record.
  5. Choose No Filters and No Data Carry.
  6. Save the configuration.

Outcome: The Delete Record event will prompt the user to select and delete the record, with no filters or data carry applied.

Configure Delete Record Event with Custom Form and Set Constant Record

To set up an event that deletes a specific record using a custom form:

  1. Title: Enter a descriptive title for the event.
  2. Description: Provide a description of the record deletion.
  3. Form: Select "Custom Form."
  4. Menu: Choose the menu where the form is located.
  5. Window: Select the window within the menu.
  6. Record Deletion Method: Choose "Set the constant record to delete."
  7. Selected Record: Choose the record to delete.
  8. Filters: Choose not to apply filters.
  9. Data Carry: Choose not to carry data.

Steps:

  1. Alice Johnson is setting up a "Delete Record" event.
  2. Enter the following details:
    • Title: Delete Animal Record
    • Description: Delete an existing animal record
    • Menu: Animal Management Records
    • Window: Animal Registration
  3. Select Custom Form.
  4. Choose Set the constant record to delete.
  5. Select the record to delete.
  6. Choose No Filters and No Data Carry.
  7. Save the configuration.

Outcome: The Delete Record event will delete the specified record with no filters or data carry applied.

Configure Delete Record Event with Custom Form and Apply Filter

To set up an event that deletes records using a custom form with a filter:

  1. Title: Enter a descriptive title for the event.
  2. Description: Provide a description of the record deletion.
  3. Form: Select "Custom Form."
  4. Menu: Choose the menu where the form is located.
  5. Window: Select the window within the menu.
  6. Record Deletion Method: Choose "Set the constant record to delete."
  7. Selected Record: Choose the record to delete.
  8. Filters: Apply a filter to specify which records to delete.
  9. Data Carry: Choose not to carry data.

Steps:

  1. Alice Johnson is setting up a "Delete Record" event.
  2. Enter the following details:
    • Title: Filtered Delete Animal Record
    • Description: Delete filtered animal records
    • Menu: Animal Management Records
    • Window: Animal Registration
  3. Select Custom Form.
  4. Choose Set the constant record to delete.
  5. Select the record to delete.
  6. Apply the filter:
    • Field: Species
    • Relation: equals
    • Value: Dog
  7. Choose No Data Carry.
  8. Save the configuration.

Outcome: The Delete Record event will delete the specified record based on the filter criteria with no data carry applied.

Configure Delete Record Event with Custom Form and Data Carry

To set up an event that deletes records using a custom form with data carry:

  1. Title: Enter a descriptive title for the event.
  2. Description: Provide a description of the record deletion.
  3. Form: Select "Custom Form."
  4. Menu: Choose the menu where the form is located.
  5. Window: Select the window within the menu.
  6. Record Deletion Method: Choose "Set the constant record to delete."
  7. Selected Record: Choose the record to delete.
  8. Filters: Choose not to apply filters.
  9. Data Carry: Choose to carry data from a specified node.

Steps:

  1. Alice Johnson is setting up a "Delete Record" event.
  2. Enter the following details:
    • Title: Data Carry Delete Animal Record
    • Description: Delete animal records with data carry
    • Menu: Animal Management Records
    • Window: Animal Registration
  3. Select Custom Form.
  4. Choose Set the constant record to delete.
  5. Select the record to delete.
  6. Choose to carry data from:
    • Node: Previous Process Node
  7. Choose No Filters.
  8. Save the configuration.

Outcome: The Delete Record event will delete the specified record with data carry from the previous process node and no filters applied.

Validate Delete Record Configuration

To ensure the "Delete Record" event is configured correctly:

  1. Action: Review the configured details.

Expected Outcome:

  • Alice Johnson should see the configured values for:
    • Title
    • Description
    • Form
    • Menu (if Custom Form)
    • Window (if Custom Form)
    • Record Deletion Method
    • Selected Record (if applicable)
    • Filters (if applicable)
    • Data Carry (if applicable)

Trigger Delete Record Event with Current Form

To trigger the Delete Record event using the current form:

  1. Action: Ensure the trigger conditions are met (e.g., record selection).

Expected Outcome:

  • The system should prompt the user to select and delete the record.

Trigger Delete Record Event with Custom Form and Set Constant Record

To trigger the Delete Record event using a custom form with a constant record:

  1. Action: Ensure the trigger conditions are met (e.g., record selection).

Expected Outcome:

  • The system should delete the selected record.

Validate Deleted Record

To verify that the record was deleted correctly:

  1. Action: Check the record details.

Expected Outcome:

  • The record should no longer exist in the system.

Summary

The Delete Record Event Setup feature allows users to configure events for deleting records based on various criteria. Whether using the current form, custom forms with constant records, or applying filters and data carry, this feature ensures records are deleted efficiently and in line with the configured settings.