openForm (JavaScript API-referanse) for Dynamics 365 Channel Integration Framework 1.0

Åpner et enhetsskjema eller et hurtigopprettingsskjema.

Syntax

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

Parameters

Navn	Type	Kreves	Bekrivelse
entityFormOptions	JSON-objekt	Ja	Alternativer for enhetsskjema for åpning av skjemaet. Objektet inneholder følgende attributter: - cmdbar - createFromEntity - entityId - entityName - formId -høyde - navBar - openInNewWindow - vinduPosisjon - prosessId - prosessInstansId -forhold - plukke utStageId - brukQuickCreateForm -bredde Se entityFormOptions objekttabellen for informasjon om attributtene.
formParametere	Objekt	Nei	Et ordlisteobjekt som sender ekstra parametere til skjemaet. Ugyldige parametere vil forårsake en feil. Hvis du vil ha informasjon om hvordan du sender parametere til et skjema, kan du se Angi feltverdier ved hjelp av parametere som sendes til et skjema , og Konfigurere et skjema til å godta egendefinerte spørringsstrengparametere.
suksessTilbakeringing	Function	Nei	En funksjon som skal utføres når operasjonen er vellykket.
feilTilbakeringing	Function	Nei	En funksjon som skal utføres når operasjonen mislykkes.

entityFormOptions Attributter for objekt

Tabellen nedenfor beskriver attributtene til parameteren entityFormOptions .

Note

Attributtene er valgfrie.

Attributtnavn	Type	Bekrivelse
cmdBar	boolsk	Angir om kommandolinjen skal vises. Hvis du ikke angir denne parameteren, vises kommandolinjen som standard.
createFromEntity	Oppslag	Angir en post som vil gi standardverdier basert på tilordnede attributtverdier. Oppslagsobjektet har følgende egenskaper av typen String: entityType, id, og name (valgfritt).
entityId	String	Identifikator for enhetsoppføringen som skjemaet skal vises for.
entityName	String	Logisk navn på enheten som skjemaet skal vises for.
formId	String	Identifikator for skjemaforekomsten som skal vises.
høyde	Tall	Høyden på skjemavinduet som skal vises i piksler.
navBar	String	Kontrollerer om navigasjonsfeltet vises, og om programnavigasjon er tilgjengelig ved hjelp av områdene og underområdene som er definert i områdekartet. Gyldige verdier er: on: Navigasjonslinjen vises. Dette er standard virkemåte hvis parameteren navBar ikke brukes. off: Navigasjonslinjen vises ikke. Brukeren kan navigere ved hjelp av andre elementer i brukergrensesnittet eller tilbake- og foroverknappene. entity: I et enhetsskjema er bare navigasjonsalternativene for relaterte enheter tilgjengelige. Når du har navigert til en relatert enhet, vises en tilbakeknapp i navigasjonsfeltet for å tillate retur til den opprinnelige oppføringen.
openInNewWindow	boolsk	Angir om skjemaet skal vises i et nytt vindu.
vinduPosisjon	Tall	Angir plasseringen av skjemaet i vinduet. Gyldige verdier er: 1 for senterposisjon og 2 for sideposisjon.
prosessId	String	Identifikator for forretningsprosessen som skal vises i skjemaet.
prosessInstansId	String	Identifikator for forretningsprosessforekomsten som skal vises i skjemaet.
relasjon	JSON-objekt	Angir et relasjonsobjekt for å vise de relaterte postene i skjemaet. Se relationship objekttabellen for informasjon om attributtene.
plukke utStageId	String	Identifikator for den valgte fasen i forretningsprosessforekomsten.
brukQuickCreateForm	Tall	Bredden på skjemavinduet som skal vises i piksler.

relationship Attributter for objekt

Tabellen nedenfor beskriver attributtene til objektattributtet relationship for parameteren entityFormOptions .

Note

Attributtene er valgfrie.

Attributtnavn	Type	Bekrivelse
attributtNavn	String	Navnet på attributtet som brukes for relasjon.
navn	String	Navnet på relasjonen.
navigasjonEgenskap	String	Navnet på navigasjonsegenskapen for relasjonen.
relasjonstype	Tall	Relasjonstype. Gyldige verdier er: 0 for én-til-mange-relasjon og 1 for mange-til-mange-relasjon.
rolletype	Tall	Rolletype i relasjonen. Gyldige verdier er: 1 for referanse og 2 for AssociationEntity.

Returverdi

Ved vellykket returnerer et Promise-objekt som inneholder streng.

Eksempel

Følgende eksempelkode åpner et nytt hendelsesskjema med forhåndsutfylte verdier for bestemte felt, for eksempel kontakt-ID og beskrivelse.

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