Einführung in die Durchführung weltweiter Geschäftsaktivitäten mit dem Client-API-Xrm-Objekt

8 Minuten

Die Client-API stellt ein Xrm-Objekt zur Verfügung, das global in Ihrem Code zum Ausführen einer Vielzahl von Aktivitäten verwendet werden kann, ohne einen Ausführungskontext zu verwenden. Das folgende Diagramm zeigt die verfügbaren Eigenschaften und Methoden auf hoher Ebene. Eine detaillierte Übersicht über dieses Objekt finden Sie unter Client-API-Xrm-Objekt.

App-Objekt

Mit addGlobalNotification aus dem App-Objekt können Sie Fehler‑, Informations‑, Warn‑ oder Erfolgsbenachrichtigungen für eine App anzeigen und Aktionen festlegen, die basierend auf der Benachrichtigung ausgeführt werden sollen. Diese Benachrichtigung ähnelt Formularbenachrichtigungen, kann jedoch außerhalb des Kontexts eines Formulars genutzt werden. Zum Beispiel könnte ein Befehlsleistenskript dies verwenden, um einen Benutzer über eine abgeschlossene Aktion zu benachrichtigen. Verwenden Sie die clearGlobalNotification-Methode, um eine Benachrichtigung in der App zu löschen.

Geräteobjekt

Das Objekt „Xrm.Device“ macht native Gerätefunktionen verfügbar, die sich auf Interaktionen mit Mobilgeräten beziehen, mit Ausnahme der Methode „pickFile“, die auch über Webclients verfügbar ist. Canvas-Apps bieten auch ein erweiterbares Framework für die mobile Entwicklung und sollten in diesen Szenarien ebenfalls berücksichtigt werden. Die folgende Tabelle ist eine Zusammenfassung der Methoden, die im Objekt „Xrm.Device“ verfügbar sind.

Methode	Beschreibung
captureAudio	Ruft das Gerätemikrofon zur Audioaufnahme auf.
captureImage	Ruft die Gerätekamera auf, um ein Bild aufzunehmen.
captureVideo	Ruft die Gerätekamera zur Videoaufnahme auf.
getBarcodeValue	Ruft die Gerätekamera auf, um die Barcode-Informationen zu scannen, z. B. eine Produktnummer.
getCurrentPosition	Gibt den aktuellen Standort mithilfe der Geolocation-Funktion des Geräts zurück.
pickFile	Öffnet ein Dialogfeld zum Auswählen von Dateien von Ihrem Computer (Webclient) oder Mobilgerät (mobile Clients).

Je nach Gerätekonfiguration stehen einige Funktionen nicht zur Verfügung. Möglicherweise wird auch die Benutzereinwilligung benötigt, damit die App Zugriff auf bestimmte Gerätefunktionen hat. Der Benutzer hat zum Beispiel die Funktionen zur Geräteortung global deaktiviert oder der Zugriff auf die App-Kamera wird verweigert. Bedenken Sie bei der Entwicklung einer App, dass eine dieser Methoden aufgrund der Gerätefunktionen, Konfiguration, fehlenden Berechtigungen oder Zustimmung fehlschlagen kann.

Objekt codieren

Das Objekt „Xrm.Encoding“ wird zum Codieren und Decodieren von XML- und HTML-Zeichenfolgen verwendet. Diese Codierung und Decodierung kann für Sie in den folgenden Szenarien hilfreich sein:

Interaktion mit HTML-Webressourcen
Codierung und Decodierung von Abfragezeichenfolgenparametern,
Interaktion mit FetchXML, das das Sonderzeichen wie „&“ oder „<“ in einer Suchzeichenfolge enthält.

Das Navigationsobjekt stellt navigationsbezogene Methoden bereit, die in einer modellgesteuerten Anwendung verwendet werden können. Aufgrund ihrer Sperreigenschaften werden Aktivitäten wie das Anzeigen von Warn‑, Bestätigungs- und Fehlerdialogen nicht als optimale Benutzererfahrung angesehen, können aber dennoch verwendet werden. In diesen Szenarien wird empfohlen, Formularbenachrichtigungen und/oder andere nicht blockierende Optionen in Betracht zu ziehen, um Benutzer vor einem Problem zu warnen. Hier finden Sie ist eine Zusammenfassung der Methoden, die im Objekt „Xrm.Navigation“ verfügbar sind.

Methode	Beschreibung
openAlertDialog	Zeigt ein Warndialogfeld mit einer Nachricht und einer Schaltfläche an.
openConfirmDialog	Zeigt ein Bestätigungsdialogfeld mit einer Nachricht und zwei Schaltflächen an.
openErrorDialog	Zeigt einen Fehlerdialog an.
openFile	Öffnet eine Datei.
openForm	Öffnet ein Tabellenformular oder ein Schnellerfassungsformular.
openUrl	Öffnet eine URL, einschließlich Datei-URLs.
openWebResource	Öffnet eine HTML-Webressource.

