AEM Forms as a Cloud Service 통신 일괄 처리

커뮤니케이션을 사용하면 비즈니스 서신, 문서, 명세서, 청구 처리 편지, 혜택 공지, 월별 청구서 및 시작 키트와 같은 브랜드 지향적이고 개인화된 커뮤니케이션을 만들고, 조합하고, 제공할 수 있습니다. 커뮤니케이션 API를 사용하여 템플릿(XFA 또는 PDF)을 고객 데이터와 결합하여 PDF, PS, PCL, DPL, IPL 및 ZPL 형식의 문서를 생성할 수 있습니다.

통신은 온디맨드 및 예약된 문서 생성을 위한 API를 제공합니다. 온디맨드 API에는 동기 API를, 예약된 문서 생성에는 배치 API(비동기 API)를 사용할 수 있습니다.

일괄 처리 작업 batch-operations

배치 작업은 예약된 간격으로 레코드 세트에 대해 유사한 유형의 여러 문서를 생성하는 프로세스입니다. 배치 작업에는 구성(정의)과 실행의 두 부분이 있습니다.

배치 작업의 구성 요소 components-of-a-batch-operations

클라우드 구성: Experience Manger 클라우드 구성을 통해 Experience Manager 인스턴스를 고객 소유 Microsoft Azure 스토리지에 연결할 수 있습니다. 고객이 소유한 Microsoft Azure 계정에 연결할 자격 증명을 지정할 수 있습니다.

USC(일괄 처리 데이터 저장소 구성): 일괄 처리 데이터 구성은 일괄 처리 API에 대한 Blob 저장소의 특정 인스턴스를 구성하는 데 도움이 됩니다. 고객이 소유한 Microsoft Azure Blob 저장소에서 입력 및 출력 위치를 지정할 수 있습니다.

일괄 처리 API: 일괄 처리 구성을 만들고 이러한 구성을 기반으로 일괄 처리 실행을 실행하여 PDF 또는 XDP 템플릿을 데이터와 병합하고 PDF, PS, PCL, DPL, IPL 및 ZPL 형식의 출력을 생성할 수 있습니다. 통신은 구성 관리 및 배치 실행을 위한 배치 API를 제공합니다.

저장소: 통신 API는 고객이 소유한 Microsoft Azure 클라우드 저장소를 사용하여 고객 레코드를 가져오고 생성된 문서를 저장합니다. Experience Manager Cloud Service 구성에서 Microsoft Azure 스토리지를 구성합니다.

앱: 일괄 처리 API를 사용하여 문서를 생성하고 사용하는 사용자 지정 응용 프로그램입니다.

일괄 처리 작업을 사용하여 여러 문서 생성 generate-multiple-documents-using-batch-operations

배치 작업을 사용하여 예약된 간격으로 여러 문서를 생성할 수 있습니다.

비디오를 보거나 아래 지침을 수행하여 일괄 작업을 사용하여 문서를 생성하는 방법을 배울 수 있습니다. 비디오에 사용되는 API 참조 설명서는 .yaml 형식으로 제공됩니다. 일괄 처리 API 파일을 다운로드하고 Postman에 업로드하여 API의 기능을 확인하고 비디오를 따라 이동할 수 있습니다.

전제 조건 pre-requisites

배치 API를 사용하려면 다음 조건을 충족해야 합니다.

환경 설정 setup-your-environment

배치 작업을 사용하기 전에:

고객 데이터(XML 파일)를 Azure Storage에 업로드 upload-customer-data-to-Azure-Storage

Microsoft Azure 저장소에서 컨테이너를 만들고 컨테이너 내의 폴더에 고객 데이터(XML)를 업로드합니다.

클라우드 구성 만들기 create-a-cloud-configuration

클라우드 구성은 Experience Manager 인스턴스를 Microsoft Azure Storage에 연결합니다. 클라우드 구성을 만들려면 다음 작업을 수행하십시오.

이제 Experience Manager 인스턴스를 Microsoft Azure Storage에 연결하고 필요한 경우 이 인스턴스를 사용하여 콘텐츠를 저장하고 읽을 수 있습니다.

일괄 처리 데이터 저장소 구성 만들기 create-batch-data-store-configuration

배치 데이터 구성은 입력 및 출력을 위한 컨테이너 및 폴더를 구성하는 데 도움이 됩니다. 고객 레코드를 Source 폴더에 보관하고 생성된 문서는 대상 폴더에 배치합니다.

구성을 만들려면 다음 작업을 수행하십시오.

이제 Experience Manager 인스턴스가 Microsoft Azure Storage에 연결되고 데이터를 검색하여 Microsoft Azure Storage의 특정 위치로 보내도록 구성되었습니다.

Experience Manager 인스턴스에 템플릿 및 기타 에셋 업로드 upload-templates-and-other-assets-to-your-AEM-instance

