Dynamics 365 CRM-Dienst anpassen
Der folgende Abschnitt enthält detaillierte Anweisungen zum Hochladen von Anpassungsdateien für Dynamics 365 CRM.
Voraussetzungen
• Stellen Sie sicher, dass die ThingWorx Flow Tools auf Ihrem System installiert sind.
Die ThingWorx Flow Tools werden automatisch zusammen mit Ihrer Installation installiert. Weitere Informationen zu den ThingWorx Flow Tools finden Sie unter Konnektoren bereitstellen.
• Sie müssen als ThingWorx Administrator angemeldet sein, um diese Aktion ausführen zu können.
Schritte
Sie können den Dynamics 365 CRM-Dienst mit einer der folgenden Methoden anpassen:
• OData-Metadaten aktualisieren – Im Dynamics 365 CRM-Dienst ist Version 9.0 der OData-Metadaten enthalten. Möglicherweise müssen Sie an einer anderen Version arbeiten, oder Sie haben Ihrer Version Anpassungen hinzugefügt. In diesem Fall müssen Sie die Dynamics 365 CRM-Metadatendatei aktualisieren. Sie können die gebündelte Version der Dynamics 365 CRM-Metadatendatei als Referenz herunterladen und Ihre Version oder eine aktualisierte Version in Ihre ThingWorx Flow Instanz hochladen.
• Standardmäßig unterstützt ThingWorx Flow OOTB nur einige wenige Entitäten aus dem Dynamics 365 CRM-Modell. Die standardmäßige OOTB-Datei settings.json enthält nur diese unterstützten Entitäten. Die gebündelten OData-Metadaten enthalten jedoch alle Entitäten, Zuordnungen und anderen Elemente, die Microsoft unterstützt. Sie können Dynamics 365 CRM auf zusätzliche Entitäten testen und diese in die Liste der Entitäten, Eigenschaften und zugehörigen Elemente einschließen, indem Sie die Datei settings.json aktualisieren. Laden Sie diese dann in Ihre ThingWorx Flow Instanz hoch. Seien Sie vorsichtig, wenn Sie diese Datei bearbeiten, da jeder Syntaxfehler Dynamics 365 CRM in ThingWorx Flow unbrauchbar machen kann. Um zu verstehen, wie diese Datei aktualisiert wird, laden Sie die gepackte Datei herunter, und vergleichen Sie sie mit der verwendeten OData-Metadatendatei.
Die folgende Tabelle enthält Informationen zu den Attributen, die Sie in der Dynamics 365 CRM-Datei "settings.json" aktualisieren können, um Dynamics 365 CRM anzupassen:
|
Attribut
|
Beschreibung
|
||
|---|---|---|---|
|
DynamicsApiVersion
|
Gibt die Dynamics 365 CRM API-Version an. Standardmäßig ist diese auf 9.0 festgelegt.
|
||
|
EntitySetDefinitions
propertyDefinitions
|
Definiert die Dynamics 365 CRM-Entitätssätze, die in der ThingWorx Flow Benutzeroberfläche angezeigt werden sollen.
Beispiel: Um den Entitätssatz accounts in die Benutzeroberfläche einzuschließen, geben Sie unter dem Attribut EntitySetDefinitions Folgendes an:
"name": "accounts",
"include": true, "label": "Account", Dabei gibt name den Namen des Dynamics 365 CRM-Entitätssatzes an.
Legen Sie für include den Wert true fest, damit der Entitätssatz in der Benutzeroberfläche angezeigt wird.
Das Attribut label definiert den Namen des Entitätssatzes, der in der Benutzeroberfläche angezeigt werden soll.
Jeder Entitätssatz hat Eigenschaften. Definieren Sie die Eigenschaften eines Entitätssatzes, der in der Benutzeroberfläche unter dem Attribut propertyDefinitions angezeigt werden soll. Sie können die Anzahl der Eigenschaften von beliebigen Entitätssätzen einschränken, die in der Benutzeroberfläche angezeigt werden sollen, indem Sie Arrays für name und label der Eigenschaft bereitstellen.
Beispiel: Um die Eigenschaft accountid anzuzeigen, geben Sie unter dem Attribut propertyDefinitions des Attributs accounts EntitySetDefinitions Folgendes an:
{
"name": "accountid", "label": "Account ID" } Dabei gibt name den Namen der Eigenschaft an.
Das Attribut label definiert den Eigenschaftsnamen, der in der Benutzeroberfläche angezeigt werden soll.
Wenn Sie alle Eigenschaften eines Entitätssatzes einschließen möchten, legen Sie als Wert für propertyDefinitions ein leeres Array fest, also "propertyDefinitions": [].
|
||
|
relatedItems
|
Wenn Sie ein zugehöriges Element hinzufügen, enthalten die zurückgegebenen Entitätssatzdaten die zugehörigen Elemente für diesen bestimmten Entitätssatz.
Beispiel: Um die Eigenschaft attachments anzuzeigen, geben Sie unter dem Attribut relatedItems des Attributs accounts EntitySetDefinitions Folgendes an:
{
"name": "attachments", "label": "Attachments" } Dabei gibt name den Namen des zugehörigen Elements an.
Das Attribut label definiert den Namen des zugehörigen Elements, der in der Benutzeroberfläche angezeigt werden soll.
Wenn Sie keine zugehörigen Elemente eines Entitätssatzes einschließen möchten, legen Sie als Wert für relatedItems ein leeres Array fest, also relatedItems: [].
|
OData-Metadatendatei hochladen
1. Laden Sie Ihre Version der Metadatendatei herunter, indem Sie über Ihre Dynamics 365 CRM-Instanz auf diese Datei zugreifen. Beispiel: https://host.dynamics.com/api/data/v9.0/$metadata. Beachten Sie, dass die Versionsnummer mit der Version Ihrer Instanz übereinstimmen muss.
Alternativ können Sie die mit ThingWorx Flow gepackte Version herunterladen, indem Sie den folgenden Befehl ausführen:
flow-deploy settings file-download -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -f <Pfad zu XML-Metadatendatei> -s default -c dynamics365 --fileId DynamicsMetadata --contentType application/xml
 |
