Show Menu
화제×

JSON 스키마를 사용하여 적응형 양식 만들기

전제 조건

JSON 스키마를 양식 모델로 사용하여 적응형 양식을 작성하려면 JSON 스키마에 대한 기본적인 이해가 필요합니다. 이 아티클 이전에 다음 콘텐츠를 읽어 보시기 바랍니다.

JSON 스키마를 양식 모델로 사용

AEM Forms에서는 기존 JSON 스키마를 양식 모델로 사용하여 적응형 양식 작성을 지원합니다. 이 JSON 스키마는 조직의 백엔드 시스템에서 데이터를 생성하거나 사용하는 구조를 나타냅니다. 사용하는 JSON 스키마는 v4 사양을 준수해야 합니다.
JSON 스키마 사용의 주요 기능은 다음과 같습니다.
  • JSON의 구조는 적응형 양식의 작성 모드에서 컨텐츠 파인더 탭에 트리로 표시됩니다. JSON 계층 구조에서 적응형 양식으로 요소를 드래그하여 추가할 수 있습니다.
  • 연결된 스키마를 준수하는 JSON을 사용하여 양식을 미리 채울 수 있습니다.
  • 제출 시 사용자가 입력한 데이터는 관련 스키마와 일치하는 JSON으로 제출됩니다.
JSON 스키마는 간단하고 복잡한 요소 유형으로 구성됩니다. 요소에는 요소에 규칙을 추가하는 속성이 있습니다. 이러한 요소와 속성을 적응형 양식으로 드래그하면 해당 적응형 양식 구성 요소에 자동으로 매핑됩니다.
적응형 양식 구성 요소가 있는 JSON 요소의 매핑은 다음과 같습니다.
JSON 요소, 속성 또는 속성 적응형 양식 구성 요소
enum 및 enumNames 제약 조건이 있는 문자열 속성입니다.
구문,
{
"type" : "string",
"enum" : ["M", "F"]
"enumNames" : ["Male", "Female"]
}
드롭다운 구성 요소:
  • enumNames에 나열된 값은 드롭 상자에 표시됩니다.
  • 열거형에 나열된 값은 계산에 사용됩니다.
형식 제한이 있는 문자열 속성입니다. 예: 이메일 및 날짜.
구문,
{
"type" : "string",
"format" : "email"
}
  • 이메일 구성 요소는 유형이 문자열이고 형식이 이메일인 경우 매핑됩니다.
  • 형식이 문자열이고 형식이 hostname이면 유효성 검사가 있는 Textbox 구성 요소가 매핑됩니다.
{
"type" :"string",
}
텍스트 필드
number 속성 하위 유형이 부동 항목으로 설정된 숫자 필드
정수 속성 하위 유형이 정수로 설정된 숫자 필드
부울 속성 전환
object property 패널
배열 속성 최소 및 최대 값이 minItems 및 maxItems와 각각 같은 반복 가능한 패널입니다. 단일 배열만 지원됩니다. 따라서 항목 제약 조건은 배열이 아닌 객체여야 합니다.

공통 스키마 속성

적응형 양식에서는 JSON 스키마에서 사용할 수 있는 정보를 사용하여 생성된 각 필드를 매핑합니다. 특히:
  • title 속성은 응용 양식 구성 요소의 레이블로 사용됩니다.
  • description 속성은 적응형 양식 구성 요소에 대한 긴 설명으로 설정됩니다.
  • 기본 속성은 적응형 양식 필드의 초기 값 역할을 합니다.
  • maxLength 속성은 텍스트 필드 구성 요소의 maxlength 속성으로 설정됩니다.
  • 최소값, 최대값, exclusiveMinimum 및 exclusiveMaximum 속성은 숫자 상자 구성 요소에 사용됩니다.
  • DatePicker 구성 요소에 대한 범위를 지원하기 위해 minDate 및 maxDate 추가 JSON 스키마 속성이 제공됩니다.
  • minItems 및 maxItems 속성은 패널 구성 요소에서 추가 또는 제거할 수 있는 항목/필드의 수를 제한하는 데 사용됩니다.
  • readOnly 속성은 적응형 양식 구성 요소의 readonly 속성을 설정합니다.
  • 필수 속성은 적응형 양식 필드를 필수로 표시하지만 패널(유형이 개체인 경우)의 경우, 마지막으로 제출된 JSON 데이터에는 해당 객체에 해당하는 빈 값이 있는 필드가 있습니다.
  • pattern 속성은 적응형 양식에서 유효성 검사 패턴(정규 표현식)으로 설정됩니다.
  • JSON 스키마 파일 확장자는 .schema.json에 보관해야 합니다. 예: <filename>.schema.json.

