Generic Name

← Back to Question Bank

Details

Form

Sample version of the rendered form.

Name

PrefixNone

First Name*

Middle Name

Last Name*

SuffixNone

Data

Form Data

What the form data looks like when it is submitted.

{
  "prefix": "Dr.",
  "firstName": "Jane",
  "middleName": "Edward",
  "lastName": "Doe",
  "suffix": "Jr."
}

CommonGrants Data

What the data looks like translated to the CommonGrants data model using the mapping-to-cg.

{
  "prefix": "Dr.",
  "firstName": "Jane",
  "middleName": "Edward",
  "lastName": "Doe",
  "suffix": "Jr."
}

Schemas

JSON Schema

Provides the structure and data validation for this question.

$id: QuestionName.yaml
type: object
required:
  - firstName
  - lastName
examples:
  - prefix: Dr.
    firstName: Jane
    middleName: Edward
    lastName: Doe
    suffix: Jr.
description: A generic name question with structured prefix and suffix enums
x-ui-schema:
  type: Group
  label: Name
  elements:
    - type: Control
      scope: '#/properties/prefix'
      label: Prefix
    - type: Control
      scope: '#/properties/firstName'
      label: First Name
    - type: Control
      scope: '#/properties/middleName'
      label: Middle Name
    - type: Control
      scope: '#/properties/lastName'
      label: Last Name
    - type: Control
      scope: '#/properties/suffix'
      label: Suffix
x-mapping-to-cg:
  prefix:
    field: prefix
  firstName:
    field: firstName
  middleName:
    field: middleName
  lastName:
    field: lastName
  suffix:
    field: suffix
x-mapping-from-cg:
  prefix:
    field: prefix
  firstName:
    field: firstName
  middleName:
    field: middleName
  lastName:
    field: lastName
  suffix:
    field: suffix
x-tags:
  - name
properties:
  prefix:
    description: Honorific prefix
    $schema: https://json-schema.org/draft/2020-12/schema
    $id: NamePrefix.yaml
    type: string
    enum:
      - Mr.
      - Ms.
      - Mrs.
      - Dr.
      - Prof.
  firstName:
    type: string
    description: First or given name
  middleName:
    type: string
    description: Middle name
  lastName:
    type: string
    description: Last or family name
  suffix:
    description: Name suffix
    $schema: https://json-schema.org/draft/2020-12/schema
    $id: NameSuffix.yaml
    type: string
    enum:
      - Jr.
      - Sr.
      - II
      - III
      - IV
      - Ph.D.
      - M.D.
      - Esq.

UI Schema

Describes how to present the question in the form UI.

{
  "type": "Group",
  "label": "Name",
  "elements": [
    {
      "type": "Control",
      "scope": "#/properties/prefix",
      "label": "Prefix"
    },
    {
      "type": "Control",
      "scope": "#/properties/firstName",
      "label": "First Name"
    },
    {
      "type": "Control",
      "scope": "#/properties/middleName",
      "label": "Middle Name"
    },
    {
      "type": "Control",
      "scope": "#/properties/lastName",
      "label": "Last Name"
    },
    {
      "type": "Control",
      "scope": "#/properties/suffix",
      "label": "Suffix"
    }
  ]
}

Mappings

Mapping to CommonGrants

How to translate this question into the CommonGrants ProposalBase data model.

{
  "prefix": {
    "field": "prefix"
  },
  "firstName": {
    "field": "firstName"
  },
  "middleName": {
    "field": "middleName"
  },
  "lastName": {
    "field": "lastName"
  },
  "suffix": {
    "field": "suffix"
  }
}

Mapping from CommonGrants

How to pre-fill this question with data from the ProposalBase data model.

{
  "prefix": {
    "field": "prefix"
  },
  "firstName": {
    "field": "firstName"
  },
  "middleName": {
    "field": "middleName"
  },
  "lastName": {
    "field": "lastName"
  },
  "suffix": {
    "field": "suffix"
  }
}