컨텐츠 조각 사용자 지정 및 확장

주의

일부 컨텐츠 조각 기능을 사용하려면 AEM 6.4 서비스 팩 2 (6.4.2.0)를 적용해야 합니다.

컨텐츠 조각은 표준 자산을 확장합니다.참조:

아키텍처

컨텐츠 조각의 기본 구성 부분은 다음과 같습니다.

  • 컨텐츠 조각,
  • 하나 이상의 컨텐트 요소 s,
  • 하나 이상의 컨텐트 변형​을 가질 수 있습니다.

조각 유형에 따라 모델이나 템플릿도 사용됩니다.

주의

이제 컨텐츠 조각 모델이 모든 조각을 만드는 데 권장됩니다.

컨텐츠 조각 모델은 We.Retail의 모든 예에 사용됩니다.

  • 컨텐츠 조각 모델:

    • 구조화된 컨텐츠를 포함하는 컨텐츠 조각을 정의하는 데 사용됩니다.
    • 컨텐츠 조각 모델은 컨텐츠 조각을 만들 때 해당 구조를 정의합니다.
    • 조각이 모델을 참조합니다.따라서 모델에 대한 변경 사항은 종속 조각에 영향을 줄 수/미칠 수 있습니다.
    • 모델은 데이터 유형이 내장되어 있습니다.
    • 새 변형 등을 추가하는 함수는 그에 따라 조각을 업데이트해야 합니다.
    주의

    기존 컨텐츠 조각 모델에 대한 모든 변경 사항은 종속 조각에 영향을 줄 수 있습니다.이렇게 하면 해당 조각에 고아 속성이 생길 수 있습니다.

  • 컨텐츠 조각 템플릿:

    • 간단한 컨텐츠 조각을 정의하는 데 사용됩니다.
    • 템플릿은 컨텐츠 조각을 만들 때 컨텐츠 조각의 (기본, 텍스트 전용) 구조를 정의합니다.
    • 템플릿이 작성되면 조각의 형태로 복사됩니다.따라서 템플릿에 대한 추가 변경 사항은 기존 조각에 반영되지 않습니다.
    • 새 변형 등을 추가하는 함수는 그에 따라 조각을 업데이트해야 합니다.
    • 컨텐츠 조각 템플릿은 AEM 에코시스템(예: 페이지 템플릿 등) 내의 다른 템플릿 메커니즘과 다른 방식으로 작동합니다. 그러므로 그것들은 따로 고려되어야 한다.
    • 템플릿을 기반으로 하면 콘텐츠의 MIME 유형이 실제 컨텐츠에서 관리됩니다.즉, 각 요소 및 변형에는 다른 MIME 유형이 있을 수 있습니다.

자산과 통합

CFM(Content Fragment Management)은 다음과 같은 AEM Assets의 일부입니다.

  • 컨텐츠 조각은 자산입니다.
  • 기존 자산 기능을 사용합니다.
  • 자산(관리 콘솔 등)과 완전히 통합됩니다.

구조화된 컨텐츠 조각을 자산에 매핑

단편-자산-구조

구조화된 컨텐츠가 있는 컨텐츠 조각(즉, 컨텐츠 조각 모델을 기반으로 함)은 단일 자산에 매핑됩니다.

  • 모든 콘텐츠는 자산의 jcr:content/data 노드 아래에 저장됩니다.

    • 요소 데이터는 마스터 하위 노드 아래에 저장됩니다.

      jcr:content/data/master

    • 변형은 변형의 이름을 가진 하위 노드 아래에 저장됩니다.

      예:jcr:content/data/myvariation

    • 각 요소의 데이터는 요소 이름을 가진 속성으로 각 하위 노드에 저장됩니다.

      예: text 요소의 컨텐츠가 jcr:content/data/master의 속성 text으로 저장됩니다.

  • 메타데이터 및 관련 콘텐트가 jcr:content/metadata 아래에 저장됩니다.

    일반 메타데이터로 간주되지 않고 jcr:content에 저장되는 제목 및 설명을 제외하고

