navigateTo (asiakkaan ohjelmointirajapinnan viittaus)

Siirtyy määritettyyn taulukkoluetteloon, taulukkotietueisiin, HTML-verkkoresurssiin tai mukautettuun sivuun.

Huomautus

Tätä menetelmää tuetaan vain Unified Interfacessa.

Syntaksi

Seuraavan syntaksin avulla voit kutsua -syntaksia Xrm.Navigation.navigateTo().

Xrm.Navigation.navigateTo(pageInput,navigationOptions).then(successCallback,errorCallback);

Parametrit

-menetelmä hyväksyy seuraavat parametrit.

Nimi Tyyppi Tarvitaan Kuvaus
pageInput Objekti Kyllä Syöte siitä sivusta, johon haluat siirtyä. Katso pageInput-parametri
navigationOptions Objekti Ei Sivulla siirtymisen asetukset: avataanko tekstiin vai valintaikkunaan. Jos et määritä tätä parametria, -menetelmä avaa sivun oletusarvoisesti sisäisesti.
successCallback funktio Ei Funktio, joka suoritetaan onnistuneen sisäisen siirtymisen tai valintaikkunan sulkemisen jälkeen. Sivutyypeissä, jotka tukevat arvon palauttamista, funktio vastaanottaa kyseisen arvon argumenttinaan.
errorCallback Toiminto Ei Toiminto, joka suoritetaan, kun toiminto epäonnistuu.

pageInput parametri

Objektin määritys muuttuu sen mukaan, millaiseen sivuun siirrytään: entiteettiluettelo, entiteettitietue, koontinäyttö, HTML-verkkoresurssi, mukautettu sivu tai muodostava sivu.

Entiteettiluettelo

Entiteettiluettelo-objekti sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
pageType Merkkijono Määritä entitylist.
entityName Merkkijono Luettelo-ohjausobjektiin ladattavan taulukon looginen nimi.
viewId Merkkijono (Valinnainen) Ladattavan näkymän tunnus. Jos et määritä sitä, sovellus siirtyy taulukon oletuspäänäkymään.
viewType Merkkijono (Valinnainen) Ladattavan näkymän tyyppi. Määritä savedquery tai userquery.

Entiteettitietue

Entiteettitietueobjekti sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
pageType Merkkijono Määritä entityrecord.
entityName Merkkijono Sen taulukon looginen nimi, jonka lomakkeen näyttää.
entityId Merkkijono (Valinnainen) Sen taulukkotietueen tunnus, jonka lomakkeet näytetään. Jos et määritä tätä arvoa, lomake avautuu luontitilassa.
createFromEntity Haku (Valinnainen) Määrittää tietueen, joka tarjoaa oletusarvoja yhdistettyjen sarakearvojen perusteella. Hakuobjektilla on seuraavat Merkkijono-ominaisuudet: entityType, id ja name (valinnainen).
data Objekti (Valinnainen) Sanasto-objekti, joka välittää lomakkeeseen ylimääräisiä parametreja.

Parametrit voivat olla taulukon sarakkeita, joissa on oletusarvoja, jotka on määritetty uusille lomakkeille (katso Sarakearvojen määrittäminen lomakkeeseen välitettävien parametrien avullaformContext.data.attributes) tai mukautettuja parametreja, joita käyttämällä voidaan käyttää lomakkeessa (katso Lomakkeen määrittäminen hyväksymään mukautettuja kyselymerkkijonon parametreja ja formContext.data). Virheelliset parametrit aiheuttavat virheen.

formId Merkkijono (Valinnainen) Näytettävän lomakeesiintymän tunnus.
isCrossEntityNavigate totuusarvo (Valinnainen) Ilmaisee, siirtyykö lomake eri taulukosta taulukoiden välisen liiketoimintaprosessin työnkulun avulla.
isOfflineSyncError totuusarvo (Valinnainen) Ilmaisee, onko offline-synkronoinnissa virheitä.
processId Merkkijono (Valinnainen) Lomakkeessa näytettävän liiketoimintaprosessin tunnus.
processInstanceId Merkkijono (Valinnainen) Lomakkeessa näytettävän liiketoimintaprosessin esiintymän tunnus.
relationship Objekti (Valinnainen) Määritä suhdeobjekti näyttämään liittyvät tietueet lomakkeessa. Katso suhde.
selectedStageId Merkkijono (Valinnainen) Liiketoimintaprosessin esiintymän valitun vaiheen tunnus.
tabName Merkkijono (Valinnainen) Määrittää kohdistuksen lomakkeen välilehdessä.

Lue, miten voit avata päälomakkeen valintaikkunassa asiakkaan ohjelmointirajapinnan avulla

Suhdeobjekti

