QuickBooks Connector - Abfrageaktivitäten im Jitterbit Design Studio

Bevor Sie QuickBooks Daten von Jitterbit Abfrage können, müssen Sie einen QuickBooks Endpoint in Jitterbit Studio erstellt haben (siehe QuickBooks-Connector OAuth 1.0a - Endpoint erstellen oder QuickBooks Connector 2.0 - Endpoint erstellen). Jetzt, da Jitterbit Zugriff auf Ihre QuickBooks Online-Instanz hat, können Sie vier Hauptaktivitäten mit Ihren QuickBooks Daten durchführen: Abfragen, Erstellen, Aktualisieren oder Löschen.

Auf dieser Seite geht es um die Abfrage Ihrer QuickBooks-Daten. Als Beispiel wird die Abfrage vorhandener QuickBooks Daten zu einem bestimmten Kunden über eine XML-Datei über Jitterbit verwendet. Diese Schritte sind unterteilt in den Beginn der Abfrageaktivität, das Definieren der Operationskomponenten und das Bereitstellen und Ausführen der Operation.

Erstellen einer QuickBooks Operation

1. Innerhalb Ihres Projekts in Jitterbit Studio gibt es mehrere Möglichkeiten, eine neue QuickBooks Abfrageaktivität zu starten. Jede der folgenden Optionen startet den QuickBooks Abfrageassistenten, der Sie durch den Vorgang führt.

   • Gehen Sie zu Datei > Neu > Konnektoren > Neue QuickBooks Abfrage.
   • Klicken Sie in der Strukturansicht links unter Konnektoren mit der rechten Maustaste auf die Kategorie QuickBooks und wählen Sie dann Neue QuickBooks-Abfrage.
   • Doppelklicken Sie in der Baumstruktur links unter Konnektoren auf die Kategorie QuickBooks, klicken Sie dann mit der rechten Maustaste auf QuickBooks-Abfrageaktivitäten und wählen Sie Neue QuickBooks-Abfrage.
   • Klicken Sie in der oberen Symbolleiste auf das Verbindungssymbol (orangefarbenes Puzzleteil) . Wählen Sie im Popup QuickBooks und dann QuickBooks-Abfrage.

2. Der Endpoint-Bildschirm des QuickBooks-Abfrageassistenten fordert Sie auf, den Endpoint auszuwählen, von dem Sie Daten Abfrage möchten. Sie sollten bereits Endpoints in QuickBooks-Connector OAuth 1.0a - Endpoint erstellen eingerichtet haben oder QuickBooks Connector 2.0 - Endpoint erstellen. Wählen Sie den entsprechenden Endpoint aus, z. B. einen Sandbox- oder Endpoint. Klicken Sie nach Abschluss auf Weiter.

   Notiz

   Das in dieser Dokumentation verwendete Beispiel fragt einen Satz von Beispieldaten ab, die in jeder neuen QuickBooks Sandbox bereitgestellt werden. Um auf Ihre Sandbox zuzugreifen, gehen Sie zu https://developer.intuit.com/ und melden Sie sich bei Ihrem QuickBooks Online-Konto an. Sobald Sie angemeldet sind, gehen Sie zu Dokumente & Tools > Sandbox > Zu Unternehmen gehen für die Sandbox, die Sie verwenden möchten. Innerhalb der Sandbox sehen Sie die Beispieldaten, die zu Testzwecken verfügbar sind.

   

3. Der Objekt-Bildschirm des QuickBooks-Abfrageassistenten fordert Sie auf, das Objekt auszuwählen, von dem Sie eine Abfrage durchführen möchten. In diesem Beispiel haben wir bei der Erstellung der QuickBooks Online-App die Buchhaltungs-API verwendet und müssen daher nur ein Objekt auswählen: Buchhaltung. Klicken Sie auf das Objekt und dann auf Weiter, um fortzufahren.

   

