Background information
The new Widget Builder integrates all widget configuration options on a single page.
- By centralizing the management of all configuration options, users no longer need to switch between various pages, saving time and effort, enhancing user experience, improving work efficiency, and simplifying the operation process.
- This integrated design is easy to use and makes the configuration process more intuitive and efficient.
When to use the Crud Form widget
The Crud Form widget allows users to create, read, update, and delete the widget data on the dashboard. It helps streamline the data management process, ensuring that information is accurately recorded, easily accessible, and efficiently updated or removed as needed. Some examples of data that fit into the Crud Form widget type are:
- Client information. View client profiles, edit the details of existing clients, and add or remove new clients.
- Service Tickets. Monitor tickets and their statuses, log new or close resolved tickets, and update ticket details, status, priority, and resolution notes.
- Contracts and Agreements. Access and review contracts, enter new service contracts and agreements, terminate or void contracts as needed, and amend contract terms, renewals, or adjustments.
-
Billing and Invoicing. Review historical billing data, generate new invoices and billing records, correct errors or remove old billing records, and adjust invoice details, payment statuses, and billing cycles.
Required permissions
Only users with admin roles can access the New Widget Builder and edit the widget settings.
Creating the Crud Form widget
1. Select the widget type and enable the New Widget Builder option
- Go to Widgets on the MSPbots app, click the New Widget button, and select the Crud Form widget type.
- When the Widget Builder window opens, click the +Dataset button.
To switch back to the old Widget Builder, follow the steps for Switching back to the previous Widget Builder.
- When the Select Dataset window appears, select an Integration from the Integration Group list.
*The selected integration is for illustration only.
- Select the appropriate source dataset from the Dataset List and click Add Selected.
*The selected dataset is for illustration only.
- Next, select the appropriate fields from the Dataset section and drag them to Column under the Drill Through section. Review the Field name, Alias, and Format, then click Save.
*The selected field for the drill-through is for illustration only.
- To refine the data, add a filter by clicking +Click to Add under the Filter section.
When the Filter window appears, choose the operator AND or OR, then select a filter from the first dropdown list and the corresponding options from the next two columns.
You can click the add button to add more filters or the delete icon to remove rows.
- Click Save.
You can add more configurations to your Crud Form widget to meet your reporting requirements. For more configuration options, see the section on Other configuration options.
- Set the Crud Form's configurations and go to Options in the rightmost column.
- Set the following configuration options:
-
Toolbar - Show any of the following functions in the widget by turning the corresponding switches ON:
-
Show Search - Turn this switch ON to show the search bar.
-
Show Delete - When enabled, this switch displays the Delete button.
-
Show Share - Enable this switch to show the Share button.
- Click
to share the configured form list, see Sharing the Form List for more detailed information.
- Before sharing, ensure the Form List option is configured in the Body section.
- The switch is disabled by default.
- The Show Share button will be hidden in the following scenarios:
- TV mode
- Presentation mode
- Public share links
- Click
-
Show Toolbar - Enable this switch to display the toolbar area containing PDF Export, CSV Export, and Columns filter.
- CSV - Enable this switch to show the CSV Export button and allow export.
- PDF - Enable this switch to show the PDF Export button and allow export.
-
Export Option – Enable this switch to configure export settings when clicking the PDF Export or CSV Export.
-
Column Chooser - Activate this switch to display the Column filter in the widget.
-
Show Search - Turn this switch ON to show the search bar.
- Body - Configure this section to customize how the widget's content will be displayed.
- Footer - Pagination - Activate the Pagination switch to display the page numbers in the footer.
- Customization - This section shows the columns you selected in the Drill Through. If you want to configure the columns, see Customizing Column.
- Conditional Formatting - This section shows the conditions you created.
-
Toolbar - Show any of the following functions in the widget by turning the corresponding switches ON:
2. Save the widget settings.
-
Click Save in the upper-right corner.
-
When Apply Success appears, it means the save is successful.
New widgets are at the bottom of dashboards, scorecards, and reports. When you save a new widget, the screen will automatically scroll to show the new widget.
You can edit the dashboard design by modifying the widget's placement in the dashboard.
What other actions are available from the widget's screen in the new Widget Builder?
Customizing Column
Configure the columns you selected in the Drill Through.
Editing a column
- Click Customization bar to show the settings.
- Click
to edit a column.
- Configure the following options.
- Header Title - Assign a column name.
- Tooltips - Add a tooltip for the column.
- Text Align - Set alignment to Left, Center, or Right.
- Allow Filter - Toggle to allow users to filter the column.
-
Disable HTML - Turn on the Disable HTML toggle switch to disable the use of HTML codes. This toggle switch is enabled by default.
- When the Disable HTML switch is turned on, if the field's content exceeds 300 characters (including spaces and punctuation), the text will be trimmed to 300 characters. To see the complete content of the field, hover over the field in the widget, and a tooltip will appear to display the full content.
- If you encounter excessive content in the field or if your HTML codes are not working properly, please turn on the Disable HTML switch to ensure it functions correctly and to avoid performance issues that may cause PDF generation to fail.
- When the Disable HTML switch is turned off, there are no restrictions on the character count of the field content, but excessive characters may lead to performance issues.
- When the Disable HTML switch is turned on, if the field's content exceeds 300 characters (including spaces and punctuation), the text will be trimmed to 300 characters. To see the complete content of the field, hover over the field in the widget, and a tooltip will appear to display the full content.
- Max Width - Set the width for the column.
- (Optional) Aggregates - When the column type is Number, calculate the values in the column. The calculation result is displayed at the bottom of the widget.
- Click + Add button.
- Choose one of the following calculation methods:
- Sum - Calculates the sum value.
- Min - Finds the minimum value.
- Max - Finds the maximum value.
- Count - Counts the number of items.
- Average - Calculates the average value.
- When you select Average as the Aggregates, you can customize the precision of the Number Format. There are five options for precision: 0, 0.0, 0.00, 0.000, 0.0000.
- When you select Average as the Aggregates, you can customize the precision of the Number Format. There are five options for precision: 0, 0.0, 0.00, 0.000, 0.0000.
- Click Save.
Hiding a column
- Click
button to hide a column.
- If you want to display the hidden column, click
button to show it.
Adjusting the column order
You can adjust the order of the columns by dragging and dropping, and the changes will be applied to the widget immediately.
Switching back to the old Widget Builder
If you want to switch back to the original Widget Builder page, click to open the Unsaved Changes pop-up window.
- If you do not want to save the settings in the New Widget Builder, click Leave without Saving.
- If you want to save the settings in the New Widget Builder, click Save Changes.
If you have clicked Save to keep the settings in the New Widget Builder, clicking will directly switch to the original Widget Builder.
Creating a bot from the widget
- Click
> Create Bot.
- For more details on creating a bot, see How to Create a Bot from a Widget in New Widget Builder mode.
Creating a filter for the widget
The filter is for secondary filtering of the data filtered in the Dataset.
- Click
> Filter.
- Select a field you want to filter.
- Set a condition for the field using the subsequent two dropdowns. For descriptions of each option, refer to What Filter Conditions and Formats are Available for Creating Widgets.
- If you want to add multiple filter conditions,
- Click the Add
icon and choose either Add Condition or Add Group.
- Add Condition - Add a filter condition.
-
Add Group - Add a condition group.
- Repeat steps 2 and 3.
- Click the Add
- Select the logical operator AND or OR for the conditions or filter groups.
- AND - Conditions within a group or groups are connected by an AND relationship, which requires that all conditions or groups must be fulfilled.
- OR - Conditions within a group or groups are connected by an OR relationship, which means that only one of the conditions or groups needs to be fulfilled.
- Click ok to keep your settings.
Cloning the widget
- Click the
button in the upper-right corner.
- Hover over Clone to and select from:
- Clone to "My Widgets"
- Clone to Existing Dashboard
- Clone to New Dashboard
- Follow the steps below:
- If you select Clone to "My Widgets",
- Fill in the following fields:
- Name
- Role
- Description
- Click Confirm to clone the widget as a new widget.
- Fill in the following fields:
- If you select Clone to Existing Dashboard,
- Select a existing dashabord from the list.
- Click Clone.
- The page will redirect to the editing mode of the existing dashboard. For more information on how to edit the dashboard, see How to Create and Use Dashboards in MSPbots.
You can also find the cloned widget in My Widgets category in Widgets.
- Select a existing dashabord from the list.
- If you select Clone to New Dashboard,
- Select Dashboard or Report.
- For more information on how to edit the dashboard or report, refer to the below articles.
- How to Create and Use Dashboards in MSPbots
-
How to Create and Use Reports in MSPbots
You can also find the cloned widget in My Widgets category in Widgets.
- Select Dashboard or Report.
- If you select Clone to "My Widgets",
Sharing the widget
- Click the Share
icon to copy the URL of the widget.
- The message Copy Success indicates that the copy was successful and you can share the URL with others who want to view the widget.
Deleting the widget
- Click the
button, and then select Delete.
- Click Confirm.
Editing the basic settings of the widget
- Click the
button next to the widget name to edit the basic settings of the widget.
-
Fill in the following fields.
- Name
- Description
- More Info
- Tag
-
Role
- Click Save.
- When Apply Success appears, it means the save is successful.
Adding the widget to My Favorites
Click the button in the upper-right corner to add the widget to My Favorites.
- When
changes to
, it means the addition was successful.
- After that, you can find the widget in the My Favorites tab.
- If you want to remove it from My Favorites, click
to change it to
.
Refreshing the widget preview panel
Click Refresh to manually refresh the widget preview panel.
For the Auto Refresh checkbox,
- The Auto Refresh checkbox is selected by default.
- When the Auto Refresh checkbox is selected, the widget preview panel automatically refreshes whenever you modify the widget's configuration.
- When you clear the Auto Refresh checkbox, the widget preview panel stops refreshing automatically and refreshes only when you manually click Refresh.
- Your setting for the Auto Refresh checkbox applies to all widgets.
Sharing the Form List
- Click
to open the Share popup.
- Set a Time Limit.
- Select No Time Limit if the link will be available without limits
- Select Customized Time to specify a time limit for the link's availability.
- For User Access,
- Select Everyone
- Select Selected Users to specify accessible users.
- Click Generate. A sharable link appears in the URL field.
- Click Copy to copy the URL for sharing. You may now share the link via email or any channel.
- Use the URL to view the configured form list. Press F11 to enter the full-screen mode, and press Esc to exit the full-screen mode.
- If you want to modify the availability time of an existing shareable link, generate a new shareable link, or revoke the existing shareable link, follow the steps below to revoke the existing link.
- Click Revoke.
- Click Confirm. The old sharable link is revoked and cannot be accessed anymore.
- Click Revoke.
Other configuration options
1. Data Scope
This option is editable if the dataset has multiple layers. If the dataset has only one layer, skip this option and proceed to the next step.
For datasets with multiple layers, select the layer you want to configure.
How to check the number of layers in the dataset you are configuring?
- Search for the dataset you are configuring, and click it to open. For example, search ConnectWise Manage Time Entry - Layered dataset.
- Click
.
- Click the Please Select Layer dropdown list to see how many layers there are.
2. Field Chooser
- Click the Field Chooser bar to show the settings.
-
Field - Configure which fields are included in the widget.
- Drag the required fields from the Dataset column to the Field section.
Note: Ensure that all required fields from the Dataset column are dragged to the Field section. The fields available in Query will be the fields dragged to the Field section. - Click
to configure the following fields:
- Field - Select a field from the dropdown.
- Alias - Type an Alias.
-
Formula - Enter SQL to create a calculated value by using basic mathematical
operations on the dataset fields and any number. -
Format Type - Select a Format Type. For more detailed information, see Conditions and Formats Available for Creating Widgets.
- Text
- Number
- Date
- Date Time
- Yes/No
- User
- Hyperlinks
- Display Type - Select a Display Type. For more detailed information, see Conditions and Formats Available for Creating Widgets.
- Click Save.
- (Optional) When you set up Measure, click
or
to configure whether the fields in the Field Chooser are displayed in the Drill Through of the Measure, aside from the fields that are set as Measure.
- Drag the required fields from the Dataset column to the Field section.
-
Order By - Sort the data from drilling through a specific dataset based on the selected fields and sorting rules.
- Click
to add a field.
- Fill in the following fields:
- Field
- (Optional) Order By
- Ascending
- Descending
- Click Save.
- Click
3. Query
- Click the Query bar to show the settings.
- For Measure - Configure the fields to be calculated and the formula for calculating measures.
- Click
.
- Click
to configure the following fields:
- Field Name - Select a field from the dropdown.
- Alias - Type an Alias for the measure.
-
Formula - Enter SQL to create a calculated value by using basic mathematical
operations on the dataset fields and any number. -
Summarize Type - Select a Summary Type.
- sum
- count
- Average
- Maximum
- Minimum
- String_Aggregate
-
Format Type - Select a Format Type. For more detailed information, see Conditions and Formats Available for Creating Widgets.
- Text
- Number
- Date
- Date Time
- Yes/No
- User
- Display Type - Select a Display Type. For more detailed information, see Conditions and Formats Available for Creating Widgets.
- Remove duplicate data - If you want to remove duplicate data when calculating data, please check this option.
- Click Save.
- Click
- For Dimension - Configure the fields and format you want to be displayed as a group.
- Click
.
- Click
to configure the following fields:
- Field Name - Select a field from the dropdown.
- Alias -Give an Alias for the dimension.
-
Format Type - Select a Format Type. For more detailed information, see Conditions and Formats Available for Creating Widgets.
- Text
- Number
- Date
- Date Time
- Yes/No
- User
- Hyperlinks
- Display Type - Select a Display Type. For more detailed information, see Conditions and Formats Available for Creating Widgets.
- Click Save.
- Click
- For Filter - Add conditions for filtering data.
- Click
.
- Select a field you want to filter.
- Set a condition for the field using the subsequent two dropdowns.
For a guide on each option on the list, refer to the article Conditions and Formats Available for Creating Widgets.
- If you want to add multiple conditions, click + Condition to add.
- Select the logical operator AND or OR for the filter conditions.
- Select the logical operator AND or OR for the filter conditions.
- If you want to add multiple groups, click + Group to add.
- Select the logical operator AND or OR for the filter groups.
- Select the logical operator AND or OR for the filter groups.
- If you want to add multiple conditions, click + Condition to add.
-
-
-
-
-
-
Ignore Filter - When the Ignore Filter option is checked, the value of the condition will be grayed out. Once checked, you only need to fill in the field and query string. And only the slicer will be effective.
-
Ignore Filter - When the Ignore Filter option is checked, the value of the condition will be grayed out. Once checked, you only need to fill in the field and query string. And only the slicer will be effective.
-
-
- (Optional) SQL Preview - Click SQL Preview to check the filter settings by viewing the Filter Expression and Filter SQL.
- Click Save.
- Click
- For Order By - Sort the data of a specific layer in a certain dataset based on the selected fields and sorting rules.
- Click
.
- Configure the following fields:
- Field - Select a parameter to sort the data.
- Order By
- Ascending
- Descending
- Click Save.
- Click
-
Row Limit - Select an option to limit the data rows for a specific layer in a certain dataset.
-
Remove duplicate data - If you want to remove duplicate data, select this option.
-
Materialized - Select an option from the Materialized dropdown menu to materialize data based on the actual conditions.
4. Clear Query
When you want to clear all fields in Query and Drill Through at once, you can click Clear Query to avoid deleting them individually.
- Click Clear Query at the bottom of the page.
- Click Continue.
5. Dataset
-
Search fields - Use keywords to search for the fields you need.
-
Order By - Sort all data from the added datasets based on the selected fields and sorting rules.
- Fill in the Field and Order By rules.
- Click Save.
- Fill in the Field and Order By rules.
-
Row Limit - Select an option to limit the rows of data for all added datasets.
-
Replace the dataset with another one you want.
- Hover over the name of the dataset.
- Click the ellipsis
button, then select Select.
- Click your desired dataset and click Add Selected.Replace the dataset with one that matches the structure of the original dataset. For example, a dataset that only differs in field data values is essential to avoid error reports and widget malfunctions.
-
Rename, Clone, or Delete the dataset
- Hover over the name of the dataset.
- Click the ellipsis
button, then select Rename/Clone/Delete.
- When you hover over the dataset, it displays the original name of the dataset.
- If you have renamed the dataset, hovering over it displays both the original name and the name you renamed it to.
- When you hover over the dataset, it displays the original name of the dataset.
* When you add a dataset with fields next to the triangle icon, it indicates that the field is associated with other datasets.
* The fields in the associated datasets can be dragged or added to the widget configuration area for settings.
* If you configure fields from the associated dataset in Query, Drill Through, or Options, the Widget Builder mode will stay in the New Widget Builder mode and cannot switch back to the original mode. You can switch back to the original mode only after you clear the fields from the associated dataset.