샘플 JSON 스키마

다음은 JSON 스키마의 예입니다.
{
 "$schema": "https://json-schema.org/draft-04/schema#",
 "definitions": {
  "employee": {
   "type": "object",
   "properties": {
    "userName": {
     "type": "string"
    },
    "dateOfBirth": {
     "type": "string",
     "format": "date"
    },
    "email": {
     "type": "string",
     "format": "email"
    },
    "language": {
     "type": "string"
    },
    "personalDetails": {
     "$ref": "#/definitions/personalDetails"
    },
    "projectDetails": {
     "$ref": "#/definitions/projectDetails"
    }
   },
   "required": [
    "userName",
    "dateOfBirth",
    "language"
   ]
  },
  "personalDetails": {
   "type": "object",
   "properties": {
    "GeneralDetails": {
     "$ref": "#/definitions/GeneralDetails"
    },
    "Family": {
     "$ref": "#/definitions/Family"
    },
    "Income": {
     "$ref": "#/definitions/Income"
    }
   }
  },
  "projectDetails": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     },
     "projects": {
      "$ref": "#/definitions/projects"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "projects": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     },
     "projectsAdditional": {
      "$ref": "#/definitions/projectsAdditional"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "projectsAdditional": {
   "type": "array",
   "items": {
    "properties": {
     "Additional_name": {
      "type": "string"
     },
     "Additional_areacode": {
      "type": "number"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "GeneralDetails": {
   "type": "object",
   "properties": {
    "age": {
     "type": "number"
    },
    "married": {
     "type": "boolean"
    },
    "phone": {
     "type": "number",
     "aem:afProperties": {
      "sling:resourceType": "/libs/fd/af/components/guidetelephone",
      "guideNodeClass": "guideTelephone"
     }
    },
    "address": {
     "type": "string"
    }
   }
  },
  "Family": {
   "type": "object",
   "properties": {
    "spouse": {
     "$ref": "#/definitions/spouse"
    },
    "kids": {
     "$ref": "#/definitions/kids"
    }
   }
  },
  "Income": {
   "type": "object",
   "properties": {
    "monthly": {
     "type": "number"
    },
    "yearly": {
     "type": "number"
    }
   }
  },
  "spouse": {
   "type": "object",
   "properties": {
    "name": {
     "type": "string"
    },
    "Income": {
     "$ref": "#/definitions/Income"
    }
   }
  },
  "kids": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  }
 },
 "type": "object",
 "properties": {
  "employee": {
   "$ref": "#/definitions/employee"
  }
 }
}

재사용 가능한 스키마 정의

정의 키는 재사용 가능한 스키마를 식별하는 데 사용됩니다. 재사용 가능한 스키마 정의는 조각을 만드는 데 사용됩니다. XSD에서 복잡한 형식을 식별하는 것과 비슷합니다. 정의가 있는 샘플 JSON 스키마는 다음과 같습니다.
{
  "$schema": "https://json-schema.org/draft-04/schema#",
 
  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" }
      },
      "required": ["street_address", "city", "state"]
    }
  },
 
  "type": "object",
 
  "properties": {
    "billing_address": { "$ref": "#/definitions/address" },
    "shipping_address": { "$ref": "#/definitions/address" }
  }
}

위의 예에서는 고객 레코드를 정의합니다. 이 고객 각에는 배송과 청구 주소가 모두 있습니다. 두 주소의 구조는 동일합니다. 주소에는 주소, 시/도가 있습니다. 따라서 주소를 복제하지 않는 것이 좋습니다. 또한 나중에 변경할 수 있도록 필드를 손쉽게 추가하거나 삭제할 수 있습니다.

JSON 스키마 정의의 사전 구성 필드

