Actividad Salesforce Query en Jitterbit Studio

Introducción

Una actividad Query de Salesforce, utilizando su conexión de Salesforce, consulta datos de Salesforce y está diseñada para usarse como fuente para proporcionar datos en una operación.

Crear una actividad Salesforce Query

Se crea una instancia de una actividad Query de Salesforce a partir de una conexión de Salesforce utilizando su tipo de actividad Query.

Para crear una instancia de una actividad, arrastra el tipo de actividad al lienzo de diseño o copia el tipo de actividad y pégalo en el lienzo de diseño. Para más detalles, consulta Crear una instancia de actividad o herramienta en Reutilización de componentes.

Se puede editar una actividad Query de Salesforce existente desde estas ubicaciones:

• El lienzo de diseño (consulta Menú de acciones de componentes en Lienzo de diseño).

• La pestaña Componentes del panel de proyecto (consulta Menú de acciones de componentes en Pestaña Componentes del panel de proyecto).

Configurar una actividad Salesforce Query

Sigue estos pasos para configurar una actividad Query de Salesforce:

• Paso 1: Ingresa un nombre y selecciona objetos
  Proporciona un nombre para la actividad y selecciona los objetos a consultar.

• Paso 2: Selecciona campos y crea condiciones
  Crea la declaración de consulta, ya sea automáticamente seleccionando campos y especificando condiciones, o manualmente ingresando directamente una declaración de consulta.

• Paso 3: Revisa los esquemas de datos
  Se muestran los esquemas de solicitud o respuesta generados a partir del endpoint.

Paso 1: Ingresa un nombre y selecciona objetos

En este paso, proporcionas un nombre para la actividad y seleccionas los objetos a consultar.

• Menú de endpoint: Si tienes múltiples endpoints del mismo tipo de conector configurados, un menú en la parte superior de la pantalla muestra el nombre del endpoint actual. Haz clic en el menú para cambiar a un endpoint diferente. Para más información, consulta Cambiar el endpoint asignado en Pantallas de configuración.

  • Editar endpoint: Aparece cuando pasas el cursor sobre el nombre del endpoint actual. Haz clic para editar la configuración de conexión del endpoint seleccionado actualmente.

• Nombre: Ingresa un nombre para identificar la actividad Query de Salesforce. El nombre debe ser único para cada actividad Query de Salesforce y no debe contener barras diagonales (/) ni dos puntos (:).

• Seleccionar objeto(s): Esta sección muestra los objetos disponibles en el endpoint de Salesforce:

  • Copiar: Haz clic en el icono Copiar configuración de actividad para copiar la configuración existente de este paso y del paso 2 al portapapeles. La copia se habilita solo después de que se valida una consulta en el paso 2 usando el botón Probar consulta.

  • Pegar: Haz clic en el icono Pegar configuración de actividad para pegar una configuración existente que se haya copiado de este paso o del paso 2. Cuando intentas pegar una consulta, se muestra un diálogo de confirmación indicando que las configuraciones existentes en los pasos 1 y 2 se sobrescribirán.

    Consejo

    Los botones Copiar y Pegar también se pueden usar en diferentes instancias de la actividad Query de Salesforce.

• Vista: Usa el menú desplegable para filtrar la lista de objetos a todos los objetos, objetos estándar u objetos personalizados. De forma predeterminada, se muestran todos los objetos.

• Búsqueda: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de objetos. La búsqueda no distingue mayúsculas de minúsculas.

• Actualizar: Haz clic en el icono de actualización para recargar objetos desde el endpoint de Salesforce. Esto es útil si recientemente agregaste objetos a Salesforce que aún no son visibles en la lista Seleccionar objeto(s).

• Seleccionar objeto(s): La lista de objetos se muestra en una columna a la izquierda. Haz clic en el objeto para agregarlo a la lista de la derecha. Solo se puede seleccionar un objeto principal de la lista de la izquierda.

  Nota

  Si la lista no se completa con los objetos disponibles, es posible que la conexión de Salesforce no sea exitosa. Asegúrate de estar conectado reabriendo la conexión y volviendo a probar las credenciales.

• Seleccionar objeto(s) relacionado(s): Opcionalmente, para incluir objetos secundarios o principales en la consulta, marca la casilla junto a cada objeto relacionado que desees incluir. Esto se conoce como una consulta de relación.

  Nota

  La selección de objetos relacionados se limita a hijos inmediatos y ancestros hasta 5 niveles. Esto incluye el/los padre(s) de un hijo, pero no incluye un hijo de un hijo u otro hijo de un padre.

  • Actualizar: Haz clic en el icono de actualización para recargar campos en los objetos relacionados para esta actividad desde el endpoint de Salesforce. Las selecciones existentes en Seleccionar objeto(s) relacionado(s) se mantienen solo si esos objetos se usan en el paso 2. Cualquier objeto que no se use en el paso 2 tiene su selección borrada.

