Home

Admin

Fields

SSN Field

ssnField

Properties

18 enabled · auto-save on toggle / blur

0

Label

label

text

text describing the control's purpose

primary

1

Text

text

text

text to display

primary

2

Title

title

text

text to display the header

primary

3

Existence

existence

boolean

determines whether the control exists in the compiled output [DEFAULTS TO: true]

primary

4

Data Template RefID

dataTemplateRefId

text

Runtime-substituted refID for each repeater instance. Must contain the literal token "@index@"; the slot key (everything after removing every "@index@") maps the child into the repeater's dataTemplate.

primary

5

Ref Id

refId

text

unique identifier for the component

primary

6

Conditional RefIDs

conditionalRefIds

conditional_refs

Relation-derived list of conditional refIds; authored via the field's Conditional RefIDs sub-section.

primary

7

Validation Required

validation_required

tri_state

Whether the field is required: True (always), False (never), or Conditional (required when the conditions are met).

primary

8

Source Account List

sourceAccountList

account_list_picker

Account-list identifier that drives derived options for account-ownership fields.

primary

9

Data Path

path

datapath_lookup

Object path where this field binds in the data store.

primary

10

Value

value

text

default value

primary

11

Limit

limit

number

number, limits the number of options that can be checked

primary

12

Repeater Limit

repeaterLimit

number (min 0)

Maximum number of repeater instances allowed.

primary

13

Items Are Not Removable Before Index

itemsAreNotRemovableBeforeIndex

number

before this index (zero based), repeater items won't have a "remove" button

primary

14

Add Label

addLabel

text

button to add new item [list: [+] Button]

primary

15

Remove Label

removeLabel

text

button to remove existing item [list: [remove] Option]

primary

16

Status

status

select [colors]

changes color of notification [OPTIONS: error / ok / warning / alert]

primary

17

Make Form Invalid

makeFormInvalid

boolean

stops form from being completed when notification is shown [OPTIONS: true / false]

primary

18

Is Closable

isClosable

boolean

makes notification not closable

primary

19

One Of

oneOf

options_list

List of selectable options (single-select). Each option has label / value / refId.

primary

20

Any Of

anyOf

options_list

List of selectable options. Each option has label / value / refId.

primary

21

On Check

onCheck

boolean

when checked, all other options are disabled/unchecked/both

primary

22

Disabled

disabled

boolean

determines whether the controls can be interacted with or not [DEFAULTS TO: false]

primary

23

Hidden

hidden

boolean

determines whether the controls is visible or not [DEFAULTS TO: false]

primary

24

Column Layout

columnLayout

select [columnLayout]

defines whether the checkboxes are displayed in one or two columns [DEFAULTS TO: two]

secondary

25

Columns

columns

number

optional value of 2 or 3, displays the radioGroup selection in a collapsed view [list: Radio Group Field (2-column dropdown)]

secondary

26

Expand Label

expandLabel

text

label text for button that expands the text [DEFAULTS TO: "Show More"]

secondary

27

Collapse Label

collapseLabel

text

label text for button that collapses the text [DEFAULTS TO: "Hide More"]

secondary

28

Allow Commas

allowCommas

boolean

defines whether commas are allowed or not [DEFAULTS TO: false]

secondary

29

Allow Decimal

allowDecimal

boolean

defines whether decimals are allowed or not [DEFAULTS TO: true]

secondary

30

Decimal Limit

decimalLimit

number

defines decimal limit for UI display [[allowDecimal: MUST be true] [DEFAULTS TO: 0.00]]

secondary

31

Allow Negative

allowNegative

boolean

defines whether negative values are allowed or not [DEFAULTS TO: false]

secondary

32

Max Visible Items

maxVisibleItems

number

limits the number of items that are visible

secondary

33

Mask Type

maskType

select []

Input mask type. Renders a dropdown from the static reference data list named by this field type's Mask Type default.

secondary

