Skip to main content

Business Forms Panel 4.1.0

Daria Volkova
Creative Director at Volkov Labs, Grafana Champion

We are happy to announce the release of the Business Forms Panel 4.1.0. This release includes the following updates:

  • Plugin rebranding, the new name is the Business Forms Panel.
  • Non context code parameters are retired. Please update the parameter reference the use the context. Breaking change.
  • Work with the payload simplified.
  • Confirmation window: new parameter (Display Values).
  • Form Elements: collapsable sections.
  • Form Elements: custom colors.
  • Date and Time Form Element type: new parameter (Time Zone).
  • New Form Element type: Checkbox list with custom options.
  • Required Grafana 10 and Grafana 11. Breaking change.
Grafana Catalog

The plugin is under review.

Business Forms Panel

The Data Manipulation panel joins the Business Suite for Grafana and with that gets an elevated name. Now, the same amazing open source plugin is called the Business Forms panel.

Please welcome the new name for the same functionality!

The Data Manipulation panel now is called the Business Forms panel.
The Data Manipulation panel now is called the Business Forms panel.

Downloads

The Business Forms plugin has been downloaded more than 660,000 times! We are curioulsy observing what the latest release is going to do with that number.

The Business Forms plugin downloads exceeds 660,000.
The Business Forms plugin downloads exceeds 660,000.

Context migration guide

Starting from this release, ensure to reference the Grafana parameters using the context.

PreviouslyStarting from version 4.0.0
datacontext.panel.data
elementscontext.panel.elements
initialcontext.panel.initial
initialRequestcontext.panel.initialRequest
locationServicecontext.grafana.locationService
notifyErrorcontext.grafana.notifyError
notifySuccesscontext.grafana.notifySuccess
notifyWarningcontext.grafana.notifyWarning
onChangecontext.panel.onChange
onOptionsChangecontext.panel.onOptionsChange
optionscontext.panel.options
replaceVariablescontext.grafana.replaceVariables
responsecontext.panel.response
setInitialcontext.panel.setInitial
templateServicecontext.grafana.templateService
toDataQueryResponsecontext.utils.toDataQueryResponse

Work with the payload simplified

warning

Breaking change. The old way does not work anymore.

This feature is related to the:

  • Initial Request -> Initial Action -> Data Source,
  • Update Request -> Update Action -> Data Source.
New payload area relates to the Data Source (Initial and Update requests).
New payload area relates to the Data Source (Initial and Update requests).

We simplified work with the payload creation. Starting from this release, the Business Forms panel has a designated area to enter the payload request.

Payload for the Initial Request example.
Payload for the Initial Request example.
Payload for the Update Request example.
Payload for the Update Request example.

Confirmation Window: new parameter

The Confirmation window is shown after a user clicks on the Submit button. Previously, only data elements with modified values were shown. Starting from version 4.0.0, we added a new parameter Display Values, where you can choose between two options:

  • All values to always show all data elements regardless if there was any change in values.
  • Updated Only to show only the data elements with changed values.
Display Values parameter.
Display Values parameter.

Collapsable Sections

Starting from this release, your sections can be collapsible. This functionality is available only for the sections in the Vertical orientation. You can make any section Expanded for the form opening/refresh.

Collapsible sections.
Collapsible sections.

In addition, you can control the Expanded and Collapsed states in the Custom code using the following commands:

context.panel.expandSection(id);
context.panel.collapseSection(id);
note

The full list of the Business Form panel parameters can be found in the Custom Code section of the panel's documentation.

Custom color/background color for elements

Now you can play with Form Elements colors. Configurable are:

  • Background color,
  • Label background,
  • Label color.
Form Elements color options.
Form Elements color options.

Date and Time Form Element type: new parameter

Starting from this release, you can choose a time zone for the updated value.

  • UTC. The date-time value is saved in the UTC zone,
  • Local. The date-time value is saved following the browser's time zone.
New Time Zones option for Date and time elements.
New Time Zones option for Date and time elements.

New Form Element type: Checkbox list with custom options

The Checkbox list with custom options type allows the creation of multi-selection checkmark elements.

Checkbox list with custom options.
Checkbox list with custom options.

Specific for this element are the following options:

  • User options.

To add an option click the 'Add option' button and then specify an option type (number or string), value, and label.

Checkbox list with custom options.
Checkbox list with custom options.

Grafana 10 and Grafana 11

Breaking changes

Grafana 9 is not supported.

Our plugins always follow the latest Grafana versions and stay compatible with the most recent releases. That means, however, that we have to sunset the support of obsolete releases.

The latest Business Forms Panel 4.0.0 fully supports Grafana 10 and 11 releases.

Getting Started

You can install the Business Forms Panel from the Grafana Plugins catalog or using the Grafana command line tool.

For the latter, please use the following command:

grafana-cli plugins install volkovlabs-form-panel

YouTube Tutorial

Business Forms Panel is a plugin for Grafana that allows you to insert and update application data, as well as modify configuration directly from your Grafana dashboard.

The powerful Business Forms panel 4.1.0 Overview.

Release Notes

Breaking changes in 4.0.0
  • 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 in 4.1.0

  • 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)

Features / Enhancements in 4.0.0

  • 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)
  • Updated Date Time query field (#429)

Features / Enhancements in 3.8.0

  • 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)

Features / Enhancements in 3.7.0

  • 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)

Features / Enhancements in 3.6.0

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

Features / Enhancements in 3.5.0

  • 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)

Feedback

We're looking forward to hearing from you. You can use different ways to get in touch with us.

  • Ask a question, request a new feature, or report an issue at GitHub issues.
  • Subscribe to our YouTube Channel and leave your comments.
  • Sponsor our open source plugins for Grafana through GitHub.