aem:afProperties 속성을 사용하여 JSON 스키마 필드를 사전 구성하여 사용자 지정 적응형 양식 구성 요소에 매핑할 수 있습니다. 다음은 예입니다.
{
    "properties": {
        "sizeInMB": {
            "type": "integer",
            "minimum": 16,
            "maximum": 512,
            "aem:afProperties" : {
                 "sling:resourceType" : "/apps/fd/af/components/guideTextBox",
                 "guideNodeClass" : "guideTextBox"
             }
        }
    },
    "required": [ "sizeInMB" ],
    "additionalProperties": false
}

응용 양식 구성 요소에 사용할 수 있는 값 제한

JSON 스키마 요소에 다음 제한 사항을 추가하여 적응형 양식 구성 요소에 허용되는 값을 제한할 수 있습니다.
스키마 속성
데이터 유형
설명
구성 요소
maximum
문자열
숫자 값과 날짜에 대한 상한을 지정합니다. 기본적으로 최대값이 포함됩니다.
  • 숫자 상자
  • 숫자 스텝퍼
  • 날짜 선택
minimum
문자열
숫자 값과 날짜에 대해 하한을 지정합니다. 기본적으로 최소값이 포함됩니다.
  • 숫자 상자
  • 숫자 스텝퍼
  • 날짜 선택
exclusiveMaximum
부울
true인 경우 양식의 구성 요소에 지정된 숫자 값 또는 날짜는 최대 속성에 지정된 숫자 값 또는 날짜보다 작아야 합니다.
false인 경우 양식의 구성 요소에 지정된 숫자 값 또는 날짜는 최대 속성에 지정된 숫자 값 또는 날짜보다 작거나 같아야 합니다.
  • 숫자 상자
  • 숫자 스텝퍼
  • 날짜 선택
exclusiveMinimum
부울
true이면 양식의 구성 요소에 지정된 숫자 값 또는 날짜가 최소 속성에 지정된 숫자 값 또는 날짜보다 커야 합니다.
false인 경우 양식의 구성 요소에 지정된 숫자 값 또는 날짜는 최소 속성에 지정된 숫자 값 또는 날짜보다 크거나 같아야 합니다.
  • 숫자 상자
  • 숫자 스텝퍼
  • 날짜 선택
minLength
문자열
구성 요소에 허용되는 최소 문자 수를 지정합니다. 최소 길이는 0보다 크거나 같아야 합니다.
  • 텍스트 상자
maxLength 문자열 구성 요소에 허용되는 최대 문자 수를 지정합니다. 최대 길이는 0보다 크거나 같아야 합니다.
  • 텍스트 상자
pattern
문자열
문자 시퀀스를 지정합니다. 구성 요소는 문자가 지정된 패턴을 따르는 경우 문자를 허용합니다.
패턴 속성은 해당 적응형 양식 구성 요소의 유효성 검사 패턴에 매핑됩니다.
  • XSD 스키마에 매핑되는 모든 응용 양식 구성 요소
maxItems 문자열 배열의 최대 항목 수를 지정합니다. 최대 항목은 0보다 크거나 같아야 합니다.
minItems 문자열 배열에서 최소 항목 수를 지정합니다. 최소 항목은 0보다 크거나 같아야 합니다.

지원되지 않는 구문

적응형 양식은 다음 JSON 스키마 구문을 지원하지 않습니다.
  • Null 유형
  • 모든 조합 유형 및
  • OneOf, AnyOf, AllOf, NOT
  • 단일 배열만 지원됩니다. 따라서 항목 제약 조건은 객체가 되어야 하며 배열이어야 합니다.

Frequently asked questions

반복 가능한 하위 폼의 개별 요소(복잡한 형식에서 생성된 구조)를 드래그할 수 없는 이유는 무엇입니까(minOccours 또는 maxOccurs 값은 1보다 큼)?
반복 가능한 하위 양식에서는 전체 하위 양식을 사용해야 합니다. 선택적 필드만 원하는 경우 전체 구조를 사용하고 원하지 않는 필드를 삭제합니다.
Content Finder에 구조가 너무 복잡합니다. 특정 요소를 찾으려면 어떻게 해야 합니까?
두 가지 옵션이 있습니다.
  • 트리 구조를 스크롤합니다.
  • 검색 상자를 사용하여 요소 찾기