Actividades de Consulta del Conector QuickBooks

Antes de poder consultar datos de QuickBooks desde Jitterbit, deberá haber creado un extremo de QuickBooks dentro de Jitterbit Studio (consulte QuickBooks Connector OAuth 1.0a - Crear Extremo o QuickBooks Connector 2.0 - Crear Extremo). Ahora que Jitterbit tiene acceso a su instancia de QuickBooks Online, puede realizar cuatro actividades principales con sus datos de QuickBooks : consultar, crear, actualizar o eliminar.

Esta página se centra en consultar sus datos de QuickBooks, utilizando un ejemplo de consulta de datos de QuickBooks existentes en un Cliente específico a través de un archivo XML a través de Jitterbit. Estos pasos se dividen en comenzar la actividad de Consulta, definir los componentes de la Operación e desplegar y ejecutar la Operación.

Crear una Operación de Consulta de QuickBooks

1. Dentro de su proyecto dentro de Jitterbit Studio, hay varias formas de comenzar una nueva actividad de consulta de QuickBooks. Cada una de las siguientes opciones iniciará el Asistente de consultas de QuickBooks para guiarlo a través del proceso.

   • Vaya a Archivo > Nuevo > Conectores > Nueva consulta de QuickBooks.
   • En el árbol de la izquierda, debajo de Conectores, haga clic derecho en la categoría QuickBooks y luego seleccione Nueva consulta de QuickBooks.
   • En el árbol de la izquierda debajo de Conectores, haga doble clic en la categoría QuickBooks, luego haga clic derecho en Actividades de consulta de QuickBooks y seleccione Nueva consulta de QuickBooks.
   • En la barra de herramientas superior, haga clic en el icono del conector (pieza de rompecabezas naranja) . En la ventana emergente, seleccione QuickBooks, luego seleccione Consulta de QuickBooks.

2. La pantalla Extremo del Asistente de consulta de QuickBooks le pide que seleccione el extremo desde el que desea consultar los datos. Ya debería haber configurado extremos en QuickBooks Connector OAuth 1.0a - Crear Extremo o QuickBooks Connector 2.0 - Crear Extremo. Seleccione el extremo adecuado, por ejemplo un ambiente de pruebas o un extremo de producción. Haga clic en Siguiente cuando haya terminado.

   Nota

   El ejemplo utilizado en esta documentación consulta un conjunto de datos de muestra proporcionados en cada nuevo ambiente de pruebas de QuickBooks. Para acceder a su zona de pruebas, vaya a https://developer.intuit.com/ e inicie sesión en su cuenta de QuickBooks Online. Una vez que haya iniciado sesión, vaya a Documentos y herramientas > Sandbox > Ir a la empresa para encontrar el Sandbox que desea utilizar. Dentro del ambiente sandbox verá los datos de muestra disponibles para fines de prueba.

   

3. La pantalla Objeto del Asistente de consulta de QuickBooks le pide que seleccione el objeto desde el que desea consultar. En este ejemplo utilizamos la API de Contabilidad durante la creación de la aplicación QuickBooks Online y, por lo tanto, solo tenemos un Objeto para seleccionar: Contabilidad. Haga clic en el Objeto y luego haga clic en Siguiente para continuar.

   

4. La pantalla Componente del Asistente de consulta de QuickBooks muestra todos los componentes que están disponibles para ser consultados dentro de su instancia de QuickBooks conectada. Para los fines de este tutorial, consultar un Cliente y, por lo tanto, seleccionaremos el componente Cliente. Luego haga clic en el botón Finalizar.

   

5. Jitterbit Studio luego procederá a crear una estructura de solicitud y respuesta de la API de QuickBooks que permitirá consultar datos dentro de su instancia conectada de QuickBooks Online. Debería aparecer una nueva pestaña en Studio llamada Actividades de consulta de QuickBooks. Puede cambiar el nombre de su consultar aquí si lo desea; en el ejemplo, el nuestro se llama "Consulta de QuickBooks del cliente".

   Haga clic en el ícono + en el extremo derecho de las vistas de estructura de Solicitud y Respuesta para expandir todos los elementos dentro de cada estructura. Con cada lado ahora expandido, debería ver una pantalla similar a la imagen que se muestra a continuación.

   

6. A continuación, en la misma pantalla, haga clic en el botón Crear operación ubicado en Usar en una integración en la esquina superior derecha. Esto creará la operación Jitterbit que consultar QuickBooks en busca de datos del Cliente.

7. Debería abrirse una nueva pestaña en Studio llamada Operaciones, que contiene una representación gráfica de la actividad de Consulta. Guarde su operación haciendo clic en el icono de un solo disco para guardar solo esta operación o en el icono de varios discos para guardar todos los cambios en su proyecto de integración. Debería ver que el asterisco en la pestaña Operaciones y el título de la Operación desaparecen cuando su nueva actividad de Consulta ahora se crea y se guarda en su proyecto.

Definición de los Componentes de la Operación

Ahora necesitamos definir los otros componentes de la Operación que aparecen dentro de la representación gráfica, incluidos Origen, Solicitud, Respuesta y Destino. Para fines de este tutorial, proporcionamos los siguientes ejemplos como referencia arriba: Jitterpak QuickBooksExample.jpk y los archivos adjuntos QuickBooksSampleRequestFiles.zip.

