Τεκμηρίωση διακήρυξης προσκηνίου

Αυτό το έγγραφο παρέχει έναν λεπτομερή οδηγό για τη δομή και τη ρύθμιση παραμέτρων των διακήρυξης προσκηνίου σε φόρτους εργασίας Fabric. Αυτές οι εκδηλώσεις που βασίζονται σε JSON επιτρέπουν στους συνεργάτες να ορίζουν την εμφάνιση, την ταυτότητα και τη συμπεριφορά του φόρτου εργασίας, απαραίτητα για την παροχή στους χρήστες μιας προσαρμοσμένης και συνεπούς εμπειρίας στο Fabric.

Οι εκδηλώσεις προσκηνίου αποτελούνται από δύο κύρια στοιχεία:

• Διακήρυξη προϊόντος: Καθορίστε την ταυτότητα και την εμπορική προσαρμογή φόρτου εργασίας.
• Διακήρυξη στοιχείου: Ρύθμιση παραμέτρων λεπτομερειών για μεμονωμένα στοιχεία εντός του φόρτου εργασίας, συμπεριλαμβανομένων των στοιχείων αλληλεπίδρασης χρήστη.

Διακήρυξη προϊόντος

Η Διακήρυξη προϊόντος ορίζει τα βασικά χαρακτηριστικά του προϊόντος του φόρτου εργασίας, καθορίζοντας την ταυτότητά του, την εμπορική προσαρμογή και τη ρύθμιση παραμέτρων για την αλληλεπίδραση του χρήστη.

Χαρακτηριστικά

• name (συμβολοσειρά): Ένα μοναδικό όνομα συστήματος για το προϊόν.
• displayName (συμβολοσειρά): Ένα εμφανιζόμενο όνομα φιλικό προς τον χρήστη.
• fullDisplayName (συμβολοσειρά): Ένα περιγραφικό όνομα για το προϊόν.
• favicon (συμβολοσειρά): Η διαδρομή προς το favicon του προϊόντος.
• εικονίδιο (αντικείμενο): Η διαδρομή προς το εικονίδιο του προϊόντος, αποθηκευμένη στον φάκελο πόρων (π.χ., "assets/icon.png").

Ρύθμιση παραμέτρων αρχικής σελίδας

Καθορίζει τη διάταξη και το περιεχόμενο της αρχικής σελίδας του φόρτου εργασίας.

• homePage (αντικείμενο): Ρυθμίσεις παραμέτρων για την αρχική σελίδα.
  • learningMaterials (πίνακας ): Λίστα εκπαιδευτικού υλικού που εμφανίζεται στη σελίδα λεπτομερειών φόρτου εργασίας.
    • title (συμβολοσειρά): Ο τίτλος του εκπαιδευτικού υλικού.
    • εισαγωγή (συμβολοσειρά): Σύντομη εισαγωγή στο υλικό.
    • description (συμβολοσειρά): Αναλυτική περιγραφή του υλικού.
    • onClick (αντικείμενο): Η ενέργεια ενεργοποιείται όταν γίνεται κλικ στο υλικό.
    • image (συμβολοσειρά): Η διαδρομή προς την εικόνα που σχετίζεται με το υλικό.
  • recommendedItemTypes (πίνακας ): Λίστα των προτεινόμενων τύπων στοιχείων που εμφανίζονται στη σελίδα λεπτομερειών φόρτου εργασίας.

Δημιουργία εμπειρίας

Ρυθμίσεις παραμέτρων για τη δημιουργία νέων στοιχείων στο προϊόν, καθορίζοντας επιλογές για την αλληλεπίδραση του χρήστη.