Panel-Objekt

Das Objekt „Xrm.Panel“ bietet eine Methode zum Anzeigen einer Webseite im Seitenbereich eines Formulars einer modellgesteuerten App. Diese Funktion befindet sich derzeit in der Vorschau und wird hier nicht im Detail behandelt. Weitere Informationen finden Sie unter Xrm.Panel.

Hilfsprogrammobjekt

Das Objekt „Xrm.Utility“ ist ein Container für verschiedene nützliche Methoden. Die folgende Tabelle ist eine Zusammenfassung der Methoden, die im Objekt „Xrm.Utility“ verfügbar sind. Weitere Informationen finden Sie unter Xrm.Utility (Client-API-Referenz)

Methode	Beschreibung
closeProgressIndicator	Der Indikator schließt ein Fortschrittsdialogfeld, das mit showProgressIndicator geöffnet wurde.
getAllowedStatusTransitions	Gibt die gültigen Statusübergänge für die angegebene Tabelle und den Statuscode zurück.
getEntityMetadata	Gibt die Entitätsmetadaten für die angegebene Entität zurück.
getGlobalContext	Ruft den globalen Kontext ab, der Ihnen Laufzeitinformationen bereitstellen kann, einschließlich Organisations‑ und Benutzereinstellungen sowie App‑ und Clientinformationen.
getLearningPathAttributeName	Gibt den Namen des DOM-Attributs zurück, das vom Inhaltsdesigner des Lernpfads (interaktiver Begleiter) zum Identifizieren von UI-Steuerelementen in den Formularen in modellgesteuerte Apps erwartet wird.
getResourceString	Gibt die lokalisierte Zeichenfolge für einen bestimmten Schlüssel zurück, der der angegebenen Webressource zugeordnet ist.
invokeProcessAction	Ruft eine Aktion basierend auf den angegebenen Parametern auf. Diese Methode kann auch verwendet werden, um von Ihren Entwicklern hergestellte, benutzerdefinierte APIs aufzurufen.
lookupObjects	Öffnet ein Suchsteuerelement zum Auswählen eines oder mehrerer Elemente.
refreshParentGrid	Aktualisiert das übergeordnete Raster, das den angegebenen Datensatz enthält.
showProgressIndicator	Zeigt einen Fortschrittsdialog mit der angegebenen Nachricht an.

Es gibt auch viele Methoden, die hier nicht aufgeführt sind und auf die Sie in älterem Code stoßen könnten, der jetzt veraltet ist, weil sie in den Xrm.Navigation-Namespace verschoben wurden. Wenn Sie diese Methoden finden, sollten Sie den Code aktualisieren, um die neuen Xrm.Navigation-Methoden zu nutzen.

Objekt „Xrm.WebApi“

Das Objekt „Xrm.WebApi“ bietet Eigenschaften und Methoden zur Verwendung der Web-API für herkömmliche CRUD-Vorgänge in einem Client-Skript. Die von Ihnen ausgeführten Vorgänge stehen automatisch im Kontext des aktuellen App-Benutzers, wenn Sie die Xrm.WebAPI in Ihrer Skriptlogik verwenden. Sie können die Web-API verwenden, wenn die App online und offline ist (bei offline konfigurierter Umgebung). Der Namespace enthält einen bestimmten Satz von Online‑ und Offline-Methoden. Die Verwendung dieser Methoden erfordert jedoch die Nachverfolgung des Clientstatus. Wenn Sie die Xrm.WebAPI, Xrm.WebAPI.createRecord verwenden, bestimmt die API, ob sie Online‑ oder Offline-Namespacemethoden für Sie verwenden soll.

Die folgende Tabelle ist eine Zusammenfassung der Methoden, die im Objekt „Xrm.WebApi“ verfügbar sind. Weitere Informationen finden Sie unter Xrm.WebApi (Client-API-Referenz).

Methode	Beschreibung
createRecord	Erstellt eine Tabellenzeile.
deleteRecord	Löscht eine Tabellenzeile mit der ID der Zeile.
retrieveRecord	Ruft eine Zeile mit der ID der Zeile ab.
retrieveMultipleRecords	Ruft eine Auflistung von Tabellenzeilen ab, die den bereitgestellten Abfrageoptionen oder FetchXML entsprechen.
updateRecord	Aktualisiert eine Tabellenzeile.
isAvailableOffline	Gibt einen booleschen Wert zurück, der angibt, ob eine Tabelle in einem Benutzerprofil vorhanden und für die Verwendung im Offlinemodus verfügbar ist.
Xrm.WebApi.online.execute (Client API reference)	Führt eine einzelne Aktion, Funktion oder einen CRUD-Vorgang aus.
executeMultiple	Führt eine Sammlung von Aktionen, Funktionen oder CRUD-Operationen aus.

Wenn Sie die Eigenschaften und Methoden des Xrm-Objekts verwenden, können Sie Geschäftsprozesse automatisieren und die Benutzererfahrung insgesamt verbessern.