Jaa

Edustan luettelotiedostojen dokumentaatio

  • Artikkeli

Tässä asiakirjassa on yksityiskohtainen opas edustaluetteloiden rakenteeseen ja konfigurointiin Fabric-kuormituksissa. Näiden JSON-pohjaisten luetteloiden avulla kumppanit voivat määrittää kuormituksen ulkoasun, käyttäjätiedot ja toiminnan, mikä on välttämätöntä, jotta käyttäjät voivat tarjota Fabricille räätälöidyn ja yhdenmukaisen käyttökokemuksen.

Edustan luettelot koostuvat kahdesta pääosasta:

  • Tuoteluettelo: Määritä kuormituksen käyttäjätiedot ja tuotemerkkimäärä.
  • Kohteen luettelotiedosto: kuormituksen yksittäisten kohteiden määritys, mukaan lukien käyttäjän vuorovaikutuselementit.

Tuotteen luettelotiedosto

Tuoteluettelo määrittää kuormituksen tuotteen ydinmääritteet sekä käyttäjätietojen, tuotemerkkien ja määritysten määrittämisen käyttäjän toimia varten.

Määritteet

  • name (merkkijono): Tuotteen yksilöivä järjestelmän nimi.
  • displayName (merkkijono): Käyttäjäystävällinen näyttönimi.
  • fullDisplayName (merkkijono): Tuotteen kuvaava nimi.
  • favicon (merkkijono): Polku tuotteen faviconiin.
  • kuvake (objekti): Polku tuotteen kuvakkeeseen, joka on tallennettu assets-kansioon (esim. "assets/icon.png").

Aloitussivun määritys

Määrittää kuormituksen aloitussivun asettelun ja sisällön.

  • aloitussivu (objekti): aloitussivun määritysasetukset.
    • learningMaterials (matriisi): Luettelo kuormituksen tietosivulla näkyvistä oppimismateriaaleista.
      • otsikko (merkkijono): Oppimateriaalin otsikko.
      • johdanto (merkkijono): Lyhyt johdanto aineistoon.
      • description (merkkijono): Materiaalin yksityiskohtainen kuvaus.
      • onClick (objekti): Toiminto käynnistyy, kun materiaalia napsautetaan.
      • image (merkkijono): Polku materiaaliin liittyvään kuvaan.
    • recommendedItemTypes (matriisi): Luettelo suositelluista kohdetyypeistä, jotka näytetään kuormituksen tietosivulla.

Luontikokemus

Määritysten määrittäminen uusien kohteiden luomiseksi tuotteeseen, käyttäjien vuorovaikutusasetusten määrittäminen.

  • createExperience (objekti): Määritys kuormituskohteiden luontia varten.
    • description (merkkijono): Luontikokemuksen yleinen kuvaus.
    • kortit (matriisi): Luettelo korteista, jotka näytetään luontiprosessin aikana.
      • title (merkkijono): Kortin otsikko.
      • description (merkkijono): Kortin lyhyt kuvaus.
      • -kuvake (objekti): Polku kortissa käytettävään kuvakkeeseen.
      • onClick (objekti): Toiminto käynnistyy, kun korttia napsautetaan.
      • availableIn (matriisi): Sijainnit, joissa kortti on käytettävissä.
      • itemType (merkkijono): Luotuun korttiin linkitetyn kohteen tyyppi.

Työtilan asetukset ja tuotetiedot

  • workspaceSettings (objekti): Työtilan toimintoihin liittyvät asetukset.
    • getWorkspaceSettings (objekti): Sisältää-toiminnon työtilan asetusten hakemiseksi.
  • productDetail (objekti): Lisätietoja tuotteen tuotebrändistä ja tiedoista.
    • publisher (merkkijono): Tuotteen julkaisija.
    • iskulause (merkkijono): Tuotteen iskulause.
    • description (merkkijono): Tuotteen lyhyt kuvaus.
    • image (objekti): Tuotekuvien määritys.
      • mediaType (kokonaisluku): Kuvan mediatyyppi.
      • source (merkkijono): Polku kuvaan.
    • slideMedia (matriisi): Luettelo tuotetietosivujen dioissa käytettävistä mediatiedostoista.

Kohteen luettelotiedosto

Kohdeluettelo määrittää kuormituksessa olevien yksittäisten kohteiden määritystiedot, kuten määritteet, kuvakkeet, editorin polut ja työhön liittyvät asetukset.

