BrainGrid Controller
Workflow Builder
Events
Update a Record Event

Update Record Event Setup

The Update Record Event feature allows users to automate the process of updating existing records within the system. This feature supports configuring events to update records using the current form, a custom form with constant data, or a custom form with user-provided fields. The configuration also allows specifying the creator of the update.

Overview

This feature enables users to define events that update records based on form submissions or predefined data, streamlining the record update process and ensuring consistency across records.

Configuring an Update Record Event

Configure Update Record Event with Current Form

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

  1. Title: Enter a descriptive title for the event.
  2. Description: Provide a description of the record update.
  3. Form: Select "Current Form."
  4. Record Update Method: Choose "Ask User to update the selected record."
  5. Fields to Update: Choose "All Fields."
  6. Created By: Select "Current User" to record the update with the currently logged-in user.

Steps:

  1. Alice Johnson is setting up an "Update Record" event.
  2. Enter the following details:
    • Title: Update User Record
    • Description: Update an existing user record
  3. Select Current Form.
  4. Choose Ask User to update the selected record.
  5. Choose All Fields for the fields to be updated.
  6. Select Current User for Created by.
  7. Save the configuration.

Outcome: The Update Record event will prompt the user to update the selected record, with the update attributed to the current user.

Configure Update Record Event with Custom Form and Set Constant Data

To set up an event that updates a record using a custom form with constant data:

  1. Title: Enter a descriptive title for the event.
  2. Description: Provide a description of the record update.
  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 Update Method: Choose "Set constant data to update the selected record with."
  7. Constant Data: Enter the data to be used for updating the record.
  8. Created By: Select "Custom User" and choose the specific user.

Steps:

  1. Alice Johnson is setting up an "Update Record" event.
  2. Enter the following details:
    • Title: Update Animal Record
    • Description: Update an existing animal record
    • Menu: Animal Management Records
    • Window: Animal Registration
  3. Select Custom Form.
  4. Choose Set constant data to update the selected record with.
  5. Enter the constant data:
    • Animal Name: Bella Updated
    • Species: Dog
    • Date of Birth: 2021-01-02
  6. Select Custom User for Created by and choose apiowinston@yopmail.com.
  7. Save the configuration.

Outcome: The Update Record event will use the constant data to update the record, with the update attributed to the specified user.

Configure Update Record Event with Custom Form and Ask User for Some Fields

To set up an event that updates a record using a custom form with user-provided fields:

  1. Title: Enter a descriptive title for the event.
  2. Description: Provide a description of the record update.
  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 Update Method: Choose "Ask User to update the selected record."
  7. Fields to Update: Select "Some Fields" and specify the fields.
  8. Created By: Select "Custom User" and choose the specific user.

Steps:

  1. Alice Johnson is setting up an "Update Record" event.
  2. Enter the following details:
    • Title: Partial Update Animal Record
    • Description: Partially update an existing animal record
    • Menu: Animal Management Records
    • Window: Animal Registration
  3. Select Custom Form.
  4. Choose Ask User to update the selected record.
  5. Select Some Fields for the fields to be updated and specify:
    • Animal Name
    • Date of Birth
  6. Select Custom User for Created by and choose apiowinston@yopmail.com.
  7. Save the configuration.

Outcome: The Update Record event will prompt the user to update specific fields of the record, with the update attributed to the specified user.

Validate Update Record Configuration

To ensure the "Update 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 Update Method
    • Fields to Update (if applicable)
    • Constant Data (if applicable)
    • Created By
    • Selected User (if applicable)

Trigger Update Record Event with Current Form

To trigger the Update 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 update data for the selected record.

Trigger Update Record Event with Custom Form and Constant Data

To trigger the Update Record event using a custom form with constant data:

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

Expected Outcome:

  • The system should update the record with the constant data:
    • Animal Name: Bella Updated
    • Species: Dog
    • Date of Birth: 2021-01-02

Validate Updated Record

To verify that the record was updated correctly:

  1. Action: Check the record details.

Expected Outcome:

  • The record should reflect the configured values:
    • Animal Name: Bella Updated
    • Species: Dog
    • Date of Birth: 2021-01-02
    • Created By: apiowinston@yopmail.com

Summary

The Update Record Event Setup feature streamlines the process of updating records within the system by allowing configurations for current forms, custom forms with constant data, or custom forms with user-provided fields. This feature ensures that records are updated consistently and accurately, with clear attribution to the user responsible for the update.