Treatment Charting Component Renderer β Section-Based and API-Based Rendering
The treatment charting component renderer displays treatment chart form fields grouped by named chart sections, supporting both server-fetched and host-supplied data. This article explains how the renderer organizes sections, handles data loading states, and prepares fields for AI auto-fill β so you can understand what to expect when treatment chart forms open during an appointment.
Audience: Providers and front desk staff who open, fill, and submit treatment chart forms during appointments.
On this page
- Before you begin
- How section-based rendering works
- Load treatment chart data
- Understand section title formatting
- AI auto-fill field collection
- Alternate picker options
- Tips
- Troubleshooting
- Related articles
Before you begin
Your organization must have treatment chart forms configured and associated with the relevant services.
The form builder must be enabled for your organization.
You need the following permissions to view and edit treatment chart form data:
Permission: View under Guest Custom Data β Required to view guest form data. Admin path: Configuration > Security > Security roles > [your role] > Guests > Guest Custom Data > View
Permission: Edit under Guest Custom Data β Required to edit guest form data. Admin path: Configuration > Security > Security roles > [your role] > Guests > Guest Custom Data > Edit
Permission: View under Service Custom Data β Required to view service-level form data. Admin path: Configuration > Security > Security roles > [your role] > Services > Service Custom Data > View
Permission: Edit under Service Custom Data β Required to edit service-level form data. Admin path: Configuration > Security > Security roles > [your role] > Services > Service Custom Data > Edit
To export form lists, you also need:
Permission: View under Export Admin β Required to export forms or lists to Excel, PDF, or CSV.
Steps
How section-based rendering works
The treatment charting component renderer groups form fields by their assigned chart section, then displays each group in the order configured for that section. This means a single treatment chart response can be split across multiple named sections β for example, one section for pre-procedure fields and another for post-procedure fields β each appearing as a distinct, labeled block within the form.
Fields within each section render in display order, so the sequence you see on screen matches the order configured in the form definition. Sections are rendered one after another, with each section's title appearing as a heading above its fields.
Note: The renderer handles component templates that contain nested child fields but no explicit container type by automatically wrapping them in a panel. This ensures all child fields are displayed correctly without any fields being dropped or hidden.
Load treatment chart data
The renderer supports two ways to supply chart data to the form:
API-based loading
When the form is configured to fetch data from the server, the renderer retrieves treatment chart data automatically when the form opens. During this process:
- A loading indicator appears while data is being fetched. The Loading... message is displayed until the response is received.
- If the fetch fails, an error view is shown with a Retry button. Select Retry to attempt the fetch again.
- If the fetch succeeds but no data is available, an empty-state message is displayed to indicate there is nothing to show.
Host-supplied data
When the host application supplies chart data directly β for example, when the form is opened in a context where data has already been loaded β the renderer uses the provided data map without making a server request. In this mode, no loading indicator or error view is shown.
Worked example: A provider opens a treatment chart for a facial appointment. The form is split into two sections: Pre Procedure (intake fields, skin assessment checkboxes) and Post Procedure (treatment outcome notes, aftercare selections). The renderer fetches the chart data, displays the Loading... indicator briefly, then renders the Pre Procedure section followed by the Post Procedure section β each in its configured display order. If the provider's connection drops during fetch, a Retry button appears so they can reload without closing the form.
Understand section title formatting
Each section in a treatment chart has a key that identifies it internally. The renderer converts this key into a human-readable heading by replacing hyphens and underscores with spaces and applying title casing to each word.
The table below shows how common section keys are formatted as displayed headings:
| Section key | Displayed heading |
|---|---|
pre-procedure |
Pre Procedure |
post-procedure |
Post Procedure |
pre_treatment |
Pre Treatment |
post_treatment |
Post Treatment |
follow_up |
Follow Up |
This formatting is applied automatically. You do not need to configure display names separately β the section key drives the heading.
AI auto-fill field collection
When AI auto-fill is used on a treatment chart form, the renderer collects field keys from the entire component template tree before the fill sequence begins. This collection process traverses all nesting levels, including fields inside:
- Panels
- Columns
- Tabs
- Tables
- Datagrids
- Editgrids
Because the renderer collects fields at every depth, AI auto-fill can reach and populate any field in the form regardless of how deeply it is nested in the layout structure.
Important: AI auto-fill can be used only once per form per appointment. Once the fill sequence completes, the option is no longer available for that form in the current appointment.
Alternate picker options
The renderer supports alternate implementations for specific field types. These options are controlled at the host application level and apply to all matching fields in the treatment chart without requiring per-field configuration:
| Picker | What it affects |
|---|---|
| Date picker V2 | All date picker fields in the chart use the alternate date picker implementation when this option is enabled |
| Annotation pad V2 | All annotation pad fields in the chart use the alternate annotation pad implementation when this option is enabled |
| Signature pad V2 | All signature pad fields in the chart use the alternate signature pad implementation when this option is enabled |
Note: These picker options are integration parameters configured by the host application. There is no settings page in Zenoti to toggle them directly. Contact your administrator if you need to change which picker implementations are active for your organization's treatment chart forms.
Tips
- If a treatment chart form opens and shows an empty-state message instead of fields, confirm with your administrator that chart data has been saved for the current appointment. An empty state means the fetch succeeded but returned no data β it is not an error.
- When a treatment chart is split into pre-procedure and post-procedure sections, fill and save the pre-procedure section before the service begins so the post-procedure section captures outcome data separately. This keeps both sections accurate and time-stamped correctly.
- If a field appears to be missing from the treatment chart but is expected, check with your administrator whether the field is nested inside a panel or tab that may be initially collapsed. The renderer collects all fields regardless of nesting, but collapsed panels may hide fields visually until expanded.
- Use the Retry button immediately if an error view appears when opening a treatment chart β transient connectivity issues are the most common cause, and a single retry typically resolves the problem.
Troubleshooting
The loading indicator does not disappear and the form never shows fields.
The data fetch may be stalled due to a network issue or a server-side delay. Select Retry if the error view appears, or close and reopen the form. If the problem persists, contact your administrator to check connectivity and server status.
The Retry button appears every time a specific treatment chart form is opened.
A persistent fetch failure usually means the form is not receiving the information it needs to request data β for example, a missing appointment or guest reference. Contact your administrator to verify that the form is correctly associated with the service and that the appointment record is complete.
A section that should appear in the treatment chart is not visible.
Confirm that the section key is spelled correctly in the form definition. The renderer only displays sections that are present in the chart data response. If a section key does not match any data in the response, that section is not shown. Ask your administrator to verify the form configuration.
AI auto-fill did not populate fields that are inside a panel or tab.
Verify with your administrator that those fields are part of the form's component template tree. The renderer collects fields from panels, columns, tabs, tables, datagrids, and editgrids at all nesting levels. If a field is still not reached, it may be defined outside the expected component structure.
A section heading appears with underscores or hyphens instead of spaces.
This indicates that the section key is being displayed without the automatic title formatting being applied. Contact your administrator β this may indicate a rendering configuration issue specific to the host application context.