4. Der Komponenten-Bildschirm des QuickBooks-Abfrageassistenten zeigt alle Komponenten an, die in Ihrer verbundenen QuickBooks Instanz abgefragt werden können. Für die Zwecke dieser exemplarischen Vorgehensweise Abfrage wir nach einem Kunden und wählen daher die Kundenkomponente aus. Klicken Sie dann auf die Schaltfläche Fertigstellen.

   

5. Jitterbit Studio erstellt dann eine QuickBooks API Anforderungs- und-Antwortstruktur, die die Datenabfrage innerhalb Ihrer verbundenen QuickBooks Online-Instanz ermöglicht. In Studio sollte eine neue Tab mit dem Namen QuickBooks-Abfrageaktivitäten angezeigt werden. Sie können Ihre Abfrage hier bei Bedarf umbenennen; im Beispiel heißt unsere „QuickBooks Kundenabfrage“.

   Klicken Sie auf das +-Symbol ganz rechts in den Strukturansichten „Anforderung“ und „Antwort“, um alle Elemente innerhalb der jeweiligen Struktur zu erweitern. Wenn nun jede Seite erweitert ist, sollte nun ein Bildschirm angezeigt werden, der dem unten gezeigten Bild ähnelt.

   

6. Klicken Sie anschließend auf demselben Bildschirm auf die Schaltfläche Operation erstellen unter In einer Integration verwenden in der oberen rechten Ecke. Dadurch wird die Jitterbit Operation erstellt, die QuickBooks nach Kundendaten Abfrage.

7. In Studio sollte sich eine neue Tab mit dem Namen Operationen öffnen, die eine grafische Darstellung der Abfrageaktivität enthält. Speichern Sie Ihre Operation, indem Sie entweder auf das Symbol mit einem Datenträger klicken, um nur diese Operation zu speichern, oder auf das Symbol mit mehreren Datenträgern, um alle Änderungen in Ihrem Integrationsprojekt zu speichern. Sie sollten sehen, dass das Sternchen auf der Tab „Operationen“ und der Titel der Operation verschwinden, da Ihre neue Abfrageaktivität jetzt erstellt und in Ihrem Projekt gespeichert ist.

Definieren der Operation

Jetzt müssen wir die anderen Komponenten der Operation definieren, die in der grafischen Darstellung erscheinen, einschließlich Quelle, Anforderung, Antwort und Ziel. Für die Zwecke dieser Anleitung stellen wir die folgenden Beispiele als Referenz zur Verfügung: Jitterpak QuickBooksExample.jpk und dazugehörige Dateien QuickBooksSampleRequestFiles.zip.

• Quelle (optional): Im Beispiel ist das folgende XML eine Eingabeanforderung zum Abrufen für einen Kunden mit dem Vornamen oder GivenName, wie er in QuickBooks genannt wird, „Mark“:

  CustomerQueryRequest.xml

  <ns:INPUT xmlns:ns="urn:qboln-res:document:qboln:oln:functions">
  <Customer>
  <Fields></Fields>
  <Condition>GivenName='Mark'</Condition>
  </Customer>
  </ns:INPUT>
  

  Notiz

  Im obigen Beispiel werden die Felder leer gelassen, wodurch alle Felder für den Kunden abgerufen werden. Wenn nur bestimmte Felder benötigt werden, verwenden Sie ein Komma als Trennzeichen zwischen den Feldnamen (z. B. Feld1, Feld2, Feld3). Um dann Bedingungen auf die Abfrage anzuwenden, geben Sie die gewünschte Klausel in Bedingungen an, wie im folgenden Beispiel.

  Ab Version 8.25, kann das Feld Bedingung auch eine ORDERBY-Klausel und/oder die Schlüsselwörter STARTPOSITION und MAXRESULTS einzeln oder in Kombination enthalten. Beispiel:

  <Fields>Name,GivenName,FullyQualifiedName,AccountType</Fields> <Condition>GivenName='Mark' ORDERBY Name STARTPOSITION 0 MAXRESULTS 10</Condition>

  Um die XML-Datei zu verwenden, doppelklicken Sie zuerst auf das Quellsymbol und wählen Sie dann einen neuen Quelltyp aus. Für dieses Beispiel verwenden wir einen privaten Agenten mit lokalen Dateien aktiviert, und wählen Sie daher als Typ „Lokale Datei“ aus und navigieren Sie dann zum Speicherort. Wenn Sie die Beispieldateien verwenden und diese am empfohlenen Speicherort C:\ entpacken, ist der Ordner „C:\projects\quickbooks“ und die Datei abrufen ist „CustomerQueryRequest.xml“.

  Notiz

  Sie können die Verwendung einer Quelle umgehen, indem Sie mit der rechten Maustaste auf das Quellsymbol klicken und Aus Diagramm entfernen auswählen. Wenn Sie dies tun, wählen Sie beim Angeben der Anforderung eine Quelle von „Keine“ aus und doppelklicken Sie stattdessen auf die Variablen auf der rechten Seite (Zielseite) der Zuordnung, um Werte anzugeben. Diese erweiterten Optionen werden unter Transformations behandelt.

