openForm (αναφορά API JavaScript) για το Dynamics 365 Channel Integration Framework 1.0

Ανοίγει μια φόρμα οντότητας ή μια φόρμα γρήγορης δημιουργίας.

Syntax

Microsoft.CIFramework.openForm(entityFormOptions,formParameters).then(successCallback,errorCallback);

Parameters

Ονομασία	Type	Απαραίτητο	Περιγραφή
entityFormOptions	Αντικείμενο JSON	Όχι	Επιλογές φόρμας οντότητας για το άνοιγμα της φόρμας. Το αντικείμενο περιέχει τα ακόλουθα χαρακτηριστικά: - cmdbar - δημιουργίαFromEntity - entityId - entityName - formId -ύψος - navBar - openInNewWindow - windowPosition - processId - processInstanceId -σχέση - selectStageId - useQuickCreateForm -πλάτος Ανατρέξτε στον entityFormOptions πίνακα αντικειμένων για πληροφορίες σχετικά με τα χαρακτηριστικά.
formΠαράμετροι	Αντικείμενο	όχι	Ένα αντικείμενο λεξικού που μεταβιβάζει επιπλέον παραμέτρους στη φόρμα. Οι μη έγκυρες παράμετροι θα προκαλέσουν σφάλμα. Για πληροφορίες σχετικά με τη μεταβίβαση παραμέτρων σε μια φόρμα, ανατρέξτε στα θέματα Ορισμός τιμών πεδίων με χρήση παραμέτρων που μεταβιβάζονται σε φόρμα και Ρύθμιση παραμέτρων φόρμας για αποδοχή προσαρμοσμένων παραμέτρων συμβολοσειράς ερωτήματος.
επιτυχίαΕπανάκληση	Function	όχι	Μια συνάρτηση που εκτελείται όταν η λειτουργία είναι επιτυχής.
errorCallback	Function	όχι	Μια λειτουργία που εκτελείται όταν αποτύχει η λειτουργία.

entityFormOptions Χαρακτηριστικά αντικειμένων

Ο παρακάτω πίνακας περιγράφει τα χαρακτηριστικά της entityFormOptions παραμέτρου.

Σημείωμα

Τα χαρακτηριστικά είναι προαιρετικά.

Όνομα χαρακτηριστικού	Type	Περιγραφή
cmdBar	Δυαδική	Υποδεικνύει εάν θα εμφανίζεται η γραμμή εντολών. Εάν δεν καθορίσετε αυτήν την παράμετρο, η γραμμή εντολών εμφανίζεται από προεπιλογή.
createFromEntity	Αναζήτηση	Υποδεικνύει μια εγγραφή που θα παρέχει προεπιλεγμένες τιμές με βάση τις αντιστοιχισμένες τιμές χαρακτηριστικών. Το αντικείμενο αναζήτησης έχει τις ακόλουθες ιδιότητες τύπου συμβολοσειράς: entityType, idκαι name (προαιρετικά).
entityId	String	Αναγνωριστικό της καρτέλας οντότητας για την εμφάνιση της φόρμας.
entityName	String	Λογικό όνομα της οντότητας για την οποία θα εμφανιστεί η φόρμα.
formId	String	Αναγνωριστικό της παρουσίας φόρμας που θα εμφανίζεται.
ύψος	Αριθμός	Ύψος του παραθύρου φόρμας που θα εμφανίζεται σε pixel.
navBar	String	Ελέγχει εάν θα εμφανίζεται η γραμμή περιήγησης και εάν η περιήγηση εφαρμογών θα είναι διαθέσιμη χρησιμοποιώντας τις περιοχές και τις δευτερεύουσες περιοχές που ορίζονται στον χάρτη τοποθεσίας. Οι έγκυρες τιμές είναι: on: Εμφανίζεται η γραμμή περιήγησης. Αυτή είναι η προεπιλεγμένη συμπεριφορά, εάν δεν χρησιμοποιείται η navBar παράμετρος. off: Η γραμμή περιήγησης δεν εμφανίζεται. Ο χρήστης μπορεί να πλοηγηθεί χρησιμοποιώντας άλλα στοιχεία διεπαφής χρήστη ή τα κουμπιά πίσω και εμπρός. entity: Σε μια φόρμα οντότητας, είναι διαθέσιμες μόνο οι επιλογές περιήγησης για σχετικές οντότητες. Μετά την περιήγηση σε μια σχετική οντότητα, εμφανίζεται ένα κουμπί επιστροφής στη γραμμή περιήγησης για να επιτραπεί η επιστροφή στην αρχική εγγραφή.
openInNewWindow	Δυαδική	Υποδεικνύει εάν θα εμφανίζεται η φόρμα σε νέο παράθυρο.
παράθυροΘέση	Αριθμός	Υποδεικνύει τη θέση της φόρμας στο παράθυρο. Οι έγκυρες τιμές είναι: 1 για την κεντρική θέση και 2 για την πλευρική θέση.
processId	String	Αναγνωριστικό της επιχειρηματικής διαδικασίας που θα εμφανίζεται στη φόρμα.
processInstanceId	String	Αναγνωριστικό της παρουσίας επιχειρηματικής διαδικασίας που θα εμφανίζεται στη φόρμα.
σχέση	Αντικείμενο JSON	Υποδεικνύει ένα αντικείμενο σχέσης για την εμφάνιση των σχετικών εγγραφών στη φόρμα. Ανατρέξτε στον relationship πίνακα αντικειμένων για πληροφορίες σχετικά με τα χαρακτηριστικά.
selectStageId	String	Αναγνωριστικό του επιλεγμένου σταδίου στην παρουσία επιχειρηματικής διαδικασίας.
useQuickCreateForm	Αριθμός	Πλάτος του παραθύρου φόρμας που θα εμφανίζεται σε pixel.

relationship Χαρακτηριστικά αντικειμένων

Ο παρακάτω πίνακας περιγράφει τα χαρακτηριστικά του χαρακτηριστικού relationship αντικειμένου της entityFormOptions παραμέτρου.

Σημείωμα

Τα χαρακτηριστικά είναι προαιρετικά.

Όνομα χαρακτηριστικού	Type	Περιγραφή
attributeName	String	Όνομα του χαρακτηριστικού που χρησιμοποιείται για τη σχέση.
Όνομα	String	Όνομα της σχέσης.
πλοήγησηΙδιότητα	String	Όνομα της ιδιότητας περιήγησης για τη σχέση.
σχέσηΤύπος	Αριθμός	Τύπος σχέσης. Οι έγκυρες τιμές είναι: 0 για σχέση ένα-προς-πολλά και 1 για σχέση πολλά-προς-πολλά.
ρόλοςΤύπος	Αριθμός	Τύπος ρόλου στη σχέση. Οι έγκυρες τιμές είναι: 1 για αναφορά και 2 για AssociationEntity.

Τιμή επιστροφής

Κατά την επιτυχία, επιστρέφει ένα αντικείμενο υπόσχεσης που περιέχει συμβολοσειρά.

Παράδειγμα

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

var id = "5af02e2a-d0d1-e811-8158-000d3af97055"
var title = "Sample Case Form"
var entityFormOptions = {};
    entityFormOptions["entityName"] = "incident";
    
var formParameters = {};
    //pre-populate some fields based on the context
    formParameters["title"] = title;
    formParameters["customerid"] = id;
    formParameters["customeridtype"] = "contact";
    formParameters["caseorigincode"] = 1;
    formParameters["description"] = "Opened the form with pre-populated details like title, contact id, and description.";

//Open the form
Microsoft.CIFramework.openForm(JSON.stringify(entityFormOptions), JSON.stringify(formParameters)).then(
      function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    }
  );