• Fuente (opcional): En el ejemplo, el siguiente XML es una solicitud de entrada para buscar un Cliente con el nombre, o Nombre de pila como se lo conoce en QuickBooks, de 'Mark':

  CustomerQueryRequest.xml

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

  Nota

  En el ejemplo anterior, los campos se dejan vacíos, lo que recuperará todos los campos del Cliente. Si solo se necesitan ciertos campos, use un delimitador "," (coma) entre los nombres de los campos (por ejemplo, campo1, campo2, campo3). Luego, para aplicar Condiciones a la consultar, especifique la cláusula deseada en Condiciones como en el siguiente ejemplo.

  A partir de versión 8.25, el campo Condición también puede contener una cláusula ORDERBY y/o las palabras clave STARTPOSITION y MAXRESULTS individualmente o en combinación. Por ejemplo:

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

  Para usar el archivo XML, primero haga doble clic en el ícono Fuente y luego seleccione un nuevo tipo de Fuente. Para este ejemplo, estamos usando un Agente Privado con archivos locales habilitados, y así seleccionar un Tipo de "Archivo local" y luego Buscar hasta la ubicación. Si está utilizando los archivos de ejemplo y los extrae en la ubicación recomendada C:\, la Carpeta es 'C:\projects\quickbooks' y Obtener archivos es 'CustomerQueryRequest.xml'.

  Nota

  Puede optar por omitir el uso de una fuente haciendo clic derecho en el icono de fuente y seleccionando Eliminar del gráfico. Si hace esto, mientras especifica la Solicitud, elija una Fuente de "Ninguno" y en su lugar puede hacer doble clic en las variables en el lado derecho (lado de destino) de la asignación para especificar valores. Estas opciones más avanzadas se tratan en Transformaciones.

• Objetivo: haga doble clic en el icono de Objetivo. En el ejemplo, queremos escribir en un archivo XML con el resultado de la consultar, por lo que nuevamente seleccionaremos un Tipo de "Archivo local" y Buscaremos hasta una ubicación en el Agente Privado donde queremos guardar los datos. En el ejemplo, la Carpeta es 'C:\projects\quickbooks' y el Nombre de archivo es 'CustomerQueryResponse.xml'.

• Solicitud: Haga doble clic en el icono Solicitar y seleccione Crear nueva Transformación. O haga clic en el botón Crear solicitud de la pestaña Actividades de consulta de QuickBooks. Esto abrirá el Asistente de Transformación que lo guiará en la creación de la Solicitud.

  1. En la primera pantalla, Nombre, seleccione el tipo de fuente utilizado anteriormente. Para el ejemplo elegimos XML. Deje el objetivo por defecto.
  2. En la siguiente pantalla, Fuente, elija el botón para Seleccionar una estructura XML existente. En el menú desplegable, seleccione "Esquemas de QuickBooks ". Luego seleccione 'QuickBooksQueryRequest.xsd' para usarlo como su archivo de estructura. En la siguiente pantalla, haga clic en Finalizar.
  3. La pestaña Transformaciones debería abrirse donde podrás completar tu mapeo. Haga clic y arrastre "Campos" desde el lado izquierdo (lado de origen) a "Campos" en el lado derecho (lado de destino). Haz lo mismo con "Condición". Su pantalla de mapeo ahora debería verse similar a la siguiente.

• Respuesta: Haga doble clic en el icono de Respuesta y seleccione Crear nueva Transformación. O haga clic en el botón Crear respuesta de la pestaña Actividades de consulta de QuickBooks. Esto abrirá el Asistente de Transformación que lo guiará en la creación de la Respuesta.

  1. En la primera pantalla, Nombre, seleccione el tipo de destino utilizado anteriormente. Para el ejemplo elegimos XML. Deje la Fuente por defecto.
  2. En la siguiente pantalla, Fuente, elija el botón para Seleccionar una estructura XML existente. En el menú desplegable, seleccione "Esquemas de QuickBooks ". Luego seleccione 'QuickBooksQueryResponse.xsd' para usarlo como su archivo de estructura. En la siguiente pantalla, haga clic en Finalizar.
  3. La pestaña Transformaciones debería abrirse donde podrás completar tu mapeo. Haga clic en + en la parte inferior de cada uno de los lados de Origen y Destino para expandir los elementos de cada árbol. Haga clic y arrastre la carpeta "SALIDA" desde el lado izquierdo (lado de origen) a la carpeta "SALIDA" en el lado derecho (lado de destino). Su pantalla de mapeo ahora debería verse similar a la siguiente.

Despliegue y Ejecución de la Operación

Con la actividad de consulta de QuickBooks configurada, estamos listos para desplegar y ejecutar la operación.

Desde la pestaña Operaciones, haga clic en Desplegar icono. Luego haga clic en Ejecutar para colocar la Operación en la cola para su ejecución.

En la parte inferior de la pantalla, el monitor de Operación debería indicar que su Operación se ejecutó exitosamente. De lo contrario, puede hacer doble clic en el icono de Estado para ver los mensajes de registro.

Ahora también debería ver el resultado de la consultar generada en el destino que especificó. Para el ejemplo, el archivo ahora se crea en 'C:\projects\quickbooks\CustomerQueryResponse.xml':

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>