프런트 엔드 매니페스트 설명서

이 문서에서는 패브릭 워크로드에서 프런트 엔드 매니페스트의 구조 및 구성에 대한 자세한 가이드를 제공합니다. 이러한 JSON 기반 매니페스트를 사용하면 파트너가 워크로드 모양, ID 및 동작을 정의할 수 있으며, 패브릭에서 사용자에게 맞춤화되고 일관된 환경을 제공하는 데 필수적입니다.

프런트 엔드 매니페스트는 다음 두 가지 주요 구성 요소로 구성됩니다.

• 제품 매니페스트: 워크로드 ID 및 브랜딩을 정의합니다.
• 항목 매니페스트: 사용자 상호 작용 요소를 포함하여 워크로드 내의 개별 항목에 대한 세부 정보 구성입니다.

제품 매니페스트

제품 매니페스트는 사용자 상호 작용을 위한 ID, 브랜딩 및 구성을 지정하여 워크로드 제품의 핵심 특성을 정의합니다.

특성

• 이름 (문자열): 제품의 고유한 시스템 이름입니다.
• displayName (문자열): 사용자에게 친숙한 표시 이름입니다.
• fullDisplayName (문자열): 제품의 설명이 포함된 이름입니다.
• favicon (문자열): 제품의 favicon 경로입니다.
• icon (개체): 자산 폴더(예: "assets/icon.png")에 저장된 제품 아이콘의 경로입니다.

홈페이지 구성

워크로드 홈페이지의 레이아웃과 콘텐츠를 정의합니다.

• homePage (개체): 홈페이지에 대한 구성 설정입니다.
  • learningMaterials (배열): 워크로드 세부 정보 페이지에 표시되는 학습 자료 목록입니다.
    • title (문자열): 학습 자료의 제목입니다.
    • 소개 (문자열): 자료를 간략하게 소개합니다.
    • description (string): 재질에 대한 자세한 설명입니다.
    • onClick (개체): 재질을 클릭할 때 트리거되는 동작입니다.
    • image (string): 재질과 연결된 이미지의 경로입니다.
  • recommendedItemTypes (배열): 워크로드 세부 정보 페이지에 표시되는 권장 항목 유형 목록입니다.

경험 창조하기

제품에서 새 항목을 만들고 사용자 상호 작용 옵션을 지정하기 위한 구성입니다.

• createExperience (개체): 워크로드 항목을 만들기 위한 구성입니다.
  • description (string): 만들기 환경에 대한 일반적인 설명입니다.
  • 카드 (배열): 생성 프로세스 중에 표시되는 카드 목록입니다.
    • title (문자열): 카드의 제목입니다.
    • description (string): 카드에 대한 간략한 설명입니다.
    • icon (개체): 카드에 사용되는 아이콘의 경로입니다.
    • onClick (개체): 카드를 클릭할 때 트리거되는 작업입니다.
    • availableIn (배열): 카드를 사용할 수 있는 위치입니다.
    • itemType (문자열): 만든 카드에 연결된 항목의 유형입니다.
    • createItemDialogConfig (개체): 항목 만들기 대화 상자 구성입니다.
      • onCreationFailure (개체): 항목 만들기에 실패할 때 트리거되는 작업입니다.
      • onCreationSuccess (개체): 항목 만들기에 성공했을 때 트리거되는 작업입니다.

작업 영역 설정 및 제품 세부 정보

• workspaceSettings (개체): 작업 영역 기능과 관련된 설정입니다.
  • getWorkspaceSettings (개체): 작업 영역 설정을 검색하는 작업을 포함합니다.
• productDetail (개체): 제품 브랜딩 및 정보에 대한 추가 세부 정보입니다.
  • 게시자 (문자열): 제품의 게시자입니다.
  • 슬로건 (문자열): 제품 슬로건입니다.
  • description (string): 제품에 대한 간단한 설명입니다.
  • 이미지 (개체): 제품 이미지의 구성입니다.
    • mediaType (정수): 이미지의 미디어 형식입니다.
    • source (string): 이미지의 경로입니다.
  • slideMedia (배열): 제품 세부 정보 페이지 슬라이드에 사용되는 미디어 파일 목록입니다.
    • 제한: 배열에서 slideMedia 항목이 허용되지 않습니다.
    • 각 항목(개체):
      • mediaType(정수): 슬라이드의 미디어 유형입니다. 이미지에 0 사용하고 비디오의 1 사용합니다.
      • 원본(문자열): 이미지 또는 비디오 원본의 경로입니다.
      • 참고: 비디오의 경우: 비디오에 URL을 제공합니다. 지원되는 형식은 다음과 같습니다.
        • https://youtube.com/embed/<id> 또는 https://www.youtube.com/embed/<id>
          • 예: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
        • https://player.vimeo.com/video/<number>
          • 참고: vimeo URL에 포함하지 마세요. www.

slideMedia 구성의 예:

"slideMedia": [
  {
    "mediaType": 1,
    "source": "https://youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi"
  },
  {
    "mediaType": 0,
    "source": "assets/images/SlideImage1.png"
  }
]

항목 매니페스트

