Delen via


openForm (JavaScript API-referentie) voor Dynamics 365 Channel Integration Framework 1.0

Hiermee opent u een entiteitsformulier of een formulier voor snelle invoer.

Syntaxis

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

Parameterwaarden

Naam Typologie Verplicht Description
entityFormOptions JSON-object Yes Opties voor entiteitsformulier voor het openen van het formulier. Het object bevat de volgende kenmerken:
- cmdbar
- createFromEntity
- entityId
- entiteitNaam
- formulier
-hoogte
- navigatiebalk
- openInNewWindow
- windowPositie
- proces-ID
- processInstanceId
-verwantschap
- selecteerStageId
- gebruik QuickCreateForm
-Breedte
Zie de entityFormOptions objecttabel voor informatie over de attributen.
formParameters Object Nee. Een woordenboekobject dat extra parameters doorgeeft aan het formulier. Ongeldige parameters veroorzaken een fout.
Zie Veldwaarden instellen op basis van parameters die aan een formulier worden doorgegeven en Een formulier configureren voor het accepteren van aangepaste querystringparameters voor informatie over het doorgeven van parameters aan een formulier.
succesTerugbellen Functie Nee. Een functie die moet worden uitgevoerd wanneer de bewerking slaagt.
foutCallback Functie Nee. Een functie die moet worden uitgevoerd wanneer de bewerking mislukt.

entityFormOptions Object attributen

In de volgende tabel worden de kenmerken van de entityFormOptions parameter beschreven.

Opmerking

De attributen zijn optioneel.

Naam van kenmerk Typologie Description
cmdBar Booleaan Geeft aan of de opdrachtbalk moet worden weergegeven. Als u deze parameter niet opgeeft, wordt de opdrachtbalk standaard weergegeven.
createFromEntity Lookup Geeft een record aan die standaardwaarden bevat op basis van toegewezen kenmerkwaarden. Het opzoekobject heeft de volgende eigenschappen van het type Tekenreeks: entityType, id, en name (optioneel).
entityId String Identificatie van het entiteitsrecord waarvoor het formulier moet worden weergegeven.
entityName String Logische naam van de entiteit waarvoor het formulier moet worden weergegeven.
formId String Identificatie van de formulierinstantie die moet worden weergegeven.
height Number Hoogte van het formuliervenster dat in pixels moet worden weergegeven.
navigatiebalk String Hiermee bepaalt u of de navigatiebalk wordt weergegeven en of toepassingsnavigatie beschikbaar is met behulp van de gebieden en subgebieden die in het siteoverzicht zijn gedefinieerd. Geldige waarden zijn:
on: De navigatiebalk wordt weergegeven. Dit is het standaardgedrag als de navBar parameter niet wordt gebruikt.
off: De navigatiebalk wordt niet weergegeven. De gebruiker kan navigeren met behulp van andere elementen van de gebruikersinterface of de knoppen Terug en Vooruit.
entity: Op een entiteitsformulier zijn alleen de navigatieopties voor gerelateerde entiteiten beschikbaar. Nadat u naar een verwante entiteit bent genavigeerd, wordt een terugknop weergegeven op de navigatiebalk om terug te keren naar de oorspronkelijke record.
openInNieuw venster Booleaan Geeft aan of het formulier in een nieuw venster moet worden weergegeven.
vensterPositie Number Geeft de positie van het formulier op het venster aan. Geldige waarden zijn: 1 voor middenpositie en 2 voor zijpositie.
proces Id String ID van het bedrijfsproces dat op het formulier moet worden weergegeven.
procesInstanceId String Id van de instantie van het bedrijfsproces die op het formulier moet worden weergegeven.
verwantschap JSON-object Geeft een relatieobject aan om de gerelateerde records op het formulier weer te geven. Zie de relationship objecttabel voor informatie over de attributen.
selecteerStageId String Identificatie van de geselecteerde fase in het bedrijfsproces.
gebruik QuickCreateForm Number Breedte van het formuliervenster dat in pixels moet worden weergegeven.

relationship Object attributen

In de volgende tabel worden de kenmerken van het relationship objectkenmerk van de entityFormOptions parameter beschreven.

Opmerking

De attributen zijn optioneel.

Naam van kenmerk Typologie Description
attribuutNaam String Naam van het kenmerk dat wordt gebruikt voor relatie.
naam String Naam van de relatie.
navigatieEigenschap String Naam van de navigatie-eigenschap voor de relatie.
relatieType Number Type relatie. Geldige waarden zijn: 0 voor één-op-veel relatie en 1 voor veel-op-veel relatie.
rolType Number Roltype in de relatie. Geldige waarden zijn: 1 voor referencing en 2 voor AssociationEntity.

Retourwaarde

Als dit lukt, wordt een Promise-object geretourneerd dat een tekenreeks bevat.

Example

Met de volgende voorbeeldcode wordt een nieuw incidentformulier geopend met vooraf ingevulde waarden voor bepaalde velden, zoals contactpersoon-id en beschrijving.

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