Entiteettitietueessa käytettävä suhdeobjekti sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
attributeName Merkkijono Suhteessa käytetyn sarakkeen nimi.
name Merkkijono Suhteen nimi.
navigationPropertyName Merkkijono Tämän suhteen siirtymisominaisuuden nimi.
relationshipType Numero Suhteen tyyppi. Määritä jokin seuraavista arvoista: 0:OneToMany, 1:ManyToMany.
roleType Numero Roolityyppi suhteessa. Määritä jokin seuraavista arvoista: 1:Referencing, 2:AssociationEntity.

Dashboard

Käytä tätä objektia pageInput parametrina, kun haluat avata koontinäytön.

Koontinäyttö-objekti sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
pageType Merkkijono Määritä dashboard.
dashboardId Merkkijono Ladattavan koontinäytön tunnus. Jos et määritä tunnusta, sovellus siirtyy oletuskoontinäyttöön.

HTML-verkkoresurssi

Käytä tätä objektia pageInput parametrina, kun haluat avata HTML-verkkoresurssin.

HTML-verkkoresurssiobjekti sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
pageType Merkkijono Määritä webresource.
webresourceName Merkkijono Ladattavan verkkoresurssin nimi.
data Merkkijono (Valinnainen) Verkkoresurssiin siirrettävät tiedot.

Mukautettu sivu

Käytä tätä objektia pageInput parametrina, kun haluat avata mukautetun sivun.

Mukautettu sivu -objekti sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
pageType Merkkijono Määritä custom.
name Merkkijono Avattavan mukautetun sivun looginen nimi.
entityName Merkkijono (Valinnainen) Mukautetulla sivulla käytettäväksi käytettävän taulukon looginen nimi :n kautta Param("entityName").
recordId Merkkijono (Valinnainen) Sen taulukkotietueen tunnus, joka tulee saataville mukautetulle sivulle :n kautta Param("recordId").

Luotu sivu

Käytä tätä objektia pageInput parametrina, kun haluat avata muodostavan sivun.

Jotta voit käyttää recordId-, entityName- tai data-kohteita, syöteparametrien hyväksyminen edellyttää, että kohdesivu on määritetty.

Luotu sivu-objekti sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
pageType Merkkijono Määritä generative.
pageId Merkkijono Avattavan generative-sivun tunnus.
recordId Merkkijono (Valinnainen) Sivulle välitettavan tietueen GUID-tunnus.
entityName Merkkijono (Valinnainen) Dataverse-taulukon looginen nimi, joka vastaa :a recordId.
data Objekti (Valinnainen) JSON-objekti, joka sisältää ylimääräisiä mukautettuja parametreja välitettäväksi sivulle.

Katso esimerkkejä siitä, miten voit siirtyä luontisivulle ja sieltä asiakkaan ohjelmointirajapinnan avulla

Objekti navigationOptions sisältää seuraavat arvot.

Nimi Tyyppi Kuvaus
target Numero Määritä 1 , jos haluat avata sivun sisäisesti. Määritä 2 sivun avaamiseksi valintaikkunassa.
Lisäksi muut arvot (leveys, korkeus ja sijainti) ovat kelvollisia vain, jos määrität 2 tämän arvon (avaa sivu valintaikkunassa).
Huomautus: Voit avata vain tekstiin sidotut entiteettiluettelot. Voit avata entiteettitietueita, verkkoresursseja ja luovia sivuja joko sisäisessä tai valintaikkunassa.
width Luku tai objekti (Valinnainen) Valintaikkunan leveys. Jos haluat määrittää leveyden kuvapisteinä, kirjoita numeerinen arvo. Jos haluat määrittää leveyden prosenttilukuna, määritä SizeValue-tyyppinen objekti käyttäen seuraavia ominaisuuksia:
- value: Luku-tyyppinen numeerinen arvo.
- unit: Merkkijono-tyypin mittausyksikkö. Määritä % tai px. Oletusarvo on px.
height Luku tai objekti (Valinnainen) Valintaikkunan korkeus. Jos haluat määrittää korkeuden kuvapisteinä, kirjoita numeerinen arvo. Jos haluat määrittää leveyden prosenttilukuna, määritä SizeValue-tyyppinen objekti käyttäen seuraavia ominaisuuksia:
- value: Tyyppiä Number oleva numeerinen arvo.
- unit: Merkkijono-tyypin mittausyksikkö. Määritä % tai px. Oletusarvo on px.
position Numero (Valinnainen) Määritä 1 avaamaan valintaikkuna keskellä; 2 avaa valintaikkuna toisella puolella. Oletus on 1 (keskellä).
title Merkkijono (Valinnainen) Valintaikkunan otsikko keskimmäisen tai sivuvalintaikkunan yläosassa.

Palautusarvo

