Xrm.Utility (riferimento lato client)

  • Articolo

 

Data di pubblicazione: novembre 2016

Si applica a: Dynamics CRM 2015

L'oggetto Xrm.Utility fornisce un contenitore per le funzioni utili non direttamente correlate alla pagina corrente.

Queste funzionalità sono disponibili in ogni pagina dell'applicazione che supporta lo scripting. È possibile utilizzarle negli script del modulo o nei comandi della barra multifunzione. Per le risorse Web HTML, sono disponibili quando si include la pagina ClientGlobalContext.js.aspx. Per ulteriori informazioni, vedere Funzione GetGlobalContext e ClientGlobalContext.js.aspx (riferimento sul lato client).

Funzioni

  • Interazioni
    Utilizzare alertDialog e confirmDialog per visualizzare i messaggi agli utenti e impostare il codice per l'esecuzione in base alla risposta. Queste funzionalità devono essere utilizzate con Microsoft Dynamics CRM per tablet al posto dei metodi window.alert e window.confirm.

  • isActivityType
    Stabilire se un'entità è un'entità di tipo impegno.

  • openEntityForm
    Apre un modulo dell'entità.

  • openQuickCreate
    Per Aggiornamento 1 di Microsoft Dynamics CRM Online 2015 o versione successiva, utilizza questa funzione per aprire un nuovo modulo rapido di creazione. Puoi utilizzare questa funzione per impostare i valori predefiniti utilizzando i mapping di attributi o attributi specifici. Se un utente salva il record, puoi acquisire un riferimento al record creato.

  • openWebResource
    Apre una risorsa Web HTML.

Interazioni

Esistono due tipi di finestre di dialogo: alertDialog e confirmDialog. Sono inclusi per l'utilizzo con script che funzionano con Microsoft Dynamics CRM per tablet.CRM per tablet non consente l'utilizzo di funzioni JavaScript che bloccano il flusso di codice, ad esempio window.alert e window.confirm. Utilizzare questi metodi invece degli altri nel caso sia necessario visualizzare un messaggio all'utente. La differenza principale è che questi metodi non bloccheranno il codice finché un utente non li chiude. Essi contengono un parametro della funzione di richiamata per indicare quale codice eseguire in base alla risposta dell'utente.

Nota

In Microsoft Dynamics CRM per tablet l'utilizzo del metodo window.alert verrà sostituito con l'utilizzo di Xrm.Utility.alertDialog senza una richiamata. In questo modo verrà visualizzato il messaggi ma l'esecuzione del codice non verrà bloccata come con window.alert. Questo mapping di window.alert a Xrm.Utility.alertDialog in CRM per tablet è dichiarato deprecato e verrà rimosso dalla prossima versione principale. Eseguire la migrazione del codice disponibile per utilizzare Xrm.Utility.alertDialog anziché window.alert.

alertDialog

Verrà visualizzata una finestra di dialogo contenente un messaggio definito dall'applicazione.

Xrm.Utility.alertDialog(message,onCloseCallback)

  • Parametri

    Nome

    Tipo

    Obbligatorio

    Descrizione

    messaggio

    String

    Sì

    Il testo del messaggio da visualizzare nella finestra del messaggio.

    onCloseCallback

    Funzione

    No

    Una funzione da eseguire quando viene selezionato il pulsante OK.

  • Note
    Questo metodo è disponibile solo per Entità aggiornate.

confirmDialog

Viene visualizzata una finestra di dialogo di conferma che contiene un messaggio facoltativo e i pulsanti OK e Annulla.

Xrm.Utility.confirmDialog(message,yesCloseCallback,noCloseCallback)

  • Parametri

    Nome

    Tipo

    Obbligatorio

    Descrizione

    messaggio

    String

    Sì

    Il testo del messaggio da visualizzare nella finestra di dialogo

    yesCloseCallback

    Funzione

    No

    Una funzione da eseguire quando viene selezionato il pulsante OK.

    noCloseCallback

    Funzione

    No

    Una funzione da eseguire quando viene selezionato il pulsante Annulla.

  • Note
    Questo metodo è disponibile solo per Entità aggiornate.

isActivityType

Stabilire se un'entità è un'entità di tipo impegno.

