AEM Forms은 양식 제출, 문서 처리 및 문서 렌더링에 필요한 여러 API를 제공합니다. 일부 API는 거래로 계산되며 다른 API는 무료로 사용할 수 있습니다. 이 문서에서는 트랜잭션 보고서에서 거래로 간주되는 모든 API의 목록을 제공합니다. 청구 가능한 API가 사용되는 몇 가지 일반적인 시나리오는 다음과 같습니다.
청구 API는 렌더링된 문서의 페이지 수, 문서 또는 양식의 길이 또는 최종 형식을 고려하지 않습니다. 거래 보고서는 트랜잭션을 두 범주로 나눕니다.렌더링된 문서 및 Forms 제출됨.
Forms 제출됨: AEM Forms으로 만든 모든 유형의 양식에서 데이터를 제출하고 데이터가 데이터 저장소 또는 데이터베이스에 제출되면 양식 제출으로 간주됩니다. 예를 들어 적응형 양식, HTML5 양식, PDF forms 및 양식 세트를 제출하는 것은 양식을 제출한 것으로 간주합니다. 양식 세트의 각 양식은 제출물로 간주됩니다. 예를 들어, 양식 세트에 5개의 양식이 있는 경우, 양식 세트를 제출하면 트랜잭션 보고 서비스는 양식 제출을 5개로 계산합니다.
렌더링된 문서: 템플릿 및 데이터를 결합하거나, 문서에 디지털 서명 또는 인증을 하거나, 문서 서비스에 대해 청구 가능한 문서 서비스 API를 사용하거나, 한 형식에서 다른 형식으로 문서를 변환하는 것은 문서로 렌더링됩니다.
거래 보고서 UI에는 3가지 카테고리가 표시됩니다.Forms 전송, 문서 렌더링 및 처리된 문서. 렌더링된 문서와 처리된 문서 모두 렌더링된 문서로 간주됩니다.
API |
설명 | 거래 보고서 범주 | 추가 정보 |
createPDF | 지원되는 파일 형식에서 Adobe PDF을 만듭니다. | 처리된 문서 | |
createPDF2 | 지원되는 파일 형식에서 Adobe PDF을 만듭니다. | 처리된 문서 | |
exportPDF | Adobe PDF을 지원되는 파일 유형으로 변환합니다. | 처리된 문서 |
|
exportPDF2 | Adobe PDF을 지원되는 파일 유형으로 변환합니다. | 처리된 문서 |
|
exportPDF3 | Adobe PDF을 지원되는 파일 유형으로 변환합니다. | 처리된 문서 |
|
htmlFileToPdf | HTML 페이지에서 PDF를 만듭니다. |
처리된 문서 |
|
htmlToPdf | HTML 페이지를 가리키는 URL에서 PDF를 만듭니다. | 처리된 문서 |
|
htmlToPdf2 | HTML 페이지를 가리키는 URL에서 PDF를 만듭니다. | 처리된 문서 |
|
optimizePDF | 품질에 영향을 주지 않고 불필요한 메타데이터를 제거함으로써 파일 크기를 줄이기 위해 PDF를 최적화합니다. | 처리된 문서 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
createPDF |
지원되는 파일 형식에서 Adobe PDF을 만듭니다. | 처리된 문서 | |
createPDF2 | 지원되는 파일 형식에서 Adobe PDF을 만듭니다. | 처리된 문서 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
render | 제공된 매개 변수를 사용하여 레코드 문서를 생성하기 위해 지정된 렌더링 방법을 호출합니다. | 처리된 문서 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
generatePDFOutput | 데이터와 템플릿을 병합하여 PDF 문서를 만듭니다. | 처리된 문서 | |
generatePDFOutput | 데이터와 템플릿을 병합하여 PDF 문서를 만듭니다. | 처리된 문서 | |
generatePDFOutputBatch | 데이터와 템플릿을 병합하여 일련의 PDF 문서를 만듭니다. | 처리된 문서 | generatePDFOutputBatch API는 양식 템플릿을 레코드와 결합하고 PDF를 생성합니다. 일괄 레코드를 처리할 때 트랜잭션 보고 서비스는 각 레코드를 별도의 PDF 변환으로 계산합니다. getGenerateManyFilesflag를 사용하여 여러 변환을 하나의 PDF 파일로 결합할 수 있습니다. 플래그 상태와 관계없이 서비스는 각 레코드를 개별 PDF 변환으로 계산합니다. |
generatePrintedOutput | XDP 및 PDF 문서를 PS(PostScript), PCL(프린터 명령 언어) 및 ZPL 파일 형식으로 변환합니다. | 처리된 문서 | |
generatePrintedOutput | XDP 및 PDF 문서를 PS(PostScript), PCL(프린터 명령 언어) 및 ZPL 파일 형식으로 변환합니다. | 처리된 문서 | |
generatePrintedOutputBatch | XDP 및 PDF 문서 집합을 PS(PostScript), PCL(프린터 명령 언어) 및 ZPL 파일 형식 세트로 변환합니다. | 처리된 문서 | generatePDFOutputBatch API는 양식 템플릿을 레코드와 결합하고 PDF를 생성합니다. 일괄 레코드를 처리할 때 트랜잭션 보고 서비스는 각 레코드를 별도의 PDF 변환으로 계산합니다. getGenerateManyFilesflag를 사용하여 여러 변환을 하나의 PDF 파일로 결합할 수 있습니다. 플래그 상태와 관계없이 서비스는 각 레코드를 개별 PDF 변환으로 계산합니다. |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
renderPDForm | XDP 템플릿에서 PDF 양식을 렌더링합니다. XP 템플릿은 Forms Designer에서 만듭니다. | 처리된 문서 | |
exportData | PDF 양식 또는 XDP 템플릿에서 데이터 추출 | 처리된 문서 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
toImage | PDF 문서를 이미지 문서 목록으로 변환합니다. 지원되는 이미지 형식은 JPEG, JPEG2K, PNG 및 TIFF입니다. | 처리된 문서 | |
toPS | 옵션 사양에 지정된 옵션을 사용하여 플랫 PDF 파일을 PostScript 형식으로 변환합니다. | 처리된 문서 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
decode | Document 객체의 모든 바코드를 디코딩하고 바코드에서 검색한 데이터를 포함하는 org.w3c.dom.Document 객체를 반환합니다. | 처리된 문서 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
invoke | 지정된 DCX 문서를 실행하고 결과 문서가 포함된 AssemblerResult 개체를 반환합니다. | 처리된 문서 | 다음 작업은 트랜잭션으로 계산되지 않습니다.
|
invoke | 지정된 DCX 문서를 실행하고 결과 문서가 포함된 AssemblerResult 개체를 반환합니다. | 처리된 문서 | PDF Generator, Forms 및 출력 서비스에서 지원하는 모든 입력 파일 포맷, Assembler 서비스는 출력 파일 포맷으로 이러한 모든 포맷을 지원합니다. |
toPDFA | 지정된 옵션을 사용하여 지정된 문서를 PDF/A로 변환합니다. | 처리된 문서 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
convertPDFtoXDP | PDF 문서를 XDP 파일로 변환합니다. PDF 문서를 XDP 파일로 성공적으로 변환하려면 PDF 문서에 AcroForm 사전의 XFA 스트림이 포함되어야 합니다. | 처리된 문서 |
적응형 양식, HTML5 Forms 및 양식 세트의 모든 제출 이벤트는 트랜잭션으로 간주됩니다. 기본적으로 PDF 양식 제출은 거래로 간주되지 않습니다. 제공된 거래 레코더 API를 사용하여 PDF forms 제출을 트랜잭션으로 기록합니다.
사용 사례 |
설명 | 거래 보고서 범주 | 추가 정보 |
적응형 양식 제출 | 구성된 제출 작업을 위해 적응형 양식을 제출합니다. | 제출된 양식 |
|
사용 사례 |
설명 | 거래 보고서 범주 | 추가 정보 |
HTML5 양식 제출 | 양식에 구성된 URL을 제출하기 위해 HTML5 양식을 제출합니다. | 제출된 양식 |
API |
설명 | 거래 보고서 범주 | 추가 정보 |
양식 세트 제출 | 양식 세트에 구성된 제출 URL에 설정된 양식을 제출합니다. | 제출된 양식 |
|
OSGi에서 양식 중심의 AEM 워크플로우의 작업 및 문서 서비스 단계를 지정하고 인터랙티브한 커뮤니케이션의 모든 변환을 지정하며 거래로 간주합니다. 작성자 인스턴스에서 대화형 통신을 미리 보고 에이전트 UI를 사용하여 게시 인스턴스에서 미리 보는 것은 트랜잭션으로 간주되지 않습니다. 워크플로우 단계가 트랜잭션을 계산하고 워크플로우가 완료되지 않으면 트랜잭션 수가 취소되지 않습니다.
API |
설명 | 거래 보고서 범주 | 추가 정보 |
웹 채널 렌더링 | 대화형 커뮤니케이션의 웹 버전을 엽니다. | 렌더링된 문서 |
|
API |
설명 | 거래 보고서 범주 | 추가 정보 |
render (PDF로 변환) | PDF 버전의 대화형 통신을 생성합니다. | 렌더링된 문서 |
|
사용 사례 |
거래 보고서 범주 | 추가 정보 |
작업 지정 단계 제출 | 제출된 양식 |
|
워크플로우 애플리케이션 시작 지점 제출 | 제출된 양식 | |
에이전트 UI에서 워크플로우로 대화형 통신(인쇄 채널) 제출 | 렌더링된 문서 |
PDF 양식 제출, 에이전트 UI를 사용하여 대화형 통신을 미리 보는 것과 같은 작업, 비표준 양식 제출 사용 및 사용자 정의 구현은 거래로 간주되지 않습니다. AEM Forms은 거래와 같은 작업을 기록할 수 있는 API를 제공합니다. 사용자 지정 구현에서 API를 거래에 기록할 수 있습니다.