Määritteet

  • name (merkkijono): Kohteen yksilöivä järjestelmän nimi.
  • displayName (merkkijono): Kohteelle näytettävä käyttäjäystävällinen nimi.
  • displayNamePlural (merkkijono): Näyttönimen monikkomuoto näyttönimeä varten.

Editorin ja kuvakkeen määritys

  • editori (objekti): Kohteen editorin polun määritys Fabric-kuormitussovelluksessa.
    • polku (merkkijono): Suhteellinen polku editoriin.
  • kuvake (objekti): Määrittää kohdetta edustavan kuvakkeen.
    • name (merkkijono): Polku assets-kansion kuvaketiedostoon (esim. "assets/icon.svg").

Pikavalikon kohteet

Määrittää kohteen pikavalikossa käytettävissä olevat toiminnot, jolloin käyttäjät voivat käyttää vuorovaikutusvaihtoehtoja.

  • contextMenuItems (matriisi): Pikavalikon toimintoluettelo.
    • name (merkkijono): Toiminnon järjestelmän nimi.
    • displayName (merkkijono): Toiminnon näyttönimi.
    • kuvake (objekti): toiminnon kuvake.
      • name (merkkijono): Polku kuvaketiedostoon (esimerkiksi "assets/icon.svg").
    • käsittelijä (objekti): valikkokohteen toimintokäsittelijä.
      • toiminto (merkkijono): Käynnisseen toiminnon nimi.
    • tooltip (merkkijono): Toiminnon valinnainen työkaluvihjeen teksti.

Valvonta ja DataHub-määritys

  • supportedInMonitoringHub (totuusarvo): Määrittää, voidaanko kohde näyttää tai suodattaa valvontakeskuksessa.
  • supportedInDatahubL1 (totuusarvo): Määrittää, voidaanko kohde näyttää tai suodattaa DataHub L1:ssä.

Kohdetyön toiminnon määritys

Määritykset nimiketyön esiintymään liittyville työhön liittyville toiminnoille.

  • itemJobActionConfig (objekti): Määrittää kohteen työtehtäviin liittyvät toiminnot.
    • registeredActions (objekti): Sisältää työn toimintoja, kuten tietoja, peruutuksen ja uudelleenyritysten.
      • tiedot (objekti): Toiminto työn tietojen tarkastelemiseen.
      • cancel (objekti): Toiminto työn peruuttamiseen.
      • retry (object): Toiminto työn uudelleenyrityksenä.

Kohteen asetukset

Kohteen asetusten määritysasetukset.

  • itemSettings (objekti): Kohteen lisäasetukset.
    • schedule (objekti): Sisältää aikataulutiedot.
      • itemJobType (merkkijono): Työtyyppi ajoitetaan fabric-jaetusta käyttöliittymästä.
      • refreshType (merkkijono): Määrittää kohteen päivitysominaisuuden. Mahdollisia arvoja ovat "None", "Refresh"ja "Run".
    • recentRun (objekti): viimeaikaisten työn suoritusten määritykset.
      • useRecentRunsComponent (totuusarvo): Käytetäänkö kankaalla jaettuja viimeaikaisia suorituksia -osaa.
    • getItemSettings (objekti): Mukautettujen kohteiden asetusten määritys.
      • toiminnon (merkkijono): vastaavan toiminnon nimi, joka palauttaa mukautettujen kohteiden asetusten luettelon.

Kohteen tehtävänkulun luokat

Määrittää kohdeluokat Fabric Task Flow Framework -integrointia varten.

  • itemJobTypes (matriisi): Määrittää luokat, jotka on määritetty kohteelle tehtävänkulun kehyksessä. Jokaisessa kohteessa voi olla enintään kaksi luokkaa. Tuettuja luokkia ovat "getData", "storeData", "prepareData", "analyzeAndTrainData", "trackData", "visualizeData", , "develop", "generalTask"ja "others". Jos luokkaa ei ole määritetty, oletusarvona käytetään "muita".

Muistiinpano

Kun kehität ja testaat luettelotiedostoon lisättyjä uusia määritteitä, varmista, että olet synkronoinut uusimmat vahvistuskomentosarjat ja -työkalut mallisäilöstämme.

Tämä vaihe on tarpeen vain paikallista kehitystä varten, eikä sitä tarvita pilvitilassa.