단순 컨텐츠 조각을 자산에 매핑

chlimage_1-253

템플릿을 기반으로 하는 단순 컨텐츠 조각은 기본 자산 및 (선택 사항) 하위 자산으로 구성된 합성에 매핑됩니다.

  • 조각(예: 제목, 설명, 메타데이터, 구조)의 모든 비컨텐츠 정보는 기본 자산에서만 관리됩니다.

  • 조각의 첫 번째 요소의 컨텐츠는 기본 자산의 원래 표현물에 매핑됩니다.

    • 첫 번째 요소의 변형(있는 경우)은 기본 자산의 다른 변환에 매핑됩니다.
  • 추가 요소(있는 경우)는 기본 자산의 하위 자산에 매핑됩니다.

    • 이러한 추가 요소의 주요 내용은 해당 하위 자산의 원본 변환에 매핑됩니다.
    • 추가 요소의 다른 변형(해당하는 경우)은 해당 하위 자산의 다른 변환에 매핑됩니다.

자산 위치

표준 자산과 마찬가지로 컨텐츠 조각은 다음 아래에서 보관됩니다.

  • /content/dam

자산 권한

자세한 내용은 컨텐츠 조각 - 고려 사항 삭제를 참조하십시오.

기능 통합

  • CFM(컨텐츠 조각 관리) 기능은 자산 코어를 기반으로 구축되지만 가능한 한 독립적인 것이어야 합니다.
  • CFM은 카드/열/목록 보기의 항목에 대한 자체 구현을 제공합니다.이러한 플러그인을 기존 자산 컨텐츠 렌더링 구현에 연결합니다.
  • 여러 자산 구성 요소가 컨텐츠 조각에 맞게 확장되었습니다.

페이지에서 컨텐츠 조각 사용

주의

이제 컨텐츠 조각 핵심 구성 요소가 권장됩니다. 자세한 내용은 핵심 구성 요소 개발을 참조하십시오.

컨텐츠 조각은 다른 자산 유형과 마찬가지로 AEM 페이지에서 참조할 수 있습니다. AEM은 컨텐츠 조각 핵심 구성 요소 - 페이지🔗에 컨텐츠 조각을 포함할 수 있는 구성 요소를 제공합니다. 이 컨텐츠 조각 핵심 구성 요소를 확장할 수도 있습니다.

  • 구성 요소는 fragmentPath 속성을 사용하여 실제 컨텐츠 조각을 참조합니다. fragmentPath 속성은 다른 자산 유형의 속성과 유사한 방식으로 처리됩니다.예를 들어 컨텐츠 조각을 다른 위치로 이동할 때

  • 구성 요소를 사용하면 표시할 변형을 선택할 수 있습니다.

  • 또한 여러 단락을 선택하여 출력을 제한할 수 있습니다.예를 들어 다중 열 출력에 사용할 수 있습니다.

  • 구성 요소는 중간 컨텐츠을 허용합니다.

    • 여기에서 구성 요소를 사용하여 다른 자산(이미지 등)을 배치할 수 있습니다. 를 참조하십시오.
      • 중간 컨텐츠의 경우 다음을 수행해야 합니다.

        • 불투명한 참조 가능성을 인식하다.중간 컨텐츠(페이지를 작성할 때 추가됨)는 옆에 배치된 단락에 대해 고정된 관계가 없습니다. 중간 컨텐츠의 위치가 상대 위치를 잃기 전에 새 단락(컨텐츠 조각 편집기에서)을 삽입하십시오
          • 검색 결과에서 잘못된 위치(예: 변형 및 단락 필터)를 방지하려면 추가 매개 변수를 고려하십시오.
노트

컨텐츠 조각 모델:

페이지에서 컨텐츠 조각 모델을 기반으로 한 컨텐츠 조각을 사용할 때 모델이 참조됩니다. 즉, 페이지를 게시할 때 모델이 게시되지 않은 경우 플래그가 지정되고 모델이 페이지와 함께 게시될 리소스에 추가됩니다.

