Add ons

5 Minutes to read
Contributors

Add ons

5 Minutes to read
Contributors

Article summary

Did you find this summary helpful?

Thank you for your feedback

An Add-On functions as a versatile plugin designed to enhance a View, Report, or Data Source Reference by introducing tailored functionalities and customizations. By leveraging Add-Ons, you can extend the capabilities of your data-driven applications without making changes to the original data source.

IMPORTANT
Data Actions are exclusive to views and cannot be used in reports or other artifacts, even if they are part of an Add-On.

Why Use Add-Ons?

Add-Ons provide a flexible way to enhance and customize your data without altering the original source. Acting as plugins, they allow you to:

Add Static Columns: Create additional columns with static values specific to a view, report, or data source reference. This eliminates the need to modify the original data table or source.

Define Behavior Through Rules: Set rules to manipulate and automate the behavior of data in these static columns based on specific conditions.

Create Data Actions: Design a range of actionable processes that can be directly used within views to streamline operations.

Let’s explore how an Add-On can be helpful through a practical use case. Follow the below use case.

Use Case: Franchise Management Dashboard

Imagine you're managing data for a chain of restaurants. Your primary data source includes columns for "Franchise Name," "Location," and "Budget." However, you need to add more context to this data, like a "Franchise Type" and a "Priority Level," without altering the original data source.

Step 1: Adding Static Columns Using Add-Ons

You create an Add-On and add two static columns:

Franchise Type: A column to classify franchises as "Standard" or "Premium."
Priority Level: A column to assign a priority tag based on the franchise’s budget.

Step 2: Defining Rules for Automated Behavior

Rules are then applied to these columns:

For "Franchise Type," set a default value of "Standard."
For "Priority Level," define the following rule:
- If the budget exceeds $20,000, assign "High Priority."
- Otherwise, assign "Normal Priority."

This ensures the columns automatically populate based on predefined logic, eliminating manual input errors and saving time.

Step 3: Implementing Data Actions

You add Data Actions like:

A button to generate a performance report for each franchise.
A shortcut to update the franchise’s budget directly from the dashboard.

Outcome

In the Franchise Management Dashboard, the additional "Franchise Type" and "Priority Level" columns appear alongside the original data. These columns provide immediate insights, such as which franchises are high-priority and what type they belong to, without altering the primary data source.

Configuring Add-Ons

Go to the Admin Menu and navigate to Database → Data Sources.
Select the desired data source where you want to create an Add-On and click on it.
On the right-hand side, locate the Actions Panel and find the Add-Ons section.

Click the "+" icon next to "Add-Ons."
You will be redirected to the Add-On creation page to proceed with setting up your Add-On.

When setting up an Add-On, you have three key configuration options:

Smart Columns

Navigate to Smart Columns and select Add Smart Column.

A drop-down menu will appear, displaying the available field types, including:
1. Boolean
2. Calculate
3. Date
4. Date Time
5. Email ID
6. Number
7. Phone Number
8. Text
9. Time
Let’s choose "Text" as an example. Upon selecting "Text," there are three options:
1. Column Type: Element Type
2. Column Name: Assign a name for the column.
3. Value: Enter a value that remains the same for all rows.

A new column is created with the specified name, and the static value is applied to all rows.

Business Rules

Navigate to Rules and select Add Rule.

A pop-up appears, allowing you to define rules based on your requirements. Learn what Rules are and how to create them.

Data Actions

Navigate to Actions → Add Action.

When you click on “Add Action,” a pop-up appears with 8 types of data actions, which are:

S.No	Action Type	Definition
a	Inline Edit	Allow users to edit column data directly within the view, with the changes reflected in the corresponding tables
b	Open Add Record	Allow users to open an app in add record mode and perform transactions
c	Open App as Report	Allow users to open the App as Report
d	Open List View	Allow users to view the desired list view
e	Open Kanban View	Allow users to view the desired kanban view
f	Open Report	Allow users to view the report (All Report Types) that is related to a record to make instant informed decisions
g	Print	Allow users to print the Report
h	Submit Add Record	Allow users to Submit Add Record directly from the list view

Let’s use “Open Add Record” as an example to understand how to configure a data action.
Upon selecting “Open Add Record,” there appears a pop-up which consists of Action Details and Mapping.

S.No	Action Details	Definition
a	Action Name	Provide a name for the action being created
b	New Tab	Opens the linked artifact or action in a new browser tab
c	Self	Opens the linked artifact or action in the current tab, replacing the existing view
d	Pop-up	Displays the linked artifact or action in a pop-up window within the same screen
e	Side Panel	Opens the linked artifact or action in a side panel, allowing users to view it alongside the current content
f	Icon	Select an icon to visually represent the data action type for easier identification
g	Global Icon	Choose an icon that is accessible and visible throughout the entire view
h	Link	Allows the name of the action or artifact to be linked, enabling easy navigation
i	Button	Displays the action in the form of a button for better visual emphasis and interactivity
j	Global Button	A button that is accessible and functional across the entire view
k	Select Workspace	Choose the workspace containing the artifact you want to open when the action is executed
l	Select Reference	Select the specific artifact that should open when the action is clicked IMPORTANT To avoid interruption in selecting the Reference from the drop-down, you must check Views option under App Usage in App Settings. So that, you can select the Reference from the drop-down. Navigation: Manage Apps → Desired Application → App Settings → App Usage → Views.

Mapping:

After entering all the key details on the Action Details page, the next step is to map the elements. This step is critical to link the data source (list view) with the corresponding fields in the application.

Mapping specifically refers to the process of managing actions by associating a source element (a field or data in the list view) with a corresponding reference element in an application.

Data Source Element:
Refers to the element in the Data Source where the data originates. (eg, Opening Date Column)
Reference Element:
Refers to the specific field in the application where the data will be added or updated. (eg, Opening Date Field)
For example, we choose to “Open add record” action on the “Opening date” column in the list view using a “Button” action type that opens in a “New Tab”.
Behavior of the "Open Add Record" Action:
- Since we configured the "Open Add Record" action on the “Opening Date” column in the list view.
- Now, let’s click on the “Opening Date” on the selected row.

Was this article helpful?

What's Next

Lookups

Table of contents