Principal Investigator Email

← Back to Question Bank

Details

Form

Sample version of the rendered form.

PI Email Address*

Data

Form Data

What the form data looks like when it is submitted.

{
  "email": "pi@university.edu"
}

CommonGrants Data

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

{
  "contacts": {
    "otherContacts": {
      "principalInvestigator": {
        "emails": {
          "primary": "pi@university.edu"
        }
      }
    }
  }
}

Schemas

JSON Schema

Provides the structure and data validation for this question.

$id: QuestionPiEmail.yaml
type: object
unevaluatedProperties:
  not: {}
examples:
  - email: pi@university.edu
  - email: contact@example.com
description: The email address of the principal investigator
x-ui-schema:
  type: VerticalLayout
  elements:
    - type: Control
      scope: '#/properties/email'
      label: PI Email Address
x-mapping-to-cg:
  contacts:
    otherContacts:
      principalInvestigator:
        emails:
          primary:
            field: email
x-mapping-from-cg:
  email:
    field: contacts.otherContacts.principalInvestigator.emails.primary
x-entity:
  - principalInvestigator
x-tags:
  - person
  - email
required:
  - email
properties:
  email:
    description: Email address
    $schema: https://json-schema.org/draft/2020-12/schema
    $id: email.yaml
    type: string
    examples:
      - test@example.com
    format: email

UI Schema

Describes how to present the question in the form UI.

{
  "type": "VerticalLayout",
  "elements": [
    {
      "type": "Control",
      "scope": "#/properties/email",
      "label": "PI Email Address"
    }
  ]
}

Mappings

Mapping to CommonGrants

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

{
  "contacts": {
    "otherContacts": {
      "principalInvestigator": {
        "emails": {
          "primary": {
            "field": "email"
          }
        }
      }
    }
  }
}

Mapping from CommonGrants

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

{
  "email": {
    "field": "contacts.otherContacts.principalInvestigator.emails.primary"
  }
}