34

Format

format

select [dateFormat]

defines how the date is displayed [DEFAULTS TO: mmddyyyy]

secondary

35

Email Validation

email

boolean

Set email format validator for text input

secondary

36

Maximum Value

max

number

Maximum number value validator

secondary

37

Minimum Value

min

number

Minimum numerical value validator

secondary

38

Maximum Input Length

maxLength

number

Maximum Input Length validator

secondary

39

Minimum Input Length

minLength

number

Minimum Input Length validator

secondary

40

Exact Input Length

exactLength

number

Exact Input Length validator

secondary

41

Maximum Date

maxDate

date_modifier_chain

maximum date validator

secondary

42

Minimum Date

minDate

date_modifier_chain

minimum date validator

secondary

43

Equal Date

equalDate

date_modifier_chain

equal date validator

secondary

44

Required Checks

requiredChecks

text

Minimum number of selections required on a checkbox group.

secondary

45

Mask Format

maskFormat

select []

Format pattern paired with the mask type. Renders a dropdown from the static reference data list named by this field type's Mask Format default.

secondary

46

Calculated

calculated

text

calculation [MUST PROVIDE EXAMPLE]

secondary

47

Info Tooltip

infoTooltip

text

text that will be displayed on a tooltip when hovering the control

secondary

48

Placeholder

placeholder

text

text to display when the input is empty

secondary

49

Use Display Value Key

useDisplayValueKey

boolean

outgoing value for the PDF is switched from refIdField to labelField

secondary

50

Type

type

select [fieldType]

determines which component will be rendered

engineer

51

Children

children

options_list

collection of controls you want to group

engineer

52

Ref Id Field

refIdField

text

used to define the property name for the [anyOf] refId

engineer

53

Label Field

labelField

text

used to define the property name for the [anyOf] label

engineer

54

Value Field

valueField

text

used to define the property name for the [anyOf] value

engineer

55

Sublabel Field

sublabelField

text

used to define the property name for the [anyOf] subLabel

engineer

56

Tooltip Field

tooltipField

text

used to define the property name for the [anyOf] tooltip

engineer

57

Title Case Label

titleCaseLabel

boolean

prevents the labels for fields from automatically formatting undesired casing for the text

engineer

58

Null Value On Destroy

nullValueOnDestroy

boolean

When true, the stored value is set to null when the field is destroyed.

engineer

59

Erase Data On Destroy

eraseDataOnDestroy

boolean

if "true" and control is removed, all data will be removed

engineer

60

Data Template

dataTemplate

text

every control bound to the underlying list data is represented here

engineer

61

Template

template

text

repeating form portion, must be a group

engineer

62

Item Label Counts Invisible Items

itemLabelCountsInvisibleItems

boolean

if [itemsAreInvisibleBeforeIndex] is [1], then the first visible item (the second item) will have 1 instead of 2 in label [DEFAULTS TO: false]

engineer

63

Items Are Invisible Before Index

itemsAreInvisibleBeforeIndex

number

before this index (zero based), repeater items won't be visible

engineer

64

Store Action

storeAction

store_actions

one or more actions that will be dispatched when the component changes its value

engineer

65

Store Action On Load

storeActionOnLoad

store_actions

one or more actions that will be dispatched when the component loads for the first time

engineer

66

Store Action On Remove

storeActionOnRemove

text

if repeater item is removed, designated action will happen

engineer

Compiled output

✓ Conforms to forms-agent-v3.schema.json
{
  "type": "ssn",
  "refId": "previewField",
  "group": "order.forms.XXX.fields",
  "name": "previewFieldValue",
  "label": "",
  "placeholder": "",
  "value": "",
  "validation": [],
  "maskType": "SSNDash",
  "titleCaseLabel": false,
  "eraseDataOnDestroy": false,
  "nullValueOnDestroy": false
}

Compiled from 18 enabled properties · recompile to apply toggle / default changes.