To Create an Inquiry-Based Widget

An inquiry widget retrieves data for the widget from an inquiry form, such as a generic inquiry form or a custom inquiry form. Inquiry-based widgets that are available in MYOB Acumatica or an MYOB Acumatica Framework-based application by default include chart widgets, table widgets, and KPI widgets.

To Create an Inquiry-Based Widget

1. In the project of your MYOB Acumatica extension library or your MYOB Acumatica Framework-based application, create a data access class (DAC) that implements the IBqlTable interface and stores the parameters of the widget. We recommend that you inherit the DAC from the PX.Dashboards.Widgets.InquiryBasedWidgetSettings class, which provides the following parameters for the widget:
   • InquiryScreenID: Specifies the inquiry form on which the widget is based
   • FilterID: Specifies one of the shared filters available for the specified inquiry form
   The following code shows a fragment of the DAC for the predefined inquiry-based data table widget. The DAC is inherited from the InquiryBasedWidgetSettings class.

   using PX.Data;
   using PX.Dashboards.Widgets;
   
   [PXHidden]
   public class TableSettings : InquiryBasedWidgetSettings, IBqlTable
   {
       #region AutoHeight
       [PXDBBool]
       [PXDefault(true)]
       [PXUIField(DisplayName = "Automatically Adjust Height")]
       public bool AutoHeight { get; set; }
       public abstract class autoHeight : IBqlField { }
       #endregion
   
       ...
   }

   Note:

   You must declare a DAC by extending the PXBqlTable class and implementing the IBqlTable interface. However, in the code example above, the InquiryBasedWidgetSettings class already inherits the PXBqlTable class.
2. In the project, create a graph for working with widget parameters and reading data for the widget. Use the following instructions when you implement the graph:
   • Inherit the graph from the PX.Dashboards.Widgets.InquiryBasedWidgetMaint abstract class, which is inherited from the PXWidgetBase abstract class.
   • Implement the SettingsRowSelected() event, which is the RowSelected event for the DAC with widget parameters; it contains the current values of the parameters of the widget instance and the list of available fields of the inquiry form. (For information on how to work with the fields of the inquiry form, see To Use the Parameters and Fields of the Inquiry Form in the Widget.) The signature of the method is shown below.

     protected virtual void SettingsRowSelected(PXCache cache, 
       TPrimary settings, InqField[] inqFields)

3. In the project, create a widget class. We recommend that you inherit this class from the PX.Dashboards.Widgets.InquiryBasedWidget class.
4. Compile your MYOB Acumatica extension library or MYOB Acumatica Framework-based application.
5. Run the application, and make sure that the new widget appears in the Add Widget dialog box. The widget class, which implements the IDashboardWidget interface, is detected by the system and automatically added to the list of widgets available for selection in the dialog box.

To Use the Parameters and Fields of the Inquiry Form in the Widget

To access the parameters of the inquiry form in the widget, use the GetParameters() method of the DataScreenBase class, which returns the InqField class.