JSON 스키마를 사용하여 적응형 양식 만들기 creating-adaptive-forms-using-json-schema

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:

작성 대상:

초급
중간
사용자
개발자

새 적응형 양식 만들기또는 AEM Sites 페이지에 적응형 양식 추가작업을 할 때 현대적이고 확장 가능한 데이터 캡처 핵심 구성 요소를 사용하는 것이 좋습니다. 이러한 구성 요소는 적응형 양식 만들기 작업이 대폭 개선되어 우수한 사용자 경험을 보장할 수 있게 되었음을 나타냅니다. 이 문서에서는 기초 구성 요소를 사용하여 적응형 양식을 작성하는 이전 접근법에 대해 설명합니다.

버전

문서 링크

AEM as a Cloud Service

여기 클릭

AEM 6.5

이 문서

사전 요구 사항 prerequisites

JSON 스키마를 양식 모델로 사용하여 적응형 양식을 작성하려면 JSON 스키마에 대한 기본적인 이해가 필요합니다. 이 문서 전에 다음 내용을 읽어 보는 것이 좋습니다.

양식 모델로 JSON 스키마 사용 using-a-json-schema-as-form-model

Adobe Experience Manager Forms에서는 기존 JSON 스키마를 양식 모델로 사용하여 적응형 양식을 만들 수 있습니다. 이 JSON 스키마는 조직의 백엔드 시스템이 데이터를 생산 또는 소비하는 구조를 나타냅니다. 사용하는 JSON 스키마는 v4 사양을 준수해야 합니다.

JSON 스키마 사용의 주요 기능은 다음과 같습니다.

적응형 양식의 작성 모드에서 JSON 구조는 콘텐츠 파인더 탭에 트리로 표시됩니다. 요소를 JSON 계층에서 적응형 양식으로 드래그하여 추가할 수 있습니다.
연결된 스키마와 호환되는 JSON을 사용하여 양식을 미리 채울 수 있습니다.
제출 시 사용자가 입력한 데이터는 관련 스키마에 맞는 JSON으로 제출됩니다.

JSON 스키마는 간단하고 복잡한 요소 유형으로 구성됩니다. 요소에는 요소에 규칙을 추가하는 속성이 있습니다. 이러한 요소와 속성을 적응형 양식으로 드래그하면 해당 적응형 양식 구성 요소에 자동으로 매핑됩니다.

적응형 양식 구성 요소와 JSON 요소의 이 매핑은 다음과 같습니다.

"birthDate": {
              "type": "string",
              "format": "date",
              "pattern": "date{DD MMMM, YYYY}",
              "aem:affKeyword": [
                "DOB",
                "Date of Birth"
              ],
              "description": "Date of birth in DD MMMM, YYYY",
              "aem:afProperties": {
                "displayPictureClause": "date{DD MMMM, YYYY}",
                "displayPatternType": "date{DD MMMM, YYYY}",
                "validationPatternType": "date{DD MMMM, YYYY}",
                "validatePictureClause": "date{DD MMMM, YYYY}",
                "validatePictureClauseMessage": "Date must be in DD MMMM, YYYY format."
              }

JSON 요소, 속성 또는 속성

적응형 양식 구성 요소

enum 및 enumNames 제약 조건을 사용하는 문자열 속성입니다.

구문,

{

"type" : "string",

"enum" : ["M", "F"]

"enumNames" : ["Male", "Female"]

}

드롭다운 구성 요소:

enumNames에 나열된 값은 드롭 상자에 표시됩니다.
열거형에 나열된 값은 계산에 사용됩니다.

형식 제약 조건이 있는 문자열 속성. (예: 이메일 및 날짜)

구문,

{

"type" : "string",

"format" : "email"

}

유형이 문자열이고 포맷이 이메일인 경우 이메일 구성 요소는 매핑됩니다.
유형이 문자열이고 형식이 hostname인 경우 유효성 검사가 있는 Textbox 구성 요소가 매핑됩니다.

{

"type" : "string",

}

텍스트 필드

number 속성

하위 형식이 float
(으)로 설정된 숫자 필드

정수 속성

하위 유형이 정수
(으)로 설정된 숫자 필드

부울 속성

전환

개체 속성

패널

배열 속성

min 및 max가 각각 minItems 및 maxItems와 같은 반복 가능한 패널. Homogeneous 배열만 지원됩니다. 따라서 항목 제약 조건은 배열이 아닌 개체여야 합니다.

일반 스키마 속성 common-schema-properties

적응형 양식은 JSON 스키마에서 사용할 수 있는 정보를 사용하여 생성된 각 필드를 매핑합니다. 특히

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

샘플 JSON 스키마 sample-json-schema

다음은 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"
  }
 }
}