컨텐츠 조각 템플릿:

페이지의 컨텐츠 조각 템플릿을 기반으로 한 컨텐츠 조각을 사용할 때 조각을 생성할 때 템플릿이 복사되었기 때문에 참조가 없습니다.

OSGi 콘솔을 사용한 구성

컨텐츠 조각의 백엔드 구현은 검색 가능한 페이지에 사용된 조각 인스턴스를 만들거나 혼합 미디어 컨텐츠를 관리하는 등의 작업을 수행합니다. 이 구현은 조각을 렌더링하는 데 사용되는 구성 요소와 렌더링이 매개 변수화되는 방법을 알아야 합니다.

이 매개 변수는 OSGi 번들 DAM 컨텐츠 조각 구성​에 대해 웹 콘솔에서 구성할 수 있습니다.

  • 리소스 유형

    sling:resourceTypes 목록을 제공하여 컨텐츠 조각을 렌더링하는 데 사용되는 구성 요소와 백그라운드 처리를 적용할 위치를 정의할 수 있습니다.

  • 참조 속성

    속성 목록을 구성하여 각 구성 요소에 대한 조각의 참조가 저장되는 위치를 지정할 수 있습니다.

노트

속성과 구성 요소 유형 사이에는 직접 매핑이 없습니다.

AEM은 단락에 있는 첫 번째 속성을 가져옵니다. 따라서 속성을 신중하게 선택해야 합니다.

osgi-config

구성 요소가 컨텐츠 조각 백그라운드 처리와 호환되도록 하기 위해 따라야 할 몇 가지 지침은 아직 있습니다.

  • 렌더링할 요소가 정의된 속성의 이름은 element 또는 elementNames이어야 합니다.

  • 렌더링할 변형을 정의하는 속성의 이름은 variation 또는 variationName이어야 합니다.

  • 여러 요소의 출력이 지원되는 경우(elementNames을 사용하여 여러 요소를 지정하면) 실제 표시 모드는 displayMode 속성으로 정의됩니다.

    • 값이 singleText(그리고 구성된 요소가 하나만 있음)이면 요소가 중간 컨텐츠, 레이아웃 지원 등이 있는 텍스트로 렌더링됩니다. 단일 요소만 렌더링되는 단편의 기본값입니다.
    • 그렇지 않으면 훨씬 더 간단한 접근 방법을 사용합니다("양식 보기"라고 함). 여기서 중간 컨텐츠는 지원되지 않으며 조각 컨텐츠는 "있는 그대로" 렌더링됩니다.
  • 조각이 displayMode == singleText(암시적 또는 명시적)에 대해 렌더링되는 경우 다음과 같은 추가 속성이 재생됩니다.

    • paragraphScope 모든 단락을 렌더링할지 또는 단락 범위만 렌더링할지를 정의합니다(값: all vs. range)
    • paragraphScope == range이면 paragraphRange 속성은 렌더링할 단락 범위를 정의합니다.

다른 프레임워크와의 통합

컨텐츠 조각은 다음과 통합할 수 있습니다.

  • 번역

    컨텐츠 조각은 AEM 번역 작업 과정과 완전히 통합됩니다. 이것은 건축적 수준에서 다음을 의미합니다.

    • 컨텐츠 조각의 개별 변환은 실제로 개별 조각입니다.예를 들면 다음과 같습니다.

      • 다른 언어 루트 아래에 있습니다.

        /content/dam/<path>/en/<to>/<fragment>

        vs.

        /content/dam/<path>/de/<to>/<fragment>

      • 그러나 언어 루트 아래에서 정확하게 동일한 상대 경로를 공유합니다.

        /content/dam/<path>/en/<to>/<fragment>

        vs.

        /content/dam/<path>/de/<to>/<fragment>

    • 규칙 기반 경로 외에도 컨텐츠 조각의 서로 다른 언어 버전 간에 더 이상 연결되지 않습니다.언어 변형을 탐색하는 방법을 UI에서 제공하지만 두 개의 개별 조각으로 처리됩니다.

    노트

    AEM 번역 워크플로우는 /content과(와) 연동됩니다.

    • 컨텐츠 조각 모델은 /conf에 있으므로 이러한 변환에 포함되지 않습니다. UI 문자열을(를) 국제화할 수 있습니다.
    • 템플릿이 복제되어 조각을 생성하여 이것이 암묵적으로 표시되도록 합니다.
  • 메타데이터 스키마

  • CFM은 고유한 특정 스키마를 제공합니다.

    /libs/dam/content/schemaeditors/forms/contentfragment

    필요한 경우 확장할 수 있습니다.

  • 각 스키마 양식이 조각 편집기와 통합됩니다.