Als Wert des Parameters fileId muss DynamicsMetadata festgelegt sein.
|
2. Öffnen Sie die XML-Datei, und stellen Sie sicher, dass Ihre erforderliche Anpassung, falls zutreffend, in der heruntergeladenen XML-Datei vorhanden ist. Bearbeiten Sie die Datei, um Ihre Anpassung hinzuzufügen, falls erforderlich.
3. Führen Sie den folgenden Befehl aus, um die benutzerdefinierte OData-Metadatendatei in Ihre ThingWorx Flow Instanz hochzuladen:
flow-deploy settings file-upload -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -f <Pfad zu XML-Metadatendatei> -s default -c dynamics365 --fileId DynamicsMetadata --contentType application/xml
|
|
Als Wert des Parameters fileId muss DynamicsMetadata festgelegt sein.
|
Datei settings.json hochladen
1. Führen Sie den folgenden Befehl aus, um die Datei settings.json herunterzuladen, die mit ThingWorx Flow gebündelt ist:
flow-deploy settings download -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -f <Pfad zu Dynamics365-Einstellungsdatei> -s default -c dynamics365
2. Bearbeiten Sie die Datei settings.json, und stellen Sie sicher, dass sie mit der OData-Metadatendatei kompatibel ist, die Sie verwenden möchten.
Stellen Sie sicher, dass der Wert DynamicsApiVersion in der Datei settings.json mit der Version in der OData-Metadatendatei übereinstimmt, die Sie zuvor hochgeladen haben.
3. Führen Sie den folgenden Befehl aus, um die Dynamics 365 CRM-Datei settings.json hochzuladen:
flow-deploy settings upload -t <ThingWorx Basis-URL> -u <Benutzername des ThingWorx Administrators> -p '<Passwort des ThingWorx Administrators>' -f <Pfad zu Dynamics365-Einstellungsdatei> -s default -c dynamics365
Nachdem alle Uploads erfolgreich waren, starten Sie alle ThingWorx Flow Dienste neu. Ihre Anpassung ist jetzt für alle Dynamics 365 CRM-Aktionen sichtbar.