Palauttaa lupauksen. Kun lupaus korjataan, välitetty arvo riippuu kohde- ja sivutyypistä:

  • Sisäinen: Lupaus ratkeaa, kun siirtyminen on valmis, eikä se palauta arvoa.
  • Dialogi: Lupaus ratkeaa, kun valintaikkuna sulkeutuu.
    • Luo-tilassa avatun entiteettitietueen lupaus ratkaistaan matriisin sisältävällä objektilla savedEntityReference .
    • Generatiivisen sivun kohdalla lupaus ratkaistaan objektilla, jonka -ominaisuus sisältää arvon, joka returnValue viimeksi välitettiin kohteeseen dataApi.setPageOutput(value). Jos luontisivu ei määritä tulostearvoa, valintaikkunan sulkeminen valitsemalla Peruuta tai sulje-painike tuottaa määrittämättömän returnValuearvon .
    • Muut sivutyypit eivät palauta arvoa, kun valintaikkuna sulkeutuu.

Entiteettitietueelle savedEntityReference palautettu matriisi sisältää seuraavat ominaisuudet:

  • entityType: Taulukon looginen nimi.
  • id: Tietueen GUID-tunnuksen merkkijonoesitys.
  • name: Tietueen ensisijainen sarakearvo.

Esimerkkejä

Seuraavissa esimerkeissä esitellään siirtyminen eri sivutyyppeihin sisäisesti ja valintaikkunassa.

Esimerkki Osoittaa
Avaa tililuettelo Päätililuettelon avaaminen sisäisesti.
Avaa aiemmin luotu tilitietue valintaikkunassa Aiemmin luodun tilitietueen avaaminen keskitettyyn valintaikkunaan määritetyllä korkeudella ja leveydellä.
Avaa tililomake luontitilassa valintaikkunassa Tililomakkeen avaaminen valintaikkunan luontitilassa ja tallennetun tietueen tunnuksen ja nimen käyttäminen.
HTML-verkkoresurssin avaaminen valintaikkunassa HTML-verkkoresurssin avaaminen valintaikkunassa, jossa dimensiot on määritetty kuvapisteinä.
Avaa dialogissa generatiivinen sivu, joka sisältää syöteparametrit Tietuekontekstin ja mukautettujen parametrien välittäminen muodostavan sivun valintaikkunaan ja sen palautusarvon lukeminen.

Avaa esimerkki tililuettelosta

Avaa sisäisen päätililuettelon.

var pageInput = {
    pageType: "entitylist",
    entityName: "account"
};
Xrm.Navigation.navigateTo(pageInput).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Avaa olemassa oleva tilitietue valintaikkunassa esimerkki

Avaa aiemmin luodun tililomakkeen valintaikkunassa.

var pageInput = {
    pageType: "entityrecord",
    entityName: "account",
    entityId: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee" //replace with actual ID
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit:"%"},
    width: {value: 70, unit:"%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Lue, miten voit avata päälomakkeen valintaikkunassa asiakkaan ohjelmointirajapinnan avulla

Avaa tililomake luontitilassa valintaikkunassa esimerkki

Avaa tililomakkeen luontitilassa valintaikkunassa ja palauttaa luodun tietueviittauksen tallennuksen yhteydessä.

var pageInput = {
    pageType: "entityrecord",
    entityName: "account"    
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit:"%"},
    width: {value: 70, unit:"%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success(result) {
            console.log("Record created with ID: " + result.savedEntityReference[0].id + 
            " Name: " + result.savedEntityReference[0].name)
            // Handle dialog closed
    },
    function error() {
            // Handle errors
    }
);

Lue, miten voit avata päälomakkeen valintaikkunassa asiakkaan ohjelmointirajapinnan avulla

HTML-verkkoresurssin avaaminen valintaikkunassa

Avaa HTML-verkkoresurssin valintaikkunassa.

var pageInput = {
    pageType: "webresource",
    webresourceName: "new_sample_webresource.htm"
};
var navigationOptions = {
    target: 2,
    width: 500, // value specified in pixel
    height: 400, // value specified in pixel
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success() {
            // Run code on success
    },
    function error() {
            // Handle errors
    }
);

Avaa dialogin esimerkissä generatiivinen sivu, joka sisältää syöteparametrit

Avaa muodostavan sivun keskitettynä valintaikkunana ja välittää tietuetunnuksen, entiteetin nimen ja mukautetut tietoparametrit. Luotu sivu on määritettävä hyväksymään nämä parametrit.

var pageInput = {
    pageType: "generative",
    pageId: "<genPageID>", // replace with the ID of your generative page
    recordId: "00aa00aa-bb11-cc22-dd33-44ee44ee44ee", // replace with actual record GUID
    entityName: "account",
    data: { status: "active", category: "premium" }
};
var navigationOptions = {
    target: 2,
    height: {value: 80, unit: "%"},
    width: {value: 70, unit: "%"},
    position: 1
};
Xrm.Navigation.navigateTo(pageInput, navigationOptions).then(
    function success(result) {
        const output = result?.returnValue;
        if (output) {
            console.log("Value returned by generative page:", output);
        }
    },
    function error(error) {
        console.log(error.message);
    }
);

Xrm.Navigation
Siirry luontisivulle ja sieltä pois
Mukautettuun sivuun siirtyminen (esikatselu)