Plugins 〉Business Forms

Panel

community

Business Forms

Overview
Installation
Change log
Related content

Business Forms for Grafana

Forms

Introduction

The Business Forms panel is a conceptually new plugin for Grafana. It is the first plugin that allows inserting and updating application data, as well as modifying configuration directly from your Grafana dashboard.

Requirements

Business Forms panel 4.X requires Grafana 10.3 or Grafana 11.
Data Manipulation panel 3.X requires Grafana 9 or Grafana 10.
Data Manipulation panel 2.X requires Grafana 9 or Grafana 8.5.
Data Manipulation panel 1.X requires Grafana 8.

Getting Started

You can install the Business Forms panel from the Grafana Plugins catalog or use the Grafana command line tool.

For the latter, please use the following command:

grafana cli plugins install volkovlabs-form-panel

Highlights

Provides functionality to create customizable forms.
Supports custom code for initial and update requests.
Supports API requests, including the GET request to get initial values and the DELETE, PATCH, POST, and PUT requests to send values updated in the form.
Allows adding request headers to initial and update requests.
Supports customization of the Submit and Reset buttons as well as the form layout.
Allows splitting form elements into sections.
Allows requesting the user's confirmation before running an update request.
Allows sending all or only updated elements in the request payload.
Allows displaying success and error notifications through custom code.
Supports suggestions for available parameters when writing program code in the code editor.

Documentation

Section	Description
Data Flow	Explains the data flow and its specifics.
Form Elements	Explains the specifics of form elements.
REST API	Explains the REST API architecture and how to use NGINX.
Custom Code	Explains how to access plugin options, API responses, form elements, and Grafana services.
Features	Explains the plugin features.
Servers	Provides examples of API server implementations.
Tutorials	Easy to follow tutorials
Release Notes	Stay up to date with the latest features and updates.

Business Suite for Grafana

The Business Suite is a collection of open source plugins created and actively maintained by Volkov Labs.

The collection aims to solve the most frequent business tasks by providing an intuitive interface with detailed written documentation, examples, and video tutorials.

Enterprise Support

With the Business Suite Enterprise, you're not just getting a product, you're getting a complete support system. You'll have a designated support team ready to tackle any issues.

You can contact us via Zendesk, receive priority in feature requests and bug fixes, meet with us for in-person consultation, and get access to the Business Intelligence. It's a package that's designed to make your life easier.

Always happy to hear from you

Ask a question, request a new feature, or report an issue at GitHub issues.
Subscribe to our YouTube Channel and leave your comments.
Become a Business Suite sponsor.

License

Apache License Version 2.0, see LICENSE.

Installing Business Forms on Grafana Cloud:

For more information, visit the docs on plugin installation.

Change Log

4.9.0 (2024-11-16)

Features / Enhancements

