openForm (JavaScript API-Referenz) für Dynamics 365-Kanalintegrationsframework 1.0
Öffnet ein Entitätsformular oder ein Schnellerfassungsformular.
Syntax
Microsoft.CIFramework.openForm(entityFormOptions,formParameters).then(successCallback,errorCallback);
Parameter
Name des Dataflows | Typ | Erforderlich | Beschreibung |
---|---|---|---|
entityFormOptions | JSON-Objekt | Ja | Entitätsformularoptionen für das Öffnen des Formulars. Das Objekt hat die folgenden Attribute: - cmdbar - createFromEntity - entityId - entityName - formId - Höhe - navBar - openInNewWindow - windowPosition - processId - processInstanceId - relationship - selectStageId - useQuickCreateForm - width Siehe entityFormOptions Objekttabelle für weitere Informationen zu den Attributen. |
formParameters | Objekt | Nein | Ein Wörterbuchobjekt, das dem Formular zusätzliche Parameter übergibt. Ungültige Parameter führen zu einem Fehler. Informationen zum Übergeben von Parametern an ein Formular finden Sie unter Festlegen von Feldwerten mithilfe von Parametern, die an ein Formular übergeben werden und Ein Formular konfigurieren, um benutzerdefinierte Abfragezeichenfolgenparameter zu akzeptieren. |
successCallback | Funktion | Nein | Eine auszuführende Funktion, wenn der Vorgang erfolgreich war. |
errorCallback | Funktion | Nein | Eine auszuführende Funktion, wenn der Vorgang fehlgeschlagen ist. |
entityFormOptions
object attributes
In der folgenden Tabelle werden die Attribute des entityFormOptions
-Parameters beschrieben.
Anmerkung
Die Attribute sind optional.
Attributename | Typ | Beschreibung |
---|---|---|
cmdBar | Boolesch | Gibt an, ob die Befehlsleiste angezeigt werden soll. Wird dieser Wert nicht angegeben, wird standardmäßig die Befehlsleiste angezeigt. |
createFromEntity | Nachschlagefeld | Gibt einen Datensatz an, der Standardwerte basierend auf zugeordneten Attributwerten bereitstellt. Das Suchobjekt hat folgende Zeichenfolgeneigenschaften: entityType , id und name (optional). |
entityId | Zeichenfolge | Bezeicher des Entitätsdatensatzes, für den das Formular angezeigt wird. |
entityName | Zeichenfolge | Die ID des Entitätsdatensatzes, für den das Formular angezeigt wird. |
formId | Zeichenfolge | Bezeichner der anzuzeigenden Formularinstanz. |
Höhe | Zahl | Die Höhe des zu öffnenden Formulars in Pixeln. |
navBar | Zeichenfolge | Steuert, ob die Navigationsleiste angezeigt wird und ob Anwendungsnavigation über die in der Siteübersicht definierten Bereiche und Unterbereiche verfügbar ist. Gültige Werte sind: on : Die Navigationsleiste wird angezeigt. Dies ist das Standardverhalten, wenn der Parameter navBar nicht verwendet wird. off : Die Navigationsleiste wird nicht angezeigt. Die Benutzer können andere Benutzeroberflächenelemente oder die Schaltflächen Zurück und Weiter für die Navigation verwenden. entity : In einem Entitätsformular sind nur die Navigationsoptionen für verknüpfte Entitäten verfügbar. Nach der Navigation zu einer verknüpften Entität wird die Schaltfläche Zurück in der Navigationsleiste angezeigt, mit der Sie zum ursprünglichen Datensatz zurückkehren können. |
openInNewWindow | Boolesch | Gibt an, ob das Formular in einem neuen Fenster angezeigt wird. |
windowPosition | Zahl | Gibt die Position des Formulars im Fenster an. Gültige Werte sind: 1 für die Mittelposition und 2 für die Seitenposition. |
processId | Zeichenfolge | Bezeichner des im Formular anzuzeigenden Geschäftsprozesses. |
processInstanceId | Zeichenfolge | Bezeichner der im Formular anzuzeigenden Geschäftsprozessinstanz. |
Beziehung | JSON-Objekt | Bezeichner eines Beziehungsobjekts, um die zugehörigen Datensätze im Formular anzuzeigen. Siehe relationship Objekttabelle für weitere Informationen zu den Attributen. |
selectStageId | Zeichenfolge | Bezeichner der ausgewählten Phase in der Geschäftsprozessinstanz. |
useQuickCreateForm | Zahl | Die Breite des zu öffnenden Formulars in Pixeln. |
relationship
object attributes
In der folgenden Tabelle werden die Attribute des relationship
vom entityFormOptions
-Parameters beschrieben.
Anmerkung
Die Attribute sind optional.
Attributename | Typ | Beschreibung |
---|---|---|
attributeName | Zeichenfolge | Der Name des für die Beziehung verwendeten Attributs. |
name | Zeichenfolge | Name der Beziehung. |
NavigationProperty | Zeichenfolge | Name der Navigationseigenschaft für die Beziehung. |
relationshipType | Zahl | Beziehungstyp. Gültige Werte sind: 0 für eine Eins-zu-viele-Beziehung und 1 für eine Viele-zu-viele-Beziehung. |
roleType | Zahl | Der Rollentpy der Beziehung. Gültige Werte sind: 1 für die Referenz und 2 für AssociationEntity. |
Zurückgegebener Wert
Gibt bei Erfolg ein Promise-Objekt zurück, das eine Zeichenkette enthält.
Beispiel
Der folgende Beispielcode öffnet ein neues Ereignisformular mit vorbelegten Werten für bestimmte Felder wie Kontakt-ID und Beschreibung.
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);
}
);