• createExperience (αντικείμενο): Ρύθμιση παραμέτρων για τη δημιουργία στοιχείων φόρτου εργασίας.
  • description (συμβολοσειρά): Γενική περιγραφή της εμπειρίας δημιουργίας.
  • cards (πίνακας): Λίστα καρτών που εμφανίζονται κατά τη διαδικασία δημιουργίας.
    • title (συμβολοσειρά): Ο τίτλος της κάρτας.
    • description (συμβολοσειρά): Σύντομη περιγραφή της κάρτας.
    • εικονίδιο (αντικείμενο): Διαδρομή προς το εικονίδιο που χρησιμοποιείται στην κάρτα.
    • onClick (αντικείμενο): Η ενέργεια ενεργοποιείται όταν γίνεται κλικ στην κάρτα.
    • availableIn (πίνακας): Θέσεις όπου η κάρτα είναι διαθέσιμη.
    • itemType (συμβολοσειρά): Τύπος στοιχείου που είναι συνδεδεμένο με την κάρτα που δημιουργήθηκε.

Ρυθμίσεις χώρου εργασίας και λεπτομέρειες προϊόντος

• workspaceSettings (αντικείμενο): Ρυθμίσεις συγκεκριμένες για τη λειτουργικότητα του χώρου εργασίας.
  • getWorkspaceSettings (αντικείμενο): Περιέχει μια ενέργεια για την ανάκτηση ρυθμίσεων χώρου εργασίας.
• productDetail (αντικείμενο): Πρόσθετες λεπτομέρειες για την επωνυμία και τις πληροφορίες προϊόντων.
  • εκδότης (συμβολοσειρά): Εκδότης του προϊόντος.
  • σύνθημα (συμβολοσειρά): Σύνθημα προϊόντος.
  • description (συμβολοσειρά): Σύντομη περιγραφή του προϊόντος.
  • image (αντικείμενο): Ρύθμιση παραμέτρων εικόνων προϊόντος.
    • mediaType (ακέραιος): Τύπος πολυμέσων της εικόνας.
    • source (συμβολοσειρά): Η διαδρομή προς την εικόνα.
  • slideMedia (πίνακας): Λίστα των αρχείων πολυμέσων που χρησιμοποιούνται στις διαφάνειες της σελίδας λεπτομερειών προϊόντος.

Διακήρυξη στοιχείου

Η Διακήρυξη στοιχείου ορίζει λεπτομέρειες ρύθμισης παραμέτρων για μεμονωμένα στοιχεία εντός του φόρτου εργασίας, όπως χαρακτηριστικά, εικονίδια, διαδρομές προγράμματος επεξεργασίας και ρυθμίσεις που σχετίζονται με την εργασία.

Χαρακτηριστικά

• name (συμβολοσειρά): Ένα μοναδικό όνομα συστήματος για το στοιχείο.
• displayName (συμβολοσειρά): Εμφανίζεται φιλικό προς τον χρήστη όνομα για το στοιχείο.
• displayNamePlural (συμβολοσειρά): Μορφή πληθυντικού του εμφανιζόμενου ονόματος για σκοπούς εμφάνισης.

Διαμόρφωση προγράμματος επεξεργασίας και εικονιδίου

• πρόγραμμα επεξεργασίας (αντικείμενο): Ρύθμιση παραμέτρων διαδρομής για το πρόγραμμα επεξεργασίας του στοιχείου στην εφαρμογή φόρτου εργασίας Fabric.
  • path (συμβολοσειρά): Σχετική διαδρομή προς το πρόγραμμα επεξεργασίας.
• εικονίδιο (αντικείμενο): Καθορίζει το εικονίδιο που αντιπροσωπεύει το στοιχείο.
  • name (συμβολοσειρά): Η διαδρομή προς το αρχείο εικονιδίου στον φάκελο πόρων (π.χ. "assets/icon.svg").

Στοιχεία μενού περιβάλλοντος

Καθορίζει τις ενέργειες που είναι διαθέσιμες στο μενού περιβάλλοντος του στοιχείου, παρέχοντας στους χρήστες επιλογές αλληλεπίδρασης.

• contextMenuItems (πίνακας): Λίστα ενεργειών στο μενού περιβάλλοντος.
  • name (συμβολοσειρά): Το όνομα συστήματος της ενέργειας.
  • displayName (συμβολοσειρά): Εμφανιζόμενο όνομα για την ενέργεια.
  • εικονίδιο (αντικείμενο): Εικονίδιο για την ενέργεια.
    • name (συμβολοσειρά): Η διαδρομή προς το αρχείο εικονιδίου (π.χ., "assets/icon.svg").
  • handler (αντικείμενο): Χειρισμός ενεργειών για το στοιχείο μενού.
    • action (συμβολοσειρά): Το όνομα της ενέργειας που ενεργοποιείται.
  • tooltip (συμβολοσειρά): Προαιρετικό κείμενο συμβουλής εργαλείου για την ενέργεια.

Παρακολούθηση και ρύθμιση παραμέτρων του DataHub

• supportedInMonitoringHub (δυαδική τιμή): Καθορίζει εάν το στοιχείο μπορεί να εμφανίζεται ή να φιλτράρεται στο Κέντρο παρακολούθησης.
• supportedInDatahubL1 (δυαδική τιμή): Καθορίζει εάν το στοιχείο μπορεί να εμφανίζεται ή να φιλτράρεται στο DataHub L1.

Ρύθμιση παραμέτρων ενέργειας εργασίας στοιχείου

Ρυθμίσεις παραμέτρων για ενέργειες που σχετίζονται με την εργασία στοιχείου.

• itemJobActionConfig (αντικείμενο): Ορίζει ενέργειες που σχετίζονται με τις εργασίες του στοιχείου.
  • registeredActions (αντικείμενο): Περιέχει ενέργειες εργασίας όπως λεπτομέρειες, ακύρωση και επανάληψη.
    • detail (αντικείμενο): Ενέργεια για την προβολή λεπτομερειών εργασίας.
    • cancel (αντικείμενο): Ενέργεια για την ακύρωση μιας εργασίας.
    • επανάληψη (αντικείμενο): Ενέργεια για την επανάληψη μιας εργασίας.

Ρυθμίσεις στοιχείου

Επιλογές ρυθμίσεων παραμέτρων για τις ρυθμίσεις στοιχείων.

• itemSettings (αντικείμενο): Πρόσθετες ρυθμίσεις για το στοιχείο.
  • schedule (αντικείμενο): Περιέχει πληροφορίες προγραμματισμού.
    • itemJobType (συμβολοσειρά): Ο τύπος εργασίας για προγραμματισμό από κοινόχρηστο περιβάλλον εργασίας υφάσματος.
    • refreshType (συμβολοσειρά): Καθορίζει τη δυνατότητα ανανέωσης του στοιχείου. Οι πιθανές τιμές περιλαμβάνουν "None"τα , "Refresh"και "Run".
  • recentRun (αντικείμενο): Ρύθμιση παραμέτρων για πρόσφατες εκτελέσεις εργασιών.
    • useRecentRunsComponent (δυαδική τιμή): Ορίζει εάν θα χρησιμοποιείται το στοιχείο κοινόχρηστων πρόσφατων εκτελέσεων fabric.

Κατηγορίες ροής εργασιών στοιχείου

Καθορίζει τις κατηγορίες στοιχείων για ενοποίηση με το Πλαίσιο ροής εργασιών Fabric.

• itemJobTypes (πίνακας ): Καθορίζει τις κατηγορίες που έχουν ανατεθεί σε ένα στοιχείο στο πλαίσιο ροής εργασιών. Κάθε στοιχείο μπορεί να έχει έως και δύο κατηγορίες. Οι υποστηριζόμενες κατηγορίες είναι οι "getData", "storeData", , "prepareData", "analyzeAndTrainData", "trackData", "visualizeData", "develop", "generalTask", και "others". Εάν δεν έχει καθοριστεί καμία κατηγορία, το στοιχείο "άλλα" χρησιμοποιείται ως προεπιλογή.

Σημείωμα

Κατά την ανάπτυξη και τη δοκιμή νέων χαρακτηριστικών που προστίθενται στη διακήρυξη, βεβαιωθείτε ότι έχετε συγχρονίσει τις πιο πρόσφατες δέσμες ενεργειών επικύρωσης και εργαλεία από το δείγμα αποθετηρίου δεδομένων μας.

Αυτό το βήμα είναι απαραίτητο μόνο για την τοπική ανάπτυξη και δεν είναι απαραίτητο για τη λειτουργία cloud.