Aracılığıyla paylaş

Ön Uç Manifestolar Dokümantasyonu

Bu belge, Doku iş yüklerindeki ön uç bildirimlerinin yapısı ve yapılandırmasına yönelik ayrıntılı bir kılavuz sağlar. Bu JSON tabanlı bildirimler, iş ortaklarının kullanıcılara Doku'da uyarlanmış ve tutarlı bir deneyim sunmak için gerekli olan iş yükü görünümünü, kimliğini ve davranışını tanımlamasını sağlar.

Ön uç bildirimleri iki ana bileşenden oluşur:

  • Ürün Bildirimi: İş yükü kimliğini ve markasını tanımlar.
  • Öğe Bildirimi: Kullanıcı etkileşim öğeleri de dahil olmak üzere iş yükündeki tek tek öğeler için yapılandırmayı ayrıntılarıyla açıklar.

Ürün Bildirimi

Ürün Bildirimi, iş yükünün ürününün temel özniteliklerini tanımlar ve kullanıcı etkileşimi için kimliğini, markasını ve yapılandırmasını belirtir.

Özellikler

  • name (dize): Ürün için benzersiz bir sistem adı.
  • displayName (dize): Kullanıcı dostu bir görünen ad.
  • fullDisplayName (dize): Ürün için açıklayıcı bir ad.
  • favicon (string): Ürünün favicon yolu.
  • icon (object): Assets klasöründe (ör. "assets/icon.png") depolanan ürün simgesinin yolu.

Giriş Sayfası Yapılandırması

İş yükünün giriş sayfasının düzenini ve içeriğini tanımlar.

  • homePage (nesne): Giriş sayfası için yapılandırma ayarları.
    • learningMaterials (dizi): İş yükü ayrıntıları sayfasında görüntülenen öğrenme malzemelerinin listesi.
      • title (dize): Öğrenme malzemesinin başlığı.
      • giriş (dize): Malzemeye kısa bir giriş.
      • description (string): Malzemenin ayrıntılı açıklaması.
      • onClick (nesne): Malzeme tıklandığında tetiklenen eylem.
      • image (string): Malzemeyle ilişkilendirilmiş görüntünün yolu.
    • recommendedItemTypes (dizi): İş yükü ayrıntıları sayfasında görüntülenen önerilen öğe türlerinin listesi.

Deneyim Oluşturma

Kullanıcı etkileşimi seçeneklerini belirterek üründe yeni öğeler oluşturmaya yönelik yapılandırmalar.

  • createExperience (nesne): İş yükü öğelerinin oluşturulması için yapılandırma.
    • description (string): Oluşturma deneyiminin genel açıklaması.
    • kartlar (dizi): Oluşturma işlemi sırasında görüntülenen kartların listesi.
      • title (dize): Kartın başlığı.
      • description (string): Kartın kısa açıklaması.
      • icon (object): Kartta kullanılan simgenin yolu.
      • onClick (nesne): Kart tıklandığında tetiklenen eylem.
      • availableIn (dizi): Kartın kullanılabildiği konumlar.
      • itemType (dize): Oluşturulan karta bağlı öğenin türü.
      • createItemDialogConfig (nesne): Öğe iletişim kutusu yapılandırması oluşturun.
        • onCreationFailure (nesne): Öğe oluşturulamadığında tetiklenen eylem.
        • onCreationSuccess (nesne): Öğe oluşturma başarılı olduğunda tetiklenen eylem.

Not

createItemDialogConfig kullanımının onCreationFailure ve onCreationSuccess içinde eylem işleyicilerinin eklenmesini index.worker.ts gerektirdiği. Örnek depomuzda bulunabilir.

Çalışma Alanı Ayarları ve Ürün Ayrıntıları

  • workspaceSettings (nesne): Çalışma alanı işlevselliğine özgü ayarlar.
    • getWorkspaceSettings (nesne): Çalışma alanı ayarlarını almak için eylem içerir.
  • productDetail (nesne): Ürün markası ve bilgileri için ek ayrıntılar.
    • publisher (dize): Ürünün yayımcısı.
    • slogan (dize): Ürün sloganı.
    • description (string): Ürünün kısa açıklaması.
    • image (object): Ürün görüntülerinin yapılandırması.
      • mediaType (tamsayı): Görüntünün medya türü.
      • source (string): Görüntünün yolu.
    • slideMedia (dizi): Ürün ayrıntıları sayfası slaytlarında kullanılan medya dosyalarının listesi.
      • Sınırı: dizisinde en fazla slideMedia öğeye izin verilmez.
      • Her öğe (nesne):
        • mediaType (tamsayı): Sunum slaytının medya türü. Görüntüler için 0 ve videolar için 1 kullanın.
        • kaynak (dize): Görüntü veya video kaynağının yolu.
        • Not: Videolar için: Videonun URL'sini sağlayın. Desteklenen biçimler şunlardır:
          • https://youtube.com/embed/<id> veya https://www.youtube.com/embed/<id>
            • Örnek: 'https://www.youtube.com/embed/UNgpBOCvwa8?si=KwsR879MaVZd5CJi
          • https://player.vimeo.com/video/<number>
            • Not: vimeo URL'sine www. eklemeyin.

slideMedia Yapılandırması örneği:

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

Öğe Bildirimi

