[AEM Forms]{class="badge positive" title="AEM Forms에 적용됩니다)."}
동일한 적응형 양식에 대한 환경별 REST 끝점 구성
적응형 양식을 개발에서 스테이징으로 승격할 때 양식은 일반적으로 각 환경의 다른 REST 끝점에 제출해야 하지만 양식 자체는 동일합니다. 양식의 제출 작업에서 끝점 URL을 하드코딩하면 동일한 URL이 양식과 함께 모든 환경으로 이동하므로 이것이 중단됩니다.
이 문서에서는 하나의 휴대용 적응형 양식을 유지하고 해당 REST 끝점에 제출 작업이 각 환경에서 올바른 끝점으로 확인되도록 하는 방법에 대해 설명합니다. 양식이 URL이 아닌 이름을(를) 사용하여 REST 구성을 참조하며, 각 환경은 해당 구성에 대해 고유한 값을 제공합니다.
사전 요구 사항 prerequisites
- 핵심 구성 요소를 기반으로 하는 적응형 양식입니다.
- 클라우드 구성이 활성화된 구성 브라우저(도구 > 일반 > 구성 브라우저)를 통해 구성 컨테이너를 만들었습니다.
- 도구 > 클라우드 서비스 및 프로모션을 위해 각 환경(또는 Cloud Manager 배포 파이프라인)에서 패키지 관리자에 액세스할 수 있는 권한입니다.
스테이징에서 RESTful 서비스 구성 만들기 create-rest-configuration
스테이징 작성자 인스턴스에서 폼이 참조하는 명명된 구성을 만듭니다. 서비스 끝점 URL을(를) 스테이징용 REST 또는 웹후크 끝점으로 설정합니다.
-
도구 > 클라우드 서비스 > 데이터 소스로 이동합니다.
-
구성 컨테이너를 선택한 다음 만들기를 선택합니다.
-
일반 탭에서 구성에 대한 이름을(를) 입력하십시오(예:
restTest). 승격 후 양식이 일관되게 확인되도록 모든 환경에서 동일한 이름을 사용하십시오. -
인증 설정 탭에서 다음을 구성하십시오.
- RESTful 서비스 선택: 서비스 끝점.
- 메서드 형식: POST.
- 서비스 끝점 URL: 스테이징 끝점 URL(예: 스테이징에서 제출을 테스트하는 데 사용하는 웹후크 URL).
- 콘텐츠 형식: 예: 다중 파트 양식 데이터.
- 인증 유형: 끝점에 필요한 경우(예: 없음 또는 기본 인증).
-
저장 후 닫기를 선택합니다.
구성 컨테이너에서 적응형 양식 지정 set-configuration-container
스테이징에서 양식을 REST 구성을 포함하는 구성 컨테이너와 연결합니다.
-
Forms 및 문서에서 적응형 양식을 선택하고 속성을 엽니다.
-
기본 탭에서 구성 컨테이너를 RESTful 서비스 구성을 포함하는 컨테이너로 설정합니다(예:
/conf/restConfigTest). -
저장 후 닫기를 선택합니다.
REST에 제출 엔드포인트 작업 구성 configure-submit-action
스테이징에서 하드 코딩된 URL 대신 명명된 REST 구성을 통해 제출하도록 양식을 구성합니다. 전체 제출 동작 참조에 대해서는 REST 끝점에 대한 적응형 양식 제출 동작 구성을 참조하십시오.
-
편집할 적응형 양식을 열고 안내서 컨테이너 구성 요소를 선택한 다음 해당 적응형 양식 컨테이너 속성을 엽니다.
-
제출 탭을 열고 제출 동작 드롭다운 목록에서 REST 끝점에 제출을 선택합니다.
-
작업 구성에서 POST 요청 활성화를 선택합니다.
-
옵션 선택에 대해 URL이 아닌 구성을 선택하세요.
-
목록에서 이름이 지정된 구성(예:
restTest)을 선택합니다. -
완료를 선택합니다.
이제 양식은 고정 URL이 아닌 명명된 구성을 통해 제출 끝점을 확인합니다.
스테이징에서 프로덕션으로 양식 승격 promote-across-environments
스테이징에서 구성 및 테스트한 후 동일한 양식 및 구성 컨테이너를 프로덕션으로 이동합니다. 다음 접근 방식 중 하나를 사용할 수 있습니다.
옵션 1: 작성자 및 패키지 접근 방식 option-package
작성자가 각 환경에서 직접 양식 및 구성을 유지 관리할 때 사용합니다.
-
스테이징 작성자 인스턴스에서 양식 및 해당 구성 컨테이너를 포함하는 콘텐츠 패키지를 패키지 관리자에 빌드합니다. 예:
/content/dam/formsanddocuments/<your-form-path>/content/forms/af/<your-form-path>/conf/<your-config-container>(.../settings/cloudconfigs/fdm/<your-config>포함)
-
패키지를 다운로드하여 프로덕션 작성자 인스턴스에 설치합니다.
옵션 2: 컨텍스트 인식 재정의 접근 방식(자동화에 권장) option-context-aware
배포 후 수동으로 편집하지 않고 엔드포인트, 사용자 이름 및 암호를 환경별로 자동으로 해결하는 패키지화된 구성을 한 개 원할 때 사용합니다. 이 접근 방식은 Cloud Manager 환경 변수를 사용하여 구성 속성을 재정의합니다.
REST 구성의 경우 일반적으로 serviceEndPoint, userName 및 password 속성에 대한 환경 변수를 만든 다음 프로젝트의 OsgiConfigurationOverrideProvider 구성 파일에서 이를 참조합니다.
전체 절차는 컨텍스트 인식 클라우드 구성을 참조하십시오.
프로덕션에서 엔드포인트 URL 업데이트 configure-endpoint-on-production
프로덕션에 패키지를 설치한 후 적응형 양식과 REST 구성 name(예: restTest)이(가) 스테이징과 일치합니다. 해당 구성의 서비스 끝점 URL은(는) 여전히 패키지의 스테이징 끝점을 가리킵니다. 프로덕션에서 구성을 열고 프로덕션 끝점 URL로 대체합니다.
-
프로덕션 작성자 인스턴스에서 도구 > 클라우드 서비스 > 데이터 소스(으)로 이동합니다.
-
배포한 구성 컨테이너(예:
restConfigTest)를 선택한 다음 명명된 구성(예:restTest)을 엽니다. -
인증 설정 탭에서 서비스 끝점 URL을 프로덕션 REST 또는 웹후크 끝점으로 설정합니다.
-
저장 후 닫기를 선택합니다.
테스트 중에 Webhook 캡처 서비스와 같은 요청 검사기는 각 제출을 받는 끝점을 확인할 수 있도록 환경당 고유한 URL을 제공합니다.
라우팅 확인 verify
스테이징 및 프로덕션에서 동일한 양식을 제출하고 각 환경이 다른 환경의 URL이 아닌 자체 끝점에 게시되는지 확인하십시오.
-
스테이징 작성자 인스턴스에서 적응형 양식을 열고 테스트 데이터와 함께 제출합니다(예: 텍스트 필드에
stagetest을(를) 입력). POST 요청이 스테이징에서 구성한 스테이징 서비스 끝점 URL에 도착하는지 확인합니다. -
프로덕션 작성자 인스턴스에서 동일한 적응형 양식을 열고 테스트 데이터와 함께 제출합니다(예: 텍스트 필드에
prodtest을(를) 입력). POST 요청이 스테이징 URL이 아닌 프로덕션에 구성한 프로덕션 서비스 끝점 URL에 도착하는지 확인합니다. -
각 요청이 필요한 콘텐츠 형식(예: 여러 부분으로 구성된 양식 데이터)을 사용하고 제출된 양식 데이터를 포함하는지 확인하십시오. 프로덕션에 안전한 실제 끝점(HTTPS)을 사용합니다.
모범 사례 best-practices
- 승격 후 양식이 일관되게 확인되도록 모든 환경에서 동일한 구성 name을(를) 사용하십시오.
- 엔드포인트 값을(를) 환경별로 유지합니다. 단일 환경의 URL을 양식의 제출 작업에 하드코딩하지 마십시오.
- 프로덕션 끝점의 경우 URL이 안전한지(HTTPS) 확인하고 수신 경로가 인증 모델에 맞게 POST 요청을 처리하도록 구성되어 있는지 확인합니다.
- 배포를 반복할 수 있고 수동 배포 후 편집 내용이 없게 하려면 컨텍스트 인식 무시 접근 방식을 선호합니다.