항목 매니페스트는 특성, 아이콘, 편집기 경로 및 작업 관련 설정을 포함하여 워크로드 내의 개별 항목에 대한 구성 세부 정보를 정의합니다.

특성

• 이름 (문자열): 항목의 고유한 시스템 이름입니다.
• displayName (문자열): 항목에 대해 표시되는 사용자 친화적인 이름입니다.
• displayNamePlural (문자열): 표시를 위해 표시 이름의 복수 형식입니다.

편집기 및 아이콘 구성

• 편집기 (개체): 패브릭 워크로드 앱의 항목 편집기 경로 구성입니다.
  • path (문자열): 편집기 상대 경로입니다.
• icon (개체): 항목을 나타내는 아이콘을 지정합니다.
  • name (string): assets 폴더의 아이콘 파일 경로입니다(예: "assets/icon.svg").

상황에 맞는 메뉴 항목

항목의 상황에 맞는 메뉴에서 사용할 수 있는 작업을 정의하여 사용자에게 상호 작용 옵션을 제공합니다.

• contextMenuItems (배열): 상황에 맞는 메뉴의 작업 목록입니다.
  • name (string): 작업의 시스템 이름입니다.
  • displayName (문자열): 작업의 표시 이름입니다.
  • 아이콘 (개체): 작업의 아이콘입니다.
    • name (string): 아이콘 파일의 경로입니다(예: "assets/icon.svg").
  • 처리기 (개체): 메뉴 항목에 대한 작업 처리기입니다.
    • action (문자열): 트리거된 작업의 이름입니다.
  • 도구 설명 (문자열): 작업에 대한 선택적 도구 설명 텍스트입니다.

모니터링 및 DataHub 구성

• supportedInMonitoringHub (부울): 항목을 모니터링 허브에 표시하거나 필터링할 수 있는지 여부를 지정합니다.
• supportedInDatahubL1 (부울): 항목을 DataHub L1에 표시하거나 필터링할 수 있는지 여부를 지정합니다.

항목 작업 동작 구성

항목 작업 인스턴스와 연결된 작업 관련 작업에 대한 구성입니다.

• itemJobActionConfig (개체): 항목의 작업과 관련된 작업을 정의합니다.
  • registeredActions (개체): 세부 정보, 취소 및 다시 시도와 같은 작업 작업을 포함합니다.
    • 세부 정보 (개체): 작업 세부 정보를 보기 위한 작업입니다.
    • cancel (개체): 작업을 취소하기 위한 작업입니다.
    • 다시 시도 (개체): 작업을 다시 시도하기 위한 작업입니다.

항목 설정

항목 설정에 대한 구성 옵션입니다.

• itemSettings (개체): 항목에 대한 추가 설정입니다.
  • schedule (개체): 예약 정보를 포함합니다.
    • itemJobType(문자열): 패브릭 공유 UI에서 예약할 작업 유형입니다.
    • refreshType (문자열): 항목의 새로 고침 기능을 지정합니다. 가능한 값에는 "None", "Refresh"및 "Run".
  • recentRun (개체): 최근 작업 실행에 대한 구성입니다.
    • useRecentRunsComponent (부울 설정): 패브릭 공유 최근 실행 구성 요소를 사용할지 여부입니다.
  • getItemSettings (개체): 사용자 지정 항목 설정에 대한 구성입니다.
    • 작업(문자열): 사용자 지정 항목 설정 목록을 반환할 해당 작업의 이름입니다.

항목 작업 흐름 범주

Fabric 작업 흐름 프레임워크통합하기 위한 항목 범주를 정의합니다.

• itemJobTypes (배열): 작업 흐름 프레임워크 내의 항목에 할당된 범주를 지정합니다. 각 항목에는 최대 두 개의 범주가 있을 수 있습니다. 지원되는 범주는 다음과 같습니다.
  • "getData"
  • "storeData"
  • "prepareData"
  • "analyzeAndTrainData"
  • "trackData"
  • "visualizeData"
  • "develop"
  • "generalTask"
  • "others"

범주를 지정하지 않으면 "others" 기본값으로 사용됩니다.

OneLake 카탈로그 범주 항목

OneLake 카탈로그에 항목이 표시되는 범주를 정의합니다.

• oneLakeCatalogCategory (배열): 항목이 OneLake 카탈로그에 표시되는 범주를 지정합니다. 각 항목에는 최대 두 개의 범주가 있을 수 있습니다. 지원되는 범주는 다음과 같습니다.
  • "Data"
  • "Insight"
  • "Process"
  • "Solution"
  • "Configuration"
  • "Other"

범주를 지정하지 않으면 항목이 OneLake 카탈로그에 표시되지 않습니다.

항목 만들기 대화 상자 구성

항목 유형 클릭의 워크로드 허브에서 대화 상자를 표시하는 데 사용되는 항목 만들기 대화 상자 구성을 정의합니다.

• createItemDialogConfig (개체): 항목 만들기 대화 상자 구성입니다.
  • onCreationFailure (개체): 항목 만들기에 실패할 때 트리거되는 작업입니다.
  • onCreationSuccess (개체): 항목 만들기에 성공했을 때 트리거되는 작업입니다.