Xrm.Utility.isActivityType(entityName)

  • Parametro

    Nome

    Tipo

    Obbligatorio

    Descrizione

    entityName

    String

    Sì

    logicalName di un'entità.

  • Valore restituito

    Tipo

    Descrizione

    Boolean

    True se l'entità è un'entità di impegno, altrimenti false.

openEntityForm

Apre un modulo di entità per un record di entità nuovo o esistente tramite le opzioni impostate come parametri.

Xrm.Utility.openEntityForm(name,id,parameters,windowOptions)

  • Parametri

    Nome

    Tipo

    Obbligatorio

    Descrizione

    nome

    String

    Sì

    Nome logico dell'entità.

    ID

    String

    No

    La rappresentazione di stringa di un identificatore univoco o il record da aprire nel modulo. Se non impostato, viene aperto un modulo per creare un nuovo record.

    parameters

    Oggetto

    No

    Oggetto dictionary che passa parametri aggiuntivi al modulo. I parametri non validi genereranno un errore.

    I parametri aggiuntivi della stringa di query sono:

    windowOptions

    Oggetto

    No

    Per Aggiornamento 1 di Microsoft Dynamics CRM Online 2015 o versione successiva utilizza questo parametro facoltativo nell'applicazione Web per verificare come il modulo viene aperto. Puoi scegliere di aprire un modulo in una nuova finestra passando un oggetto dictionary con una proprietà openInNewWindow booleana impostata su true.

    Questo parametro viene ignorato in CRM per telefoni e CRM per tablet.

  • Note
    Tramite questa funzione puoi assicurare che agli utenti non venga richiesto di accedere di nuovo in determinate circostanze.

  • Esempi
    Aprire un nuovo record di account utilizzando il modulo predefinito

    Xrm.Utility.openEntityForm("account");

    Aprire un record di account esistente utilizzando il modulo predefinito

    Xrm.Utility.openEntityForm("account","A85C0252-DF8B-E111-997C-00155D8A8410");

    Aprire un nuovo record di account con un modulo specifico e valori predefiniti dell'impostazione

    var parameters = {};
parameters["formid"] = "b053a39a-041a-4356-acef-ddf00182762b";
parameters["name"] = "Test";
parameters["telephone1"] = "(425) 555-1234";
Xrm.Utility.openEntityForm("account", null, parameters);

    Aprire un nuovo record di account utilizzando il modulo predefinito in una nuova finestra

    var windowOptions = {
 openInNewWindow: true
};
Xrm.Utility.openEntityForm("account",null,null,windowOptions);

openQuickCreate

Per Aggiornamento 1 di Microsoft Dynamics CRM Online 2015 o versione successiva, utilizza questa funzione per aprire un nuovo modulo rapido di creazione. Puoi utilizzare questa funzione per impostare i valori predefiniti utilizzando i mapping di attributi o attributi specifici. Se un utente salva il record, puoi acquisire un riferimento al record creato.