• Ziel: Doppelklicken Sie auf das Zielsymbol. Im Beispiel möchten wir die Abfrage in eine XML-Datei schreiben, daher wählen wir erneut den Typ „Lokale Datei“ und navigieren zu einem Speicherort auf dem privaten Agenten, an dem wir die Daten speichern möchten. Im Beispiel ist der Ordner „C:\projects\quickbooks“ und der Dateiname „CustomerQueryResponse.xml“.

• Anfrage: Doppelklicken Sie auf das Anfragesymbol und wählen Sie Neue Transformation erstellen. Oder klicken Sie auf der Tab QuickBooks-Abfrageaktivitäten auf die Schaltfläche Anfrage erstellen. Dadurch wird der Transformation geöffnet, der Sie durch die Erstellung der Anfrage führt.

  1. Wählen Sie auf dem ersten Bildschirm Name den oben verwendeten Quelltyp aus. Für das Beispiel haben wir XML gewählt. Belassen Sie das Ziel auf der Standardeinstellung.
  2. Wählen Sie auf dem nächsten Bildschirm Quelle die Schaltfläche Vorhandene XML-Struktur auswählen. Wählen Sie in der Dropdown-Liste „QuickBooks Schemas“ aus. Wählen Sie dann „QuickBooksQueryRequest.xsd“ als Strukturdatei aus. Klicken Sie auf dem nächsten Bildschirm auf Fertigstellen.
  3. Die Tab Transformations sollte sich öffnen, wo Sie Ihre Zuordnung abschließen können. Klicken Sie auf „Felder“ und ziehen Sie sie von der linken Seite (Quellseite) auf „Felder“ auf der rechten Seite (Zielseite). Machen Sie dasselbe mit „Bedingung“. Ihr Zuordnungsbildschirm sollte jetzt ungefähr wie unten aussehen.

• Antwort: Doppelklicken Sie auf das Antwortsymbol und wählen Sie Neue Transformation erstellen. Oder klicken Sie auf der Tab QuickBooks-Abfrageaktivitäten auf die Schaltfläche Antwort erstellen. Dadurch wird der Transformation geöffnet, der Sie durch die Erstellung der Antwort führt.

  1. Wählen Sie auf dem ersten Bildschirm Name den oben verwendeten Zieltyp aus. Für das Beispiel haben wir XML gewählt. Belassen Sie die Quelle auf der Standardeinstellung.
  2. Wählen Sie auf dem nächsten Bildschirm Quelle die Schaltfläche Vorhandene XML-Struktur auswählen. Wählen Sie in der Dropdown-Liste „QuickBooks Schemas“ aus. Wählen Sie dann „QuickBooksQueryResponse.xsd“ als Strukturdatei aus. Klicken Sie auf dem nächsten Bildschirm auf Fertigstellen.
  3. Die Tab Transformations sollte sich öffnen, wo Sie Ihre Zuordnung abschließen können. Klicken Sie auf das + unten auf der Quellseite und der Zielseite, um die Elemente in jedem Baum zu erweitern. Klicken Sie auf den Ordner „OUTPUT“ und ziehen Sie ihn von der linken Seite (Quellseite) in den Ordner „OUTPUT“ auf der rechten Seite (Zielseite). Ihr Zuordnungsbildschirm sollte nun ungefähr wie unten aussehen.