• Vista previa de campos: Para obtener una vista previa de los campos de un objeto específico, haz clic directamente en el nombre del objeto en Seleccionar objeto(s) relacionado(s). Ten en cuenta que habilitar la vista previa de campos es independiente de qué casillas de campo estén seleccionadas. Es decir, puedes obtener una vista previa de los campos de objetos independientemente de si están seleccionados.

• Guardar y salir: Si está habilitado, haz clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

• Descartar cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.

Paso 2: Seleccionar campos y crear condiciones

En este paso, creas la declaración de consulta, ya sea automáticamente seleccionando campos y especificando condiciones, o manualmente ingresando directamente una declaración de consulta. Debes probar la consulta para asegurar que sea válida antes de continuar al siguiente paso.

• Seleccionar campos y crear condiciones: Esta sección muestra los campos de los objetos seleccionados que están disponibles en el endpoint de Salesforce. Los objetos que se seleccionaron en el paso anterior se muestran en negrita.

  • Búsqueda: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de campos. La búsqueda no distingue mayúsculas de minúsculas. Los resultados listados se filtran en tiempo real con cada pulsación de tecla.

  • Seleccionar todo: Cuando uses el cuadro de búsqueda para filtrar, puedes usar esta casilla para seleccionar todos los campos visibles a la vez (los objetos y campos contraídos no se seleccionan).

  • Seleccionar campos: Marca las casillas de los campos que deseas incluir en la consulta para agregarlos automáticamente a la declaración SOQL de la derecha. A menos que uses el cuadro de búsqueda, también puedes seleccionar un objeto completo para seleccionar todos sus campos a la vez.

• Sentencia SOQL: A medida que seleccionas campos, la sentencia de consulta en el cuadro de texto de la esquina superior derecha se completa automáticamente con el objeto y los campos seleccionados. Para usar una sentencia SOQL personalizada, realiza ediciones dentro de este cuadro de texto según sea necesario. Para obtener información sobre cómo estructurar una sentencia SOQL personalizada, consulta la documentación de Salesforce sobre Sintaxis SELECT de SOQL.

• Incluir filas eliminadas: Marca esta casilla para incluir filas marcadas como eliminadas dentro de Salesforce. (Esto se aplica tanto durante la prueba de la consulta como durante la ejecución.)

• Copiar: Haz clic en el icono Copiar configuración de actividad para copiar la configuración existente de este paso y del paso 1 al portapapeles. La copia se habilita solo después de que se valida una consulta mediante el botón Probar consulta.

• Pegar: Haz clic en el icono Pegar configuración de actividad para pegar una configuración existente que se haya copiado de este paso o del paso 1. Cuando intentas pegar una consulta, se muestra un cuadro de diálogo de confirmación indicando que se sobrescribirán las configuraciones existentes en los pasos 1 y 2.

  Consejo

  Los botones Copiar y Pegar también se pueden usar en diferentes instancias de la actividad Query de ServiceMax.

• Probar consulta: Haz clic en este botón para validar si la consulta es válida. Si la consulta no es válida, se muestran los mensajes de error relevantes. La consulta debe ser válida para habilitar el botón Siguiente.

• Cláusula WHERE (Opcional): Para agregar una cláusula WHERE, usa los campos a continuación como entrada para ayudar a construir la cláusula, o ingresa manualmente la cláusula en el cuadro de texto inferior. Después de agregar una cláusula WHERE, primero debes probar la consulta mediante el botón Probar consulta para habilitar el botón Siguiente.

• Objeto: Campo: Usa el menú desplegable para seleccionar un campo de los objetos seleccionados.

  • Operador: Usa el menú desplegable para seleccionar el operador o los operadores apropiados. La lista de operadores disponibles depende del tipo de datos del campo seleccionado.

    Comparación
    =	Igual a
    !=	No igual a
    <	Menor que
    <=	Menor que o igual a
    >	Mayor que
    >=	Mayor que o igual a
    LIKE	Similar a
    IN	IN
    NOT IN	NOT IN
    INCLUDES	Se aplica solo a listas de selección múltiple
    EXCLUDES	Se aplica solo a listas de selección múltiple

    Lógico
    AND	VERDADERO si ambas expresiones izquierda y derecha son VERDADERAS
    OR	VERDADERO si la expresión izquierda o derecha es VERDADERA
    NOT	VERDADERO si la expresión derecha es FALSA

  • Valor: Ingresa el valor deseado para usar con las selecciones del menú desplegable. Cuando el valor es una cadena, enciérralo entre comillas simples para coincidir con el formato usado por Salesforce.

    Precaución

    Cuando uses variables globales en una cláusula WHERE, debes especificar un valor predeterminado para que la consulta sea válida para pruebas (con el botón Probar consulta), ya que las variables globales obtienen su valor en tiempo de ejecución (consulta Definir un valor predeterminado en Variables globales).