Xrm.Utility.openQuickCreate(entityLogicalName,createFromEntity,parameters).then(successCallback, errorCallback);

  • Parametri

    Nome

    Tipo

    Obbligatorio

    Descrizione

    entityLogicalName

    String

    Sì

    Nome logico dell'entità da creare.

    createFromEntity

    Lookup

    No

    Definisce un record che fornirà i valori predefiniti in base ai valori dell'attributo di cui è stato eseguito il mapping.

    Un oggetto ricerca dispone delle seguenti proprietà String:

    • entityType: nome logico dell'entità.

    • id: rappresentazione di stringa di un valore GUID per il record.

    • name: valore dell'attributo primario del record.

    parameters

    Oggetto

    No

    Oggetto dictionary che passa parametri di stringa di query aggiuntivi al modulo. I parametri non validi della stringa di query genereranno un errore.

    I parametri aggiuntivi della stringa di query sono:

    successCallback

    Funzione

    No

    La funzione che verrà chiamata quando un record viene creato. Questa funzione ha passato un oggetto come parametro. Questo oggetto include una proprietà savedEntityReference con le proprietà seguenti per identificare il record creato:

    • entityType: nome logico dell'entità.

    • id: rappresentazione di stringa di un valore GUID per il record.

    • name: valore dell'attributo primario del record creato.

    errorCallback

    Funzione

    No

    Una funzione per la chiamata per l'operazione non ha esito positivo.

    Verrà passato un oggetto con le proprietà seguenti:

    • errorCode: Number. il codice di errore.

    • message: String. un messaggio di errore localizzato.

  • Note
    Questa funzione è disponibile solo per Aggiornamento 1 di Microsoft Dynamics CRM Online 2015 o versione successiva.

    Nell'applicazione Web è previsto un limite di 10 moduli di creazione rapidi annidati. Se questo limite è superato la funzione apre il modulo di entità completo anziché il modulo di creazione rapida.

  • Esempio
    Quando il codice viene eseguito in un modulo dell'entità account, viene impostato un modulo di creazione rapida per creare un nuovo account figlio con un nome predefinito in modo da includere il nome dell'account padre.

    var thisAccount = {
    entityType: "account",
    id: Xrm.Page.data.entity.getId()
};
var callback = function (obj) {
    console.log("Created new " + obj.savedEntityReference.entityType + " named '" + obj.savedEntityReference.name + "' with id:" + obj.savedEntityReference.id);
}
var setName = { name: "Child account of " + Xrm.Page.getAttribute("name").getValue() };
Xrm.Utility.openQuickCreate("account", thisAccount, setName).then(callback, function (error) {
    console.log(error.message);
});

    Se il codice viene eseguito con gli strumenti per sviluppatori browser (strumenti F12) quanto segue rappresenta l'output della console se eseguito nel contesto di un account denominato "A. Datum Corporation (sample)" e l'utente non modifica il nome predefinito impostato per il nuovo account figlio.

    Created new account named 'Child account of A. Datum Corporation (sample)' with id:{1D4BFF87-E8C5-E411-80CF-00155DB58496}

openWebResource

Apre una risorsa Web HTML.

Nota

Questa funzione non funzionerà con Microsoft Dynamics CRM per tablet.

Xrm.Utility.openWebResource(webResourceName,webResourceData,width, height)

  • Parametri

    Nome

    Tipo

    Obbligatorio

    Descrizione

    webResourceName

    String

    Sì

    Nome della risorsa Web HTML da aprire.

    webResourceData

    String

    No

    Dati da passare nel parametro di dati.

    width

    Numero

    No

    Larghezza in pixel della finestra da aprire.

    height

    Numero

    No

    Altezza in pixel della finestra da aprire.

  • Valore restituito
    Oggetto della finestra.

  • Note
    Una risorsa Web HTML può accettare i valori di parametro descritti in Passare i parametri alle risorse Web HTML. Questa funzione fornisce solo il passaggio nel parametro dati facoltativo. Per passare i valori per gli altri parametri validi, è necessario aggiungerli al parametro webResourceName.

  • Esempi
    Aprire una risorsa Web HTML denominata "new_webResource.htm"

    Xrm.Utility.openWebResource("new_webResource.htm");

    Aprire una risorsa Web HTML incluso un singolo elemento di dati per il parametro dati

    Xrm.Utility.openWebResource("new_webResource.htm","dataItemValue");

    Aprire una risorsa Web HTML passando più valori tramite il parametro dati

    var customParameters = encodeURIComponent("first=First Value&second=Second Value&third=Third Value");
Xrm.Utility.openWebResource("new_webResource.htm",customParameters);

    Nota

    Tali valori devono essere estratti dal valore del parametro di dati nella risorsa Web HTML. Per ulteriori informazioni, vedere Esempio: passare più valori a una risorsa Web tramite il parametro dati

    Aprire una risorsa Web HTML con i parametri previsti dalla risorsa Web HTML

    Xrm.Utility.openWebResource("new_webResource.htm?typename=account&userlcid=1033");

    Per ulteriori informazioni, vedere Passare i parametri alle risorse Web HTML.

    Aprire una risorsa Web HTML, impostando l'altezza e la larghezza

    Xrm.Utility.openWebResource("new_webResource.htm", null, 300,300);

Vedere anche

Riferimento programmazione sul lato client
Aprire moduli, visualizzazioni, interazioni e report con un URL
Impostare i valori del campo utilizzando parametri passati a un modulo
Configurare un modulo in modo che accetti i parametri querystring personalizzati
Riferimento rapido dello scripting dei moduli
Creare il codice per moduli di Microsoft Dynamics CRM 2015
Utilizzare il modello a oggetti Xrm.Page

© 2017 Microsoft. Tutti i diritti sono riservati. Copyright