Custom Report (CustomWidget) — User Guide
What it is
- A Custom Report lets you embed a custom widget or program output instead of the built-in chart/table renderers.
Required configuration fields
- Name
- Display Name
- Data Source
- Report Type: "CustomWidget"
- Valid For
- Definition
- Precision
- Grand Totals
- Export To CSV
- Export To Excel
- Program Name (only if Definition = Custom)
- Custom Widget Name (only if Report Type = CustomWidget)
- Show State Filter
- Show Parent Filter
- Show Attribute Filter
How it works
- The app will look up the custom widget by Custom Widget Name and render it, passing report data and config. Ensure your custom widget is registered and accepts the expected props: data, config, onDrilldown, etc.
Tips
- If your custom widget needs additional parameters, put them inside config.customProperties and document them for the widget implementer.
- Validate that the widget is lazy-loadable (React.lazy) and exported from the dynamic imports mapping (see `src/Components/Common/dynamicFormComponentsImports.jsx` for the pattern).
Success criteria
- The custom widget appears in place of standard renderers when reportDisplayType is "CustomWidget" and the widget is resolvable.