Removed DatasourceResponseError moved to external Components (#535)
Added HTML, Markdown to supported Code Editor languages (#543)
Updated options to use datasource ID instead of name (#539)
Updated E2E tests (#538)
Updated refresh function in the Update Request (#547)
Added functionality for updating sections dynamically (#542)
Removed default payload from Update Request (#550)

4.8.0 (2024-10-25)

Features / Enhancements

Added Date Form element (#520)
Update refresh for dashboard scene (#522)
Updated Text area, Code editor elements to escape multi-lines (#520)
Updated refresh for dashboard scene using useDashboardRefresh hook (#528)
Added Handling Data Source Request Errors (#530)
Updated Grafana 11.3.0 and dependencies (#531)

4.7.0 (2024-10-08)

Features / Enhancements

Updated Autosize Code Editor toolbar (#506)
Added custom input for Select, Multi select (#507)
Added support for frames in initial fields support (#508)
Updated behavior for disabled text area element (#514)

4.6.0 (2024-09-28)

Features / Enhancements

Updated initial values for elements from data source (#490)
Added wrap button in the code editor (#491)
Updated loading bar for Initial Request (#492)
Added Label Background and Label Color for element with type Button (#502)

4.5.0 (2024-09-06)

Features / Enhancements

Updated date and time input timezone (#452)
Added dashboard variables support in button titles (#479)
Updated suggestions position in Code elements (#483)
Added variable support in sections and labels (#485)

4.4.0 (2024-08-29)

Features / Enhancements

Added Expandable Editors (#472)
Updated Pre-Selection for multi selection elements (#474)
Updated data source query display error (#477)

4.3.1 (2024-08-16)

Bugfixes

Fixed migration helper if nested object properties are not defined (#468)

4.3.0 (2024-08-12)

Features / Enhancements

Added helpers for form elements (#460)
Updated payload options migration (#464)
Added element custom button (#463)

4.2.0 (2024-07-18)

Features / Enhancements

Updated Docker Compose and E2E pipeline (#446, #447)
Improved unit tests (#447)
Updated Business Forms tutorial (#451)
Updated the logic for comparing values with the initial values (#454)
Updated position of Query fields for initial values (#455)

4.1.0 (2024-07-09)

Features / Enhancements

Updated context parameters migration (#433)
Updated provisioning files (#433)
Updated Checkbox list with custom options (#435)
Updated code defaults to use context properties (#438)
Updated E2E workflow using Docker (#441)

4.0.0 (2024-07-01)

Breaking changes

Requires Grafana 10 and Grafana 11
Data Source requests were updated to use Query Editor.
Removed non-context code parameters. Please update parameters to use context.

Code parameters migration guide

data -> context.panel.data
elements -> context.panel.elements
initial -> context.panel.initial
initialRequest -> context.panel.initialRequest
locationService -> context.grafana.locationService
notifyError -> context.grafana.notifyError
notifySuccess -> context.grafana.notifySuccess
notifyWarning -> context.grafana.notifyWarning
onChange -> context.panel.onChange
onOptionsChange -> context.panel.onOptionsChange
options -> context.panel.options
replaceVariables -> context.grafana.replaceVariables
response -> context.panel.response
setInitial -> context.panel.setInitial
templateService -> context.grafana.templateService
toDataQueryResponse -> context.utils.toDataQueryResponse

Features / Enhancements

Updated name to Business Forms Panel (#361)
Added support frontend data sources (#361)
Updated elected type for a new option (#402)
Prepared for Grafana 11 (#399)
Updated Reset button handler (#422)
Updated Confirmation Window (#420)
Updated Error handling in code editors showIf, disableIf, getOptions (#410)
Updated description for Get Options Code (#404)
Added custom color/background color for elements (#386)
Added Collapsable Sections (#409)
Updated to Grafana 11.1 and dependencies (#426)
Update Date Time query field (#429)

3.8.0 (2024-05-30)

Features / Enhancements

Added Checkbox List element (#382)
Updated syntax support in Code Editor (#383)
Added plugin e2e tests and remove cypress (#390)
Added server-based form elements example (#392)
Added input type time (#385)
Updated hiding/show multi-select element (#389)
Updated allowed files for file type (#388)
Added Form validation provisioning dashboard (#411)

3.7.0 (2024-03-10)

Breaking changes

Requires Grafana 9.2 and Grafana 10

Features / Enhancements

Added update enabled option and variables examples, fix sync option (#356)
Added files upload examples and fix form data header (#357)
Added code parameters with builder and add initial request to element value changed code (#358)
Allowed to disable columns in confirmation modal (#360)
Updated dependencies and Actions (#368)
Added skipping elements hidden using Show If from update payload (#369)
Add multiple files option (#375)

3.6.0 (2023-01-10)

Features / Enhancements

Added backend service to custom code (#331)
Added support for file base64 encoding in payload (#331)
Added Context parameter to Payload (#331)

Bugfixes

Fixed element custom options source (#334)

3.5.0 (2023-01-04)

Features / Enhancements

Added disable if code (#321)
Updated reset request visibility if reset button is hidden (#322)
Added code options source for select element (#323)
Added value changed code (#324)
Updated to Node 20 (#326)
Added suggestions for code editors (#327)
Added reset button confirmation (#328)

3.4.0 (2023-12-14)

Features / Enhancements

Add ability to disable panel syncing (#298)
Update ESLint configuration and refactor (#299)
Update Collapse from @volkovlabs/components (#299)
Add EventBus and AppEvents to Context (#307)
Add replacing variables in Payload functions (#309)
Update to Grafana 10.2.2 and Volkov labs packages (#313)
Add options migration (#315)

Bugfixes

Fix draggable control to support upcoming Grafana changes (#314)

3.3.0 (2023-11-21)

Features / Enhancements

Add Disabled Text Area element type (#243)
Add Confirmation Window options (#242)
Add context object to the custom code (#255)
Add Select Options From Query (#254)
Add NumberInput component which allows to enter decimals (#291)
Update to Plugin Tools 2.1.1 (#292)
Use Grafana Access Policy to sign plugin (#292)
Update to Grafana 10.2.1 (#292)
Update ESLint configuration (#294)
Add Autosize Code Editor (#295)
Add Data Source option for Reset button (#296)
Add Link Element (#297)

Bugfixes

Allow to enter zero value in number field (#288)

3.2.1 (2023-09-07)

Features / Enhancements

Add backward compatibility for option id (#244)

3.2.0 (2023-09-06)

Features / Enhancements

Add min and max date for date time element (#225)
Map Data Source values to elements (#224)
Update element Show If to support variables (#230)
Add clearing errors before initial and update requests (#232)
Add URL encode to variables (#231)
Allow empty section name (#228)
Add Query Field Picker for Initial Request (#227)
Add File element type for File Upload (#229)
Add converting option value to string and number based on type (#233)
Add loading states for Initial, Update and Reset button actions (#234)
Add support for asynchronous custom code (#234)
Update Query and Data Source initial request (#237)
Add icons for radio and select options (#238)

3.1.0 (2023-08-13)

Features / Enhancements

Update jest selectors to use npm package (#209)
Add onChange to update elements in local state within custom code (#214)
Update ESLint configuration (#215)
Add Multi Select element (#217)
Add conditional element visibility (#219)
Add custom payload code editor (#220)
Add custom reset code editor (#221)
Add Data Source request (#222)

3.0.0 (2023-07-15)

Breaking changes

Requires Grafana 9 and Grafana 10.
Form Elements are kept in the local state and not saved in the dashboard by default.
Local states and elements refactoring may introduce breaking changes. Please test before using in Production.