Bereitstellen und Ausführen der Operation

Nachdem die QuickBooks Abfrageaktivität vollständig eingerichtet ist, können wir den Vorgang einsetzen und ausführen.

Klicken Sie auf der Tab „Operationen“ auf die Schaltfläche „Bereitstellen“ -Symbol. Klicken Sie dann auf Ausführen , um die Operation zur Ausführung in die Warteschlange zu stellen.

Im unteren Teil des Bildschirms sollte der Operationsmonitor anzeigen, dass Ihre Operation erfolgreich ausgeführt wurde. Wenn nicht, können Sie auf das Statussymbol doppelklicken, um alle Protokollmeldungen anzuzeigen.

Sie sollten jetzt auch die Ausgabe der Abfrage sehen, die im von Ihnen angegebenen Ziel generiert wurde. Für das Beispiel wird die Datei jetzt in „C:\projects\quickbooks\CustomerQueryResponse.xml“ erstellt:

title-"CustomerQueryResponse.xml" <ns:OUTPUT xmlns:ns="urn:qboln-res:document:qboln:oln:functions"> <ns:Customer> <ns:Id>17</ns:Id> <ns:SyncToken>0</ns:SyncToken> <ns:MetaData> <ns:CreateTime>2017-09-17T18:12:16-06:00</ns:CreateTime> <ns:LastUpdatedTime>2017-09-25T13:57:24-06:00</ns:LastUpdatedTime> </ns:MetaData> <ns:GivenName>Mark</ns:GivenName> <ns:FamilyName>Cho</ns:FamilyName> <ns:FullyQualifiedName>Mark Cho</ns:FullyQualifiedName> <ns:DisplayName>Mark Cho</ns:DisplayName> <ns:PrintOnCheckName>Mark Cho</ns:PrintOnCheckName> <ns:Active>1</ns:Active> <ns:PrimaryPhone> <ns:FreeFormNumber>(650) 554-1479</ns:FreeFormNumber> </ns:PrimaryPhone> <ns:PrimaryEmailAddr> <ns:Address>Mark@Cho.com</ns:Address> </ns:PrimaryEmailAddr> <ns:Taxable>0</ns:Taxable> <ns:BillAddr> <ns:Id>17</ns:Id> <ns:Line1>36 Willow Rd</ns:Line1> <ns:City>Menlo Park</ns:City> <ns:CountrySubDivisionCode>CA</ns:CountrySubDivisionCode> <ns:PostalCode>94304</ns:PostalCode> <ns:Lat>37.450412</ns:Lat> <ns:Long>-122.170593</ns:Long> </ns:BillAddr> <ns:ShipAddr> <ns:Id>17</ns:Id> <ns:Line1>36 Willow Rd</ns:Line1> <ns:City>Menlo Park</ns:City> <ns:CountrySubDivisionCode>CA</ns:CountrySubDivisionCode> <ns:PostalCode>94304</ns:PostalCode> <ns:Lat>37.450412</ns:Lat> <ns:Long>-122.170593</ns:Long> </ns:ShipAddr> <ns:Job>0</ns:Job> <ns:BillWithParent>0</ns:BillWithParent> <ns:Balance>314.28</ns:Balance> <ns:BalanceWithJobs>314.28</ns:BalanceWithJobs> <ns:CurrencyRef name="United States Dollar">USD</ns:CurrencyRef> <ns:PreferredDeliveryMethod>Print</ns:PreferredDeliveryMethod> </ns:Customer> </ns:OUTPUT>