Schema - Data - Custom Event Button

  • Updated

Overview

This feature allows users to create and configure custom events in the platform, providing a way to notify either Neostella or connected external systems when a defined action or change occurs. 

These buttons can trigger internal platform processes, such as automations, or publish events to external partners and integrations so downstream systems can respond accordingly.

Prerequisites & Dependencies

  • Access to control center

Required Permissions

  • Create Component Permissions
  • Create Automation Permission
  • Create Views Permissions
  • Control Center
  • Custom Events

Limitations

  • Buttons are components that depend on the context. They can be used around the system, but are limited to the related context.

Configuration Steps

*Reference image of the Custom Button on a View in a Project of the type: Personal Injury

There are three main steps to configure and visualize a Custom Event in the platform:

  1. Create a Button Component
  2. Configure an Automation
  3. Add the button to a Custom View

For this article, a Send Email Custom Event will be created as an example.

  1. Create a Button Component:
  1. Navigate to Control Center -> Schema.
  2. Go to Views.
  3. Select the COMPONENTS tab.
  4. Click on +New Component.
  5. Fill all the required fields.
  6. Select Component Type: Button.
  7. Define Sub type: Custom Event.
  8. Add an Event selector name. (It is recommended to use the same API name as the name above)
  9. Click on SAVE.The Button Component has been created.

Note: The Event selector name will be used to trigger the automation in the following steps.

  1. Configure an Automation:
  1. Navigate to Automations under the Process Studio section.
  2. Click on + NEW AUTOMATION.
  3. Add a Name. The user can also add a description for more context.
  4. Click CREATE.
  5. Configure Starting Rule by clicking on it. This will open the configuration drawer.
  6. Select a Source: Neostella.
  7. Select an Action: Neostella Object Event.
  8. Now look for the Event configuration section.
  9. Look for Neostella Object and select: Custom Event Buttons.
  10. Define the Object Action by selecting Clicked.
  11. Now configure the trigger in the edit condition field.
  12. Select: WHEN custom-event-button.selector = event selector (The one configured previously).
  13. Click on SAVE AND TEST. This will save the rule and bring the available Outputs.
  14. Add the next Step by clicking on the + in the middle of the card (Automation node) in the Canva.
  15. In the Node Setup menu, search for the Send Email option.
  16. Click on step 2 to open the configuration drawer.
  17. Now fill all the required fields in the Email Details section:
    • Recipient Email Address
    • Email Subject
    • Tenant name (This will be the sender email direction)
      • Optional: Text, Sender Name, Project ID, Attached Document.
  18. Click on SAVE.
  19. Users have created the automation.

Now, users must create a view to place the button and trigger the automation. 

  1. Add the button to a Custom View:
  1. Navigate to Schema, then go to Views.
  2. Select the +VIEW.
  3. In the Design Canvas look for the components.
  4. Add a basic structure for the view. 
  5. Drag and drop a Button component.
  6. Select the component to activate the configuration panel of the component.
  7. On the right panel, select the Custom Event Type.
  8. Now select the button and add a label, for this example it will be Send Email.
  9. Now click on SAVE and navigate to the DISPLAY Tab.
  10. Configure the Project type.
  11. And add a Menu Label and Number of order.
  12. Finish by clicking SAVE.

NOTE:

  • Users can also add it to a Form, just go to Schema -> Forms -> Select Object and on the form edition field add the custom event button. 
  • Configure the button on the right panel.

    Reference image of the icon:

Validation

  • Go to Cases.
  • Select the created Project.
  • Look for the created label and icon for the view.
  • Open the View.
  • The button must be displayed.
  • Click the Button.
  • The system will notify that the email was sent.
  • Confirm by going to the Inbox of the email configured as recipient.

Add note about automation execution history.

Troubleshooting

  • Make sure the event selector name is the same as the API.