• Agregar: Haz clic en el enlace para construir automáticamente la cláusula según las selecciones del menú desplegable y el valor ingresado. La cláusula construida automáticamente aparece en el cuadro de texto inferior.

  Consejo

  Para agregar múltiples condiciones a la cláusula, repite el proceso agregando selecciones adicionales. Ten en cuenta que es posible que necesites agregar un operador lógico como AND u OR para tener en cuenta las condiciones adicionales.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso. Si has agregado una cláusula WHERE, debes probar la consulta usando el botón Probar consulta para habilitar el botón Siguiente.

• Descartar cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.

Paso 3: Revisar los esquemas de datos

En este paso, se muestran los esquemas de solicitud o respuesta generados desde el endpoint:

• Esquema de datos: Se muestra el esquema de datos de respuesta. Si la operación utiliza una transformación, los esquemas de datos se muestran nuevamente más adelante durante el proceso de mapeo de transformación, donde puedes mapear a campos de destino usando objetos de origen, scripts, variables, valores personalizados y más.

  La versión de la API de Salesforce que se utiliza depende de la versión del agente de Jitterbit que estés usando. Consulta Requisitos previos y versiones de API compatibles para obtener enlaces a la documentación sobre los campos del esquema.

  Nota

  Para actualizar un esquema de datos en una actividad existente, debes avanzar nuevamente a través de cada paso de configuración de la actividad, realizando al menos un cambio (como agregar y eliminar un carácter al final del nombre de la actividad) para forzar una actualización del esquema.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.

• Finalizado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

• Descartar cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.

Próximos pasos

Después de configurar una actividad de Consulta de Salesforce, puedes usarla dentro de una operación como se describe a continuación. Después de ejecutar una operación que contiene una actividad de Salesforce en un agente privado, puedes descargar los archivos de éxito y fallo de la operación.

Completar la operación

Después de configurar una actividad de Consulta de Salesforce, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de la operación. También puedes configurar los parámetros de la operación, que incluyen la capacidad de encadenar operaciones que se encuentren en los mismos flujos de trabajo o en flujos de trabajo diferentes.

Las acciones de menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para obtener más detalles, consulta Menú de acciones de actividad en Conceptos básicos de conectores.

Las actividades de Consulta de Salesforce se pueden usar con estos patrones de operación:

• Patrón de archivo (como origen)
• Patrón de transformación (como origen)
• Patrón de archivo de dos destinos (como primer o segundo origen)
• Patrón de dos transformaciones (como primer o segundo origen)

Si se utiliza una Consulta de Salesforce como actividad de origen, entonces se requiere una actividad de destino.

Una operación puede contener solo una actividad de Salesforce. La actividad que recibe datos de una actividad de Consulta de Salesforce debe estar asociada con el conector API, Base de datos, Recurso compartido de archivos, FTP, HTTP, Almacenamiento local, Almacenamiento temporal o Variable.

Una actividad de Salesforce se puede utilizar como paso de operación en una sola operación. Es decir, no se puede hacer referencia a la misma actividad varias veces dentro de otras operaciones. En su lugar, se puede hacer una copia de una actividad de Salesforce para usarla en otro lugar (consulta Reutilización de componentes).

Otros patrones no son válidos con actividades de Consulta de Salesforce. Consulta los patrones de validación en la página Validez de operaciones.

Dentro de una transformación, si se utiliza la opción para reflejar un esquema proporcionado por una actividad de Salesforce que no sea de carga masiva, el esquema reflejado resultante se creará automáticamente con un nodo raíz adicional llamado records con nodo(s) secundario(s) que reflejan el esquema. Cuando se asignan campos dentro del nodo(s) secundario(s), el nodo se convierte en un nodo de bucle para permitir que se recorran todos los registros (consulta Nodos de bucle en Estructuras de datos).

Las operaciones que utilizan actividades de Salesforce también pueden tener acciones de operación configuradas para activarse en un error SOAP — un error resultante de un formato de mensaje incorrecto, procesamiento de encabezado o incompatibilidad. Las acciones de operación se pueden configurar para ejecutar una operación o enviar un correo electrónico después de que ocurra un error SOAP. Para obtener instrucciones sobre cómo activar una acción en caso de error SOAP, consulta Acciones de operación.

Para utilizar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego utiliza esa ubicación temporal en la función de scripting.

Cuando esté listo, implementa y ejecuta la operación y valida el comportamiento verificando los registros de operación.

Ver archivos de éxito y error

Si ejecutas una operación que contiene una actividad de Salesforce en un agente privado, los archivos de éxito y error están disponibles para descargar en la página Runtime de la Consola de administración. Selecciona la operación relevante en la tabla Runtime y haz clic en la pestaña Activity Logs en la sección inferior de la pantalla para mostrar los enlaces de descarga de los archivos si están disponibles:

• Descargar archivo de éxito: Si ejecutas la operación en un agente privado, haz clic en el enlace Download para guardar los registros exitosos como archivo CSV.

• Descargar archivo de error: Si ejecutas la operación en un agente privado, haz clic en el enlace Download para guardar los registros con error como archivo CSV.