재사용 가능한 스키마 정의 reusable-schema-definitions

정의 키는 재사용 가능한 스키마를 식별하는 데 사용됩니다. 재사용 가능한 스키마 정의는 조각을 만드는 데 사용됩니다. 이는 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 스키마 정의의 사전 구성 필드 pre-configuring-fields-in-json-schema-definition

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
}

양식 개체에 대한 스크립트 또는 표현식 구성 configure-scripts-or-expressions-for-form-objects

JavaScript은 적응형 양식의 표현식 언어입니다. 모든 표현식은 유효한 JavaScript 표현식이며 적응형 양식 스크립팅 모델 API를 사용합니다. 양식 이벤트에서 식을 평가하도록 양식 개체를 미리 구성할 수 있습니다.

aem:afproperties 속성을 사용하여 적응형 양식 구성 요소에 대한 적응형 양식 표현식 또는 스크립트를 미리 구성합니다. 예를 들어 초기화 이벤트가 트리거되면 아래 코드는 전화 필드의 값을 설정하고 값을 로그에 인쇄합니다.

"telephone": {
  "type": "string",
  "pattern": "/\\d{10}/",
  "aem:affKeyword": ["phone", "telephone","mobile phone", "work phone", "home phone", "telephone number", "telephone no", "phone number"],
  "description": "Telephone Number",
  "aem:afProperties" : {
    "sling:resourceType" : "fd/af/components/guidetelephone",
    "guideNodeClass" : "guideTelephone",
    "events": {
      "Initialize" : "this.value = \"1234567890\"; console.log(\"ef:gh\") "
    }
  }
}

양식 개체에 대한 스크립트나 식을 구성하려면 forms-power-user 그룹의 구성원이어야 합니다. 아래 표에는 적응형 양식 구성 요소에 대해 지원되는 모든 스크립트 이벤트가 나열되어 있습니다.

구성 요소
이벤트

초기화

연산

가시성

유효성 검사

활성화됨

valueCommit

클릭

옵션

텍스트 필드

숫자 필드

숫자 스텝퍼

라디오 버튼

전화 번호

전환

버튼

확인란

드롭다운

이미지 선택

데이터 입력 필드

날짜 선택기

이메일

첨부 파일

이미지

Draw

패널

JSON에서 이벤트를 사용하는 몇 가지 예는 초기화 이벤트에서 필드를 숨기고 값 커밋 이벤트에서 다른 필드의 값을 구성하는 것입니다. 스크립트 이벤트의 식을 만드는 방법에 대한 자세한 내용은 적응형 양식 식을 참조하세요.

다음은 이전에 언급된 예제에 대한 샘플 JSON 코드입니다.

초기화 이벤트에서 필드 숨기기 hiding-a-field-on-initialize-event

"name": {
    "type": "string",
    "aem:afProperties": {
        "events" : {
            "Initialize" : "this.visible = false;"
        }
    }
}

값 커밋 이벤트에 대한 다른 필드 값 구성 configure-value-of-another-field-on-value-commit-event

"Income": {
    "type": "object",
    "properties": {
        "monthly": {
            "type": "number",
            "aem:afProperties": {
                "events" : {
                    "Value Commit" : "IncomeYearly.value = this.value * 12;"
                }
            }
        },
        "yearly": {
            "type": "number",
            "aem:afProperties": {
                "name": "IncomeYearly"
            }
        }
    }
}

적응형 양식 구성 요소에 대해 허용되는 값 제한 limit-acceptable-values-for-an-adaptive-form-component

다음 제한 사항을 JSON 스키마 요소에 추가하여 적응형 양식 구성 요소에 허용되는 값을 제한할 수 있습니다.

스키마 속성

데이터 형식

설명

구성 요소

maximum

문자열