Öğe Bildirimi, öznitelikler, simgeler, düzenleyici yolları ve işle ilgili ayarlar dahil olmak üzere iş yükü içindeki tek tek öğeler için yapılandırma ayrıntılarını tanımlar.

Özellikler

  • name (dize): Öğe için benzersiz bir sistem adı.
  • displayName (dize): Kullanıcı dostu bir şekilde görüntülenen ad.
  • displayNamePlural (dize): Görüntüleme amacıyla görünen adın çoğul biçimi.

Düzenleyici ve Simge Yapılandırması

  • düzenleyici (nesne): Fabric iş yükü uygulamasında, öğenin düzenleyicisi için yol ayarları.
    • path (metin): Düzenleyicinin göreli yolu.
  • icon (object): Öğeyi temsil eden simgeyi belirtir.
    • name (dize): Assets klasöründeki simge dosyasının yolu (örneğin, "assets/icon.svg").

Bağlam Menüsü Öğeleri

Öğenin bağlam menüsünde kullanılabilen eylemleri tanımlar ve kullanıcılara etkileşim seçenekleri sağlar.

  • contextMenuItems (dizi): Bağlam menüsündeki eylemlerin listesi.
    • name (dize): Eylemin sistem adı.
    • displayName (dize): Eylemin görünen adı.
    • icon (object): Eylem simgesi.
      • name (dize): Simge dosyasının yolu (örneğin, "assets/icon.svg").
    • işleyici (nesne): Menü öğesi için eylem işleyicisi.
      • action (dize): Tetiklenen eylemin adı.
    • araç ipucu (dize): Eylem için isteğe bağlı araç ipucu metni.

İzleme ve DataHub Yapılandırması

  • supportedInMonitoringHub (boole): Öğenin İzleme Hub'ında gösterilip gösterilmeyebileceğini veya filtrelenebileceğini belirtir.
  • supportedInDatahubL1 (boole): Öğenin DataHub L1'de gösterilip gösterilmeyebileceğini veya filtrelenebileceğini belirtir.

Öğe İş Görevi Yapılandırması

Öğe iş örneğiyle ilişkili işle ilgili eylemler için yapılandırmalar.

  • itemJobActionConfig (nesne): Öğenin işleri ile ilgili eylemleri tanımlar.
    • registeredActions (nesne): Ayrıntı, iptal etme ve yeniden deneme gibi iş eylemlerini içerir.
      • detail (object): İş ayrıntılarını görüntüleme eylemi.
      • cancel (nesne): bir işi iptal etme eylemi.
      • retry (nesne): bir işi tekrar denemeye yönelik eylem.

Öğe Ayarları

Öğe ayarları için yapılandırma seçenekleri.

  • itemSettings (object): Öğe için ek ayarlar.
    • schedule (nesne): Zamanlama bilgilerini içerir.
      • itemJobType (dize): Fabric paylaşımlı kullanıcı arabiriminden zamanlanacak iş türü.
      • refreshType (dize): Öğenin yenileme özelliğini belirtir. Olası değerler , "None"ve "Refresh"değerlerini içerir"Run".
    • recentRun (nesne): Son görev çalıştırmaları için yapılandırma.
      • useRecentRunsComponent (boolean): Fabric paylaşılan son çalıştırmalar bileşeninin kullanılıp kullanılmayacağı.
    • getItemSettings (nesne): Özel öğe ayarları için yapılandırma.
      • eylem (dize): Özel öğe ayarları listesini döndürecek ilgili eylemin adı.

Öğe Görev Akışı Kategorileri

Öğelerinizi, Fabric Görev Akışı Çerçevesiile entegre etmek için kategorilerini tanımlar.

  • itemJobTypes (dizi): Görev akışı çerçevesi içindeki bir öğeye atanan kategorileri belirtir. Her öğenin en fazla iki kategorisi olabilir. Desteklenen kategoriler şunlardır:
    • "getData"
    • "storeData"
    • "prepareData"
    • "analyzeAndTrainData"
    • "trackData"
    • "visualizeData"
    • "develop"
    • "generalTask"
    • "others"

Kategori belirtilmezse, varsayılan olarak "others" kullanılır.

Öğe OneLake Katalog Kategorileri

Öğenizin OneLake kataloğunda gösterildiği kategorileri tanımlar.

  • oneLakeCatalogCategory (dizi): Öğenin OneLake kataloğunda gösterildiği kategorileri belirtir. Her öğenin en fazla iki kategorisi olabilir. Desteklenen kategoriler şunlardır:
    • "Data"
    • "Insight"
    • "Process"
    • "Solution"
    • "Configuration"
    • "Other"

Kategori belirtilmezse, öğe OneLake kataloğunda gösterilmez.

Öğe oluşturma iletişim kutusu yapılandırması

İş yükü hub'ındaki öğe türüne tıklandığında iletişim kutusunu göstermek için kullanılan, öğe oluşturma iletişim kutusu yapılandırmasını tanımlar.

  • createItemDialogConfig (nesne): Öğe iletişim kutusu yapılandırması oluşturun.
    • onCreationFailure (nesne): Öğe oluşturulamadığında tetiklenen eylem.
    • onCreationSuccess (nesne): Öğe oluşturma başarılı olduğunda tetiklenen eylem.

Not

createItemDialogConfig kullanımı, onCreationFailure ve onCreationSuccess aksiyon işleyicilerinin index.worker.ts eklenmesini gerektirir. Örnek depomuzda bulunabilir.

  • Last updated on