조직에는 일반적으로 여러 템플릿이 있습니다. 예를 들어 신용 카드 명세서, 복리후생 명세서 및 청구 신청에 대해 각각 하나의 템플리트가 있습니다. 이러한 모든 XDP 및 PDF 템플릿을 Experience Manager 인스턴스에 업로드합니다. 템플릿을 업로드하려면 다음 작업을 수행하십시오.

일괄 처리 API를 사용하여 문서 생성 use-batch-API-to-generate-documents

일괄 처리 API를 사용하려면 일괄 처리 구성을 만들고 해당 구성을 기반으로 실행을 실행합니다. API 설명서는 일괄 처리를 만들고 실행하기 위한 API, 해당 매개 변수 및 가능한 오류에 대한 정보를 제공합니다. API 정의 파일 파일을 다운로드하고 Postman 또는 유사한 소프트웨어에 업로드하여 API를 테스트하여 일괄 처리 작업을 만들고 실행할 수 있습니다.

일괄 처리 만들기 create-a-batch

일괄 처리를 만들려면 POST /config API를 사용하십시오. HTTP 요청 본문에 다음 필수 속성을 포함합니다.

상대 경로를 지정하는 경우 컨텐츠 루트도 제공합니다. 콘텐츠 루트에 대한 자세한 내용은 API 설명서 를 참조하십시오.

GET /config /[configName]을(를) 사용하여 일괄 처리 구성에 대한 세부 정보를 볼 수 있습니다.

일괄 처리 실행 run-a-batch

일괄 처리를 실행(실행)하려면 POST /config /[configName]/execution을(를) 사용합니다. 예를 들어 wknd-demo라는 배치를 실행하려면 /config/wknd-demo/execution을 사용합니다. 서버는 요청을 수락하면 HTTP 응답 코드 202를 반환합니다. API는 서버에서 실행 중인 일괄 처리 작업에 대한 HTTP 응답 헤더의 고유 코드(실행 식별자)를 제외하고 페이로드를 반환하지 않습니다. 실행 식별자를 사용하여 배치의 상태를 검색할 수 있습니다.

배치 상태 확인 status-of-a-batch

일괄 처리 상태를 검색하려면 GET /config /[configName]/execution/[execution-identifier]을(를) 사용하십시오. 실행 식별자는 일괄 실행 요청에 대한 HTTP 응답의 헤더에 포함됩니다.

상태 요청의 응답에는 상태 섹션이 포함됩니다. 배치 작업의 상태, 파이프라인에 이미 있는 레코드 수(이미 읽고 처리 중) 및 각 outputType/renderType(진행 중, 성공 및 실패한 항목 수)의 상태에 대한 세부 정보를 제공합니다. 상태에는 오류에 대한 정보와 함께 배치 작업의 시작 및 종료 시간(있는 경우)도 포함됩니다. 배치 실행이 실제로 완료될 때까지 종료 시간은 -1입니다.

생성된 문서 보기 view-generated-documents

작업이 완료되면 생성된 문서가 일괄 처리 데이터 저장소 구성에 지정된 대상 위치의 success 폴더에 저장됩니다. 오류가 있으면 서비스에서 failure 폴더를 만듭니다. 오류 유형 및 원인에 대한 정보를 제공합니다.

예를 통해 입력 데이터 파일 record1.xml과(와) 두 개의 출력 형식 PDF 및 PCL이(가) 있다고 가정해 보겠습니다. 그러면 대상 위치에 각 출력 형식에 대해 하나씩 두 개의 하위 폴더 pdf 및 pcl이(가) 포함됩니다. PDF 생성이 성공했다고 가정해 보겠습니다. 그러면 pdf 하위 폴더에 success 하위 폴더가 포함되고, 이 하위 폴더에는 실제로 생성된 PDF 문서 record1.pdf이(가) 포함됩니다. PCL을 생성하지 못한 경우 pcl 하위 폴더에 failure 하위 폴더가 포함되고, 이 하위 폴더에는 오류 세부 정보가 포함된 오류 파일 record1.error.txt이(가) 포함됩니다. 또한 대상 위치에는 일괄 처리 실행 중에 필요한 특정 파일이 들어 있는 __tmp__(이)라는 임시 폴더가 있습니다. 대상 폴더를 참조하는 활성 배치 실행이 없는 경우 이 폴더를 삭제할 수 있습니다.

API 참조 설명서

API 참조 설명서는 API에서 제공하는 모든 매개 변수, 인증 방법 및 다양한 서비스에 대한 자세한 정보를 제공합니다. API 참조 설명서는 .yaml 형식으로 사용할 수 있습니다. 일괄 처리 API 파일을 다운로드하고 Postman에 업로드하여 API의 기능을 확인할 수 있습니다.