컨텐츠 조각 관리 API - 서버측

서버측 API를 사용하여 컨텐츠 조각에 액세스할 수 있습니다.참조:

com.adobe.cq.dam.cfm
주의

콘텐츠 구조에 직접 액세스하는 대신 서버측 API를 사용하는 것이 좋습니다.

키 인터페이스

다음 3개의 인터페이스는 시작 지점으로 사용할 수 있습니다.

  • 조각 템플릿

    FragmentTemplate

    새 조각을 만들려면 FragmentTemplate.createFragment()을 사용합니다.

    Resource templateOrModelRsc = resourceResolver.getResource("...");
    FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
    ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");
    

    이 인터페이스는 다음과 같습니다.

    • 컨텐츠 조각을 생성할 컨텐츠 조각 모델 또는 컨텐츠 조각 템플릿 중 하나,
    • 및 (생성된 후) 해당 조각의 구조 정보

    이 정보에는 다음이 포함될 수 있습니다.

    • 기본 데이터 액세스(제목, 설명)

    • 조각 요소에 대한 템플릿/모델에 액세스:

      • 목록 요소 템플릿
      • 특정 요소에 대한 구조 정보 가져오기
      • 요소 템플릿에 액세스( ElementTemplate 참조)
    • 조각 변형에 대한 템플릿에 액세스:

      • 목록 변형 템플릿
      • 주어진 변화에 대한 구조 정보 얻기
      • 변형 템플릿에 액세스( VariationTemplate 참조)
    • 관련된 초기 컨텐츠 가져오기

    중요한 정보를 나타내는 인터페이스:

    • ElementTemplate

      • 기본 데이터 가져오기(이름, 제목)
      • 초기 요소 컨텐츠 가져오기
    • VariationTemplate

      • 기본 데이터 가져오기(이름, 제목, 설명)
  • 콘텐츠 조각

    컨텐츠 조각

    이 인터페이스를 사용하면 추상적인 방식으로 컨텐츠 조각을 사용하여 작업할 수 있습니다.

    주의

    이 인터페이스를 통해 조각에 액세스하는 것이 좋습니다. 컨텐츠 구조를 직접 변경하지 않아야 합니다.

    이 인터페이스는 다음 방법을 제공합니다.

    • 기본 데이터 관리(예: 이름 가져오기;get/set title/description)

    • 메타 데이터 액세스

    • 액세스 요소:

      • 목록 요소
      • 이름으로 요소 가져오기
      • 새 요소 만들기(Caveats 참조)
      • 요소 데이터에 액세스합니다(ContentElement 참조).
    • 조각에 대해 정의된 목록 변형

    • 전역적으로 새로운 변형 만들기

    • 관련 컨텐츠 관리:

      • 목록 컬렉션
      • 컬렉션 추가
      • 컬렉션 제거
    • 조각의 모델 또는 템플릿에 액세스

    조각의 주요 요소를 나타내는 인터페이스는 다음과 같습니다.

    • 콘텐츠 요소

      ContentElement
      • 기본 데이터 가져오기(이름, 제목, 설명)

      • 콘텐츠 가져오기/설정

      • 요소의 변형 액세스:

        • 목록 변형
        • 이름별로 변형 가져오기
        • 새 변형 만들기(Caveats 참조)
        • 변형 제거(Caveze 참조)
        • 변형 데이터 액세스(ContentVariation 참조)
      • 변형을 해결하기 위한 단축키(지정한 변형을 요소에 사용할 수 없는 경우 몇 가지 추가 구현 관련 폴백 논리 적용)

    • 컨텐츠 변형

      ContentVariation
      • 기본 데이터 가져오기(이름, 제목, 설명)
      • 콘텐츠 가져오기/설정
      • 마지막으로 수정한 정보를 기반으로 하는 단순 동기화

    3개의 인터페이스( ContentFragment, ContentElement, ContentVariation)가 모두 Versionable 인터페이스를 확장하여 컨텐츠 조각에 필요한 버전 관리 기능을 추가합니다.

    • 요소의 새 버전 만들기
    • 요소의 버전 목록
    • 버전 관리 요소의 특정 버전의 컨텐츠 가져오기

