openForm (Referenční dokumentace rozhraní JavaScript API) pro Dynamics 365 Channel Integration Framework 1.0

Otevře formulář entity nebo formulář pro rychlé vytvoření.

Syntaxe

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

Parametry

Název	Typ	Povinné	Description
entityFormOptions	Objekt JSON	Ano	Možnosti formuláře entity pro otevření formuláře. Objekt obsahuje následující atributy: - cmdbar - createFromEntity - ID entity - název_entity - ID formuláře -výška - navBar - openInNewWindow - windowPosition - identifikátor procesu - ID instance procesu -vztah - vyberte ID Plochy - useQuickCreateForm -šířka Informace o atributech naleznete v entityFormOptions tabulce objektů .
parametry formuláře	Object	Ne	Objekt slovníku, který do formuláře předává další parametry. Neplatné parametry způsobí chybu. Informace o předávání parametrů do formuláře naleznete v tématech Nastavení hodnot polí pomocí parametrů předaných do formuláře a Konfigurace formuláře pro příjem vlastních parametrů řetězce dotazu.
úspěchZpětné volání	Funkce	Ne	Funkce, která se má spustit po úspěšném provedení operace.
errorCallback	Funkce	Ne	Funkce, která se má provést, když se operace nezdaří.

entityFormOptions atributy objektu

Následující tabulka popisuje atributy parametru entityFormOptions .

Poznámka:

Atributy jsou volitelné.

Název atributu	Typ	Description
cmdBar	logický	Označuje, zda se má zobrazit panel příkazů. Pokud tento parametr neurčíte, zobrazí se ve výchozím nastavení panel příkazů.
createFromEntity	Vyhledávání	Označuje záznam, který poskytne výchozí hodnoty na základě mapovaných hodnot atributů. Vyhledávací objekt má následující vlastnosti typu String: entityType, , ida name (volitelné).
entityId	String	Identifikátor záznamu entity, pro který se má formulář zobrazit.
entityName	String	Logický název entity, pro kterou se má formulář zobrazit.
formId	String	Identifikátor instance formuláře, která má být zobrazena.
výška	Number	Výška okna formuláře, které má být zobrazeno v pixelech.
navBar	String	Určuje, zda je navigační panel zobrazen a zda je navigace v aplikaci dostupná pomocí oblastí a podoblastí definovaných v mapě webu. Platné hodnoty jsou: on: Zobrazí se navigační panel. Toto je výchozí chování, pokud navBar se parametr nepoužívá. off: Navigační panel se nezobrazuje. Uživatel může procházet pomocí jiných prvků uživatelského rozhraní nebo tlačítek zpět a vpřed. entity: Ve formuláři entity jsou k dispozici pouze možnosti navigace pro související entity. Po přechodu na související entitu se na navigačním panelu zobrazí tlačítko Zpět, které umožňuje návrat k původnímu záznamu.
openInNewWindow	logický	Označuje, zda se má formulář zobrazit v novém okně.
Pozice okna	Number	Označuje pozici formuláře v okně. Platné hodnoty jsou: 1 pro pozici středu a 2 pro polohu na boku.
ID procesu	String	Identifikátor obchodního procesu, který má být zobrazen ve formuláři.
ID instance procesu	String	Identifikátor instance obchodního procesu, který má být zobrazen ve formuláři.
relace	Objekt JSON	Označuje objekt vztahu pro zobrazení souvisejících záznamů ve formuláři. Informace o atributech naleznete v relationship tabulce objektů .
selectStageId	String	Identifikátor vybrané fáze v instanci obchodního procesu.
useQuickCreateForm	Number	Šířka okna formuláře, které má být zobrazeno v pixelech.

relationship atributy objektu

Následující tabulka popisuje atributy atributu relationship object parametru entityFormOptions .

Poznámka:

Atributy jsou volitelné.

Název atributu	Typ	Description
Název_atributu	String	Název atributu použitého pro relaci.
název	String	Název vztahu.
navigationProperty	String	Název navigační vlastnosti relace.
Typ relace	Number	Typ vztahu. Platné hodnoty jsou: 0 pro vztah 1:N a 1 pro vztah N:N.
Typ role	Number	Typ role ve vztahu. Platné hodnoty jsou: 1 for referencing a 2 for AssociationEntity.

Návratová hodnota

Při úspěchu vrátí objekt Promise obsahující řetězec.

Example

Následující ukázkový kód otevře nový formulář incidentu s předem vyplněnými hodnotami pro určitá pole, jako je ID kontaktu a popis.

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);
    }
  );