Socotra
ConfigurationConfigurable UI (Beta)

Section Types

A section with a type shows built-in content, such as pricing or documents, instead of the fields in its include. Its settings go in the section's config. For the properties every section takes, see Sections and Layout. For example:

{
	"title": "Pricing Preview",
	"type": "pricing-review",
	"config": { "presentation": { "hideReferenceRate": true } }
}

Types

typeRenders
(none)A standard section of the include fields.
noteStatic markdown help text from config.asset, styled with config.type: neutral (default), info, warning, or alert.
buttonsA row of action buttons, listed in config.
producer-summaryA read-only summary of a producer, laid out by the producer's overview (see Producers). config can set title, hideTitle, and sections to replace that layout here.
pluginA registered frontend plugin. config.pluginName is required.
documentsThe quote's or policy's generated and uploaded documents.
transactionsThe policy's transaction history.
underwritingUnderwriting flag results, optionally grouped by category.
underwriting-originalThe flag table: active and cleared flags with clear actions, as on the Underwriting page. Takes the same config as underwriting. Use either this or underwriting, not both.
pricingThe pricing breakdown.
pricing-reviewA read-only pricing snapshot that persists after pricing and issue.
previous-term-pricing-reviewOn a transaction's pricing step, the committed pricing before the transaction: for a change, the affected term; for a renewal, the preceding issued term. Shows as unavailable on issuance. Takes config.presentation like pricing-review.
rater-selectionA rater picker with a pricing preview per rater.
validation-previewValidation results, shown only while the quote or transaction can be edited.
tasksTasks for the current quote or policy. Hidden when work management is off or the user lacks read access.
work-managementWork management tasks for the quote or policy. Hidden under the same conditions as tasks.
notesAdd-only notes backed by diary entries. Notes attach to the current quote unless config.referenceType points elsewhere.
schedulesA large, like-typed list attached to an element, with file import and a preview. Name the element with elementName.
aux-dataA single aux data value, display only.

Configuration by Type

The following types read a type-specific config. The transactions, validation-preview, tasks, and work-management types take no config; they render from platform data and the section's own title and hideTitle.

Note

PropertyTypeDescription
typestringCallout style: neutral (default), info, warning, or alert.
assetstringPath to a markdown file in the config assets. The note's body. Takes precedence over content.
contentstringLegacy. The file name of a markdown file built into the app. Read only when asset is not set.

Buttons

For this type, config is an array of buttons. Each takes the same properties as a step button; see Buttons and Navigation.

Plugin

PropertyTypeDescription
pluginNamestringRequired. The registered frontend plugin to mount.
pluginOptionsobjectOptions passed to the plugin, such as a grid plugin's gridTypes and addBtnText.
pluginParamsobjectMaps parameter keys to Automation Plugin targets, as { name, action, … }.

Documents

PropertyTypeDescription
excludearrayHides documents by metadata tag (document.metadata.tag). To hide generated documents by static name, use excludeGenerated.
externalbooleanShows only external (true) or only generated (false) documents.
showAttachButtonbooleanShows the attach button and a delete control on each row. Defaults to false.
attachButtonFieldLabelstringThe label shown above the attach button.
attachmentTagstringThe tag added to attached documents. Defaults to __ADDITIONAL_ATTACHMENTS__.
excludeGeneratedarrayHides generated documents by static name. Each entry is a static name, or { staticName, scope }.

Underwriting

PropertyTypeDescription
tagstringShows only flags with this tag.
categoriesarrayThe groups to render. Each entry is a category name, or { name, title, collapse, displayOrder }, where collapse is expanded or collapsed.
statusesobjectMaps your tenant's status values to fail, warning, or pass.
defaultStatusstringThe status used when a flag's status can't be read: fail, warning (default), or pass.
uncategorizedobjectA final group for flags with no known category, as { title, hide }. hide drops them.
hideEmptyCategoriesbooleanOmits groups that have no flags.

underwriting-original reads the same properties, but tag doesn't filter its table, and uncategorized.hide, hideEmptyCategories, and collapse are ignored, so every flag stays clearable.

Pricing and Pricing Review

Both types take the same config.

PropertyTypeDescription
tagstringThe pricing tag to show.
tagFieldNamestringA form field whose value supplies the tag. Takes precedence over tag.
rateComponentsobjectReads rate-component rows from aux data, as { "source": "auxData", "key": … }.
presentationobjectA single presentation preset.
pricingPresentationsobjectPresentation presets keyed by tag value.
sourcestringpricing-review only. Which term's premium the snapshot shows: term, resultingTerm, or resultingAnnualizedPremium.

Rater Selection

PropertyTypeDescription
ratersarrayThe raters users can choose from.
raterFieldNamestringThe form field that holds the chosen rater.
raterTitleTemplatestringA ${…} template for each rater's title.
rateComponentsobjectReads each rater's rate components from aux data, as { "source": "auxData", "key": … }.
pricingPresentationsobjectPresentation presets keyed by rater.

Presentation Presets

A presentation preset is the value of presentation, and of each entry in pricingPresentations.

PropertyTypeDescription
hideReferenceRatebooleanHides the per-day reference rate column. Hidden by default; set false to show it.
groupUnderElementNamestringThe element type that holds the policy-level charges.
elementTitleTemplatesobjectHeading templates per element type, such as { "HO3Dwelling": "Dwelling ${data.propertyCity}" }.
policyLevelChargesarrayOrdered charge rows, as { chargeType, displayName }, or { "match": "*" } to keep every unlisted charge in place.

Notes

PropertyTypeDescription
referenceTypestringThe entity the notes are attached to, such as quote, policy, or elements. Defaults to quote.
referenceLocatorTemplatestringA ${…} template that resolves the reference locator, such as element.locator, element.staticLocator, or quote.locator.
createActionobjectCreates notes attached to a quote element, as { "type": "quoteElement", quoteLocatorTemplate, staticElementLocatorTemplate }. Both templates must resolve.
categoryTemplatestringA ${…} template for the diary category of new notes.
showCreateFormbooleanShows the add-note form. Defaults to true.

Schedules

PropertyTypeDescription
previewColumnsarrayColumns in the read-only preview. Each entry is a field name or { field, label }.
previewItemCountnumberHow many items the preview shows. Defaults to 10.
acceptedFileTypesstring or arrayThe file types users can import, such as [".csv", ".xlsx"].
deserializationParamsobjectParameters passed to the product's deserialization plugin, for non-CSV schedules.

Aux Data

PropertyTypeDescription
keystringRequired. The aux data key to read and show.
formatstringmarkdown renders the value as markdown.

Next Steps

See Also

On this page