적응 - adaptTo() 사용

다음을 조정할 수 있습니다.

  • ContentFragment 다음을 적용할 수 있습니다.

    • Resource - 기본 Sling 리소스;기본 객체를 Resource 직접 업데이트하려면 객체를 다시 ContentFragment 구성해야 합니다.
    • Asset - 컨텐츠 조각을 나타내는 DAM Asset 추상화객체를 Asset 직접 업데이트하려면 객체를 다시 ContentFragment 구성해야 합니다.
  • ContentElement 다음을 적용할 수 있습니다.

    • ElementTemplate - 요소의 구조 정보에 액세스할 수 있습니다.
  • FragmentTemplate 다음을 적용할 수 있습니다.

    • Resource - Resource 복사된 원래 템플릿 또는 참조된 모델을 결정합니다.

      • Resource을 통해 변경한 내용이 FragmentTemplate에 자동으로 반영되지 않습니다.
  • Resource 다음을 적용할 수 있습니다.

    • ContentFragment
    • FragmentTemplate

Caveze

다음 사항에 유의해야 합니다.

  • API는 UI에서 지원하는 기능을 제공하기 위해 구현됩니다.

  • 전체 API는 API JavaDoc에 별도로 명시되어 있지 않는 한 변경 내용을 자동으로 지속하지 않도록 설계되었습니다. 따라서 항상 각 요청의 리소스 해결 프로그램(또는 실제로 사용 중인 해결 프로그램)을 커밋해야 합니다.

  • 추가 노력이 필요할 수 있는 작업:

    • 새 요소를 생성/제거해도 단순 조각의 데이터 구조가 업데이트되지 않습니다(조각 템플릿 기반).
    • ContentElement에서 새 변형을 만들면 데이터 구조가 업데이트되지 않습니다(하지만 ContentFragment에서 전역적으로 만들기).
    • 기존 변형을 제거해도 데이터 구조가 업데이트되지 않습니다.

컨텐츠 조각 관리 API - 클라이언트측

주의

AEM 6.4의 경우 클라이언트측 API는 내부적입니다.

추가 정보

다음을 참조하십시오.

  • filter.xml

    컨텐츠 조각 관리에 대한 filter.xml이(가) Assets 핵심 컨텐츠 패키지와 겹치지 않도록 구성되었습니다.

세션 편집

사용자가 편집기 페이지 중 하나에서 컨텐츠 조각을 열면 편집 세션이 시작됩니다. 사용자가 저장 또는 취소​를 선택하여 편집기를 떠날 때 편집 세션이 종료됩니다.

요구 사항

편집 세션을 제어하기 위한 요구 사항은 다음과 같습니다.

  • 여러 보기(= HTML 페이지)를 확장할 수 있는 컨텐츠 조각을 편집하는 것은 원자력이 있어야 합니다.
  • 편집은 transactional;이어야 합니다.편집 세션이 종료되면 변경 내용을 커밋하거나(저장) 롤백하거나(취소됨) 취소해야 합니다.
  • 가장자리 사례는 올바르게 처리해야 합니다.사용자가 URL을 수동으로 입력하거나 전역 탐색을 사용하여 페이지를 나가는 경우와 같은 경우가 여기에 포함됩니다.
  • 데이터 손실을 방지하기 위해 주기적인 자동 저장(x분마다)을 사용할 수 있어야 합니다.
  • 컨텐츠 조각을 두 사용자가 동시에 편집하는 경우 서로의 변경 사항을 덮어쓰지 않아야 합니다.

프로세스

관련 프로세스는 다음과 같습니다.

  • 세션 시작

    • 컨텐츠 조각의 새 버전이 만들어집니다.
    • 자동 저장이 시작되었습니다.
    • 쿠키가 설정되어 있습니다.현재 편집된 조각을 정의하며 열려 있는 편집 세션이 있음을 정의합니다.
  • 세션 완료

    • 자동 저장이 중지됩니다.

    • 커밋 시:

      • 마지막으로 수정한 정보가 업데이트됩니다.
      • 쿠키가 제거됩니다.
    • 롤백 시:

      • 편집 세션을 시작할 때 생성된 컨텐츠 조각 버전이 복원됩니다.
      • 쿠키가 제거됩니다.
  • 편집

    • 모든 변경 사항(자동 저장 포함)은 분리된 보호 영역이 아닌 활성 컨텐츠 조각에서 수행됩니다.
    • 따라서 이러한 변경 사항은 해당 컨텐츠 조각을 참조하는 AEM 페이지에 즉시 반영됩니다

작업

가능한 작업은 다음과 같습니다.

  • 페이지 입력

    • 편집 세션이 이미 있는지 확인합니다.쿠키를 확인합니다.

      • 해당 세션이 있는 경우 현재 편집 중인 컨텐츠 조각에 대해 편집 세션이 시작되었는지 확인합니다

        • 현재 조각이 있는 경우 세션을 다시 설정합니다.
        • 그렇지 않은 경우 이전에 편집한 컨텐츠 조각에 대한 편집을 취소하고 쿠키를 제거합니다(나중에 편집 세션이 표시되지 않음).
      • 편집 세션이 없는 경우 사용자가 처음 변경한 내용을 기다립니다(아래 참조).

    • 컨텐츠 조각이 페이지에서 이미 참조되었는지 확인하고, 참조되면 적절한 정보를 표시합니다.

  • 컨텐츠 변경

    • 사용자가 내용을 변경하고 편집 세션이 없을 때마다 새 편집 세션이 만들어집니다(세션 시작 참조).
  • 페이지 나가기

    • 편집 세션이 있고 변경 사항이 지속되지 않은 경우 사용자에게 컨텐츠 손실 가능성을 알리고 해당 페이지가 계속 유지될 수 있도록 하는 모달 확인 대화 상자가 표시됩니다.

예:기존 컨텐츠 조각에 액세스

이를 위해 API를 나타내는 리소스를 다음과 같이 적용할 수 있습니다.

com.adobe.cq.dam.cfm.ContentFragment

예:

// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
    ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
    // the resource is now accessible through the API
} 

예:새 컨텐츠 조각 만들기

프로그래밍 방식으로 새 컨텐츠 조각을 만들려면 다음을 사용해야 합니다.

com.adobe.cq.dam.cfm.ContentFragmentManager#create

예:

Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

예:자동 저장 간격 지정

자동 저장 간격(초 단위)은 구성 관리자(ConfMgr)를 사용하여 정의할 수 있습니다.

  • 노드:<conf-root>/settings/dam/cfm/jcr:content

  • 속성 이름: autoSaveInterval

  • 유형: Long

  • 기본값:600(10분);/libs/settings/dam/cfm/jcr:content에 정의됩니다.

자동 저장 간격을 5분으로 설정하려면 노드에서 속성을 정의해야 합니다.예를 들면 다음과 같습니다.

  • 노드:/conf/global/settings/dam/cfm/jcr:content

  • 속성 이름: autoSaveInterval

  • 유형: Long

  • 값:300(5분은 300초로 완료)

컨텐츠 조각 템플릿

자세한 내용은 컨텐츠 조각 템플릿을 참조하십시오.

페이지 작성용 구성 요소

자세한 내용은

이 페이지에서는