Creating a Section
Build and attach a new section of Additional Info in the Wicket admin
This page walks through creating a section of Additional Info in the Wicket admin, from defining the schema to attaching it to a person or organization.
Editing schemas is restricted to logged-in users with administrative rights.
Before you start
Every section begins with two JSON objects:
- Schema — holds all of the structural information (objects, properties, types, and validation rules).
- UI Schema — holds all of the display information (the section title, field labels, drop-down values, UI order, etc.).
See Field Types for the building blocks, and Examples for ready-to-adapt snippets.
Steps
Add a section
From the schema editor, choose Add Section. Enter a Key for the section — this is the section's internal name, e.g. this_section.
The key uniquely identifies the section and is often used to pull reports. In some implementations many schemas represent the same data and share the same key.
Define the Schema
Under Schema, place the JSON describing your data structure. Wicket conventions:
- Make the root of the definition an
object. This lets you add new properties later without migrating data and makes defining required fields easy. - When the only data you need to store is an array, still make the root an
objectwith an array property. - If that single array can be left empty, add a hidden
booleanproperty (typically namedhidden) with a default value, so the section can be considered complete even when the array is empty.
{
"type": "object",
"properties": {
"fieldName": {
"type": "string"
}
}
}Define the UI Schema
Under UI Schema, place the JSON describing how the fields are displayed — the section title, field labels, drop-down values, and UI order.
The UI Schema template already includes an outline for the section title. Fill it in:
{
"ui:i18n": {
"title": {
"en": "Additional Info Section",
"fr": "Section d'information supplémentaire"
}
}
}Preview and submit
Click Generate Preview to confirm the section renders correctly, then Submit Schema. The section is created, but is not yet attached to an entity.
Re-open the section
Select the new section again. Wicket will have generated the $schema, title, and $id values, and an + Add New Resource button will now appear.
Add a resource
Click + Add New Resource and configure where the section should appear:
| Option | Purpose |
|---|---|
| Entity | The record type the section attaches to — Person, Organization, Order (used for membership types), etc. |
| Context | Where the section is viewed. Leave blank to show on the person/organization profile. Use SubmissionPreview for the onboarding workflow, or Widget to embed the section in a website. |
| Weight | Sort order relative to other sections — weight 0 appears first, then 1, and so on. Use a high number (e.g. 99) to always appear last. |
| UI Schema Overrides | Context-specific UI changes layered on top of the section's UI Schema. See Resources & Overrides. |
| Scopes | Used to further narrow when a section shows (e.g. by order type or membership). |
You cannot change the entity or context of a resource after it is created — set them correctly the first time.
Submit the resource
Click Submit Resource & Schemas. The section will now appear on the configured Person or Organization profile in Wicket.
Section ordering
To re-order how sections appear on a record, adjust the weight on the resource attached to the schema. Open the schema editor for the section, click show resources, open the relevant resource, set the weight (larger numbers appear toward the bottom), and submit.