숫자 값 및 날짜의 상한을 지정합니다. 기본적으로 최대값이 포함됩니다.

숫자 상자
숫자 스텝퍼
날짜 선택기

minimum

문자열

숫자 값 및 날짜의 하한을 지정합니다. 기본적으로 최소값이 포함됩니다.

숫자 상자
숫자 스텝퍼
날짜 선택기

exclusiveMaximum

부울

true인 경우 양식의 구성 요소에 지정된 숫자 값 또는 날짜는 최대 속성에 지정된 숫자 값 또는 날짜보다 작아야 합니다.

false인 경우 양식의 구성 요소에 지정된 숫자 값 또는 날짜는 최대 속성에 지정된 숫자 값 또는 날짜보다 작거나 같아야 합니다.

숫자 상자
숫자 스텝퍼
날짜 선택기

exclusiveMinimum

부울

true인 경우 양식의 구성 요소에 지정된 숫자 값 또는 날짜는 최소 속성에 지정된 숫자 값 또는 날짜보다 커야 합니다.

false인 경우 양식의 구성 요소에 지정된 숫자 값 또는 날짜는 최소 속성에 지정된 숫자 값 또는 날짜보다 크거나 같아야 합니다.

숫자 상자
숫자 스텝퍼
날짜 선택기

minLength

문자열

구성 요소에 허용되는 최소 문자 수를 지정합니다. 최소 길이는 0보다 크거나 같아야 합니다.

텍스트 상자

maxLength

문자열

구성 요소에 허용되는 최대 문자 수를 지정합니다. 최대 길이는 0보다 크거나 같아야 합니다.

텍스트 상자

pattern

문자열

문자 시퀀스를 지정합니다. 문자가 지정된 패턴을 따르는 경우 구성 요소가 문자를 허용합니다.

패턴 속성은 해당 적응형 양식 구성 요소의 유효성 검사 패턴에 매핑됩니다.

XSD 스키마에 매핑된 모든 적응형 양식 구성 요소

maxItems

문자열

배열의 최대 항목 수를 지정합니다. 최대 항목은 0보다 크거나 같아야 합니다.

minItems

문자열

배열의 최소 항목 수를 지정합니다. 최소 항목은 0보다 크거나 같아야 합니다.

스키마 호환 데이터 활성화 enablig-schema-compliant-data

양식 제출 시 모든 JSON 스키마 기반 적응형 Forms이 스키마 호환 데이터를 생성할 수 있도록 하려면 다음 단계를 따르십시오.

https://server:host/system/console/configMgr의 Experience Manager 웹 콘솔로 이동합니다.
적응형 양식 및 대화형 통신 웹 채널 구성 을 찾습니다.
을(를) 선택하여 편집 모드로 구성을 엽니다.
스키마 호환 데이터 생성 확인란을 선택하십시오.
설정을 저장합니다.

적응형 양식 및 대화형 통신 웹 채널 구성

지원되지 않는 구문 non-supported-constructs

적응형 양식은 다음 JSON 스키마 구문을 지원하지 않습니다.

Null 유형
및 와 같은 유니온 유형
OneOf, AnyOf, AllOf 및 NOT
Homogeneous 배열만 지원됩니다. 따라서 항목 제약 조건은 배열이 아닌 개체여야 합니다.

자주 묻는 질문 frequently-asked-questions

반복 가능한 하위 양식(minOccours 또는 maxOccurs 값이 1보다 큼)에 대해 하위 양식(복합 유형에서 생성된 구조)의 개별 요소를 드래그할 수 없는 이유는 무엇입니까?

반복 가능한 하위 양식에서는 전체 하위 양식을 사용해야 합니다. 선택 필드만 사용하려는 경우 전체 구조를 사용하고 원하지 않는 구조는 삭제하십시오.

콘텐츠 파인더에 긴 복잡한 구조가 있습니다. 특정 요소를 찾으려면 어떻게 해야 합니까?

다음 두 가지 옵션이 있습니다.

트리 구조를 스크롤합니다.
검색 상자를 사용하여 요소 찾기

JSON 스키마 파일의 확장명은 무엇입니까?

JSON 스키마 파일의 확장명은 .schema.json이어야 합니다. 예: <filename>.schema.json.

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2