Actividad de consulta de Salesforce

Introducción

Una actividad de Consulta de Salesforce consulta datos de un extremo de Salesforce y está destinada a utilizarse como fuente para proporcionar datos a una operación. Después de configurar una conexión de Salesforce, puede configurar tantas actividades de Salesforce como desee para cada conexión de Salesforce.

Crear una actividad de Salesforce

Una instancia de una actividad se crea a partir de una conexión utilizando un tipo de actividad.

Para crear una instancia de una actividad, arrastre el tipo de actividad al tela de diseño o copie el tipo de actividad y péguelo en el tela de diseño. Para obtener más detalles, consulte Creación de una instancia de actividad en Reutilización de componentes.

Se puede editar una actividad existente desde estas ubicaciones:

• El tela de diseño (vea menú de acciones del componente en Lienzo de diseño).
• La pestaña Componentes del panel del proyecto (vea menú de acciones de componentes en la pestañaComponentes del panel Proyecto).

Configurar una actividad de consulta de Salesforce

Siga estos pasos para configurar una actividad Consulta de Salesforce:

• Paso 1: Ingrese un nombre y seleccione objetos Proporcione un nombre para la actividad y seleccione el objeto o los objetos que se consultarán.
• Paso 2: Seleccione campos y cree condiciones Cree la declaración de consultar, ya sea automáticamente seleccionando campos y especificando condiciones, o manualmente ingresando directamente una declaración de consultar. Debe probar la consultar para asegurarse de que sea válida antes de continuar con el siguiente paso.
• Paso 3: Revisar los esquemas de datos Se muestran todos los esquemas de solicitud o respuesta generados desde el extremo.

Paso 1: Ingrese un nombre y seleccione objetos

En este paso, proporciona un nombre para la actividad y selecciona los objetos que se consultarán.

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

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

  • Ver: Use el menú desplegable para filtrar la lista de objetos y seleccionar todos los objetos, objetos estándar u objetos personalizados. De manera predeterminada, se muestran todos los objetos.

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

  • Actualizar: Haga clic en el ícono de actualización para volver a cargar objetos desde el extremo de Salesforce. Esto es útil si recientemente agregó objetos a Salesforce que aún no están visibles en la lista Seleccionar objeto(s).

  • Seleccionar objeto(s): La lista de objetos se muestra en una columna a la izquierda. Haga 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, tenga en cuenta los siguientes consejos para la solución de problemas:

    • La conexión de Salesforce puede que no se realice correctamente. Asegúrese de estar conectado volviendo a abrir la conexión y probando nuevamente las credenciales.

    • Una contraseña de Salesforce que utiliza caracteres ASCII extendidos, como £, puede provocar el siguiente error al obtener datos durante la configuración de la actividad:

      Invalid username, password, security token; or user locked out. [INVALID_LOGIN]
      

      En este caso, la prueba de conexión puede ser exitosa. Si recibe este error durante la configuración de la actividad y está usando caracteres especiales en la contraseña, intente cambiar la contraseña.

• Seleccionar objeto(s) relacionado(s): Opcionalmente, para incluir objetos secundarios o primarios en la consultar, seleccione la casilla de verificación junto a cada objeto relacionado que desee incluir. Esto se conoce como consultar de relación.

  Nota

  La selección de objetos relacionados está limitada a los hijos y ancestros inmediatos hasta 5 niveles. Esto incluye a los padres de un hijo, pero no incluye a un hijo de un hijo ni a otro hijo de un padre.

  • Actualizar: Haga clic en el ícono de actualización para volver a cargar los campos en los objetos relacionados para esta actividad desde el extremo de Salesforce. Las selecciones existentes en Seleccionar objeto(s) relacionado(s) permanecen solo si esos objetos se utilizan en el paso 2. Se borra la selección de los objetos que no se utilizan en el paso 2.

• Vista previa de campos: Para obtener una vista previa de los campos de un objeto específico, haga clic directamente en el nombre del objeto en Seleccionar objeto(s) relacionado(s). Tenga en cuenta que la habilitación de la vista previa de campos es independiente de las casillas de verificación de campos que estén seleccionadas. Es decir, puede obtener una vista previa de los campos de los objetos independientemente de si están seleccionados.

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

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

• Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 2: Seleccionar campos y crear condiciones

En este paso, se crea la declaración de consultar, ya sea automáticamente seleccionando campos y especificando condiciones, o manualmente ingresando directamente una declaración de consultar. Debe probar la consultar para asegurarse de que sea válida antes de continuar con el siguiente paso.

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

  • Buscar: Ingrese el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de campos. La búsqueda no distingue entre mayúsculas y minúsculas. Los resultados de la lista se filtran en tiempo real con cada pulsación de tecla.
  • Seleccionar todo: Al usar el cuadro de búsqueda para filtrar, puede usar esta casilla de verificación para seleccionar todos los campos visibles a la vez (los objetos y los campos contraídos no se seleccionan).
  • Seleccionar campos: Seleccione las casillas de verificación de los campos que desea incluir en la consultar para que se agreguen automáticamente a la declaración SOQL a la derecha. A menos que utilice el cuadro de búsqueda, también puede seleccionar un objeto completo para seleccionar todos sus campos a la vez.

• Instrucción SOQL: A medida que selecciona campos, la instrucción de consultar en el cuadro de texto superior derecho se completa automáticamente con el objeto y los campos seleccionados. Para utilizar una instrucción SOQL personalizada, realice las modificaciones necesarias en este cuadro de texto. Para obtener una referencia sobre cómo estructurar una instrucción SOQL personalizada, consulte la documentación de Salesforce sobre Sintaxis SOQL SELECT.

• Incluir filas eliminadas: Seleccione esta casilla de verificación para incluir las filas que están marcadas como eliminadas en Salesforce. (Esto se aplica tanto durante la prueba de la consultar como durante el tiempo de ejecución).

• Consulta de prueba: Haga clic en este botón para validar si la consultar es válida. Si la consultar es válida, se muestra una muestra de 10 registros recuperados de la consultar en una tabla similar a la que se muestra a continuación. Si la consultar no es válida, se muestran los mensajes de error pertinentes. La consultar debe ser válida para habilitar el botón Siguiente.

  

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

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

  • Operador: Utilice el menú desplegable para seleccionar los operadores adecuados. La lista de operadores disponibles depende del tipo de datos del campo seleccionado.

    ------------	---------------------- ----------------------
    Comparación
    =	Es igual a
    !=	No es igual a
    \<	Menor que
    \<=	Menor o igual que
    >	Mayor que
    >=	Mayor o igual que
    ME GUSTA	Me gusta
    EN	EN
    NO ESTÁ EN	NO ESTÁ EN
    INCLUYE	Aplica solo a listas de selección múltiple
    EXCLUYE	Se aplica solo a listas de selección múltiple
    Lógico
    Y	VERDADERO si ambas expresiones izquierda y derecha son VERDADERAS
    O	VERDADERO si la expresión izquierda o derecha es VERDADERA
    NO	VERDADERO si la expresión correcta es FALSA

  • Valor: Ingrese el valor que desea utilizar con las selecciones del menú desplegable. Cuando el valor sea una cadena, enciérrelo entre comillas simples para que coincida con el formato utilizado por Salesforce.

    Precaución

    Al utilizar variables globales en una cláusula WHERE, debe especificar un valor predeterminado para que la consultar sea válida para la prueba (con el botón Probar consulta), ya que las variables globales obtienen su valor en tiempo de ejecución (consulte Definir un valor predeterminado en Variables globales).

  • Agregar: Haga clic en el enlace para construir automáticamente la cláusula en función de 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 varias condiciones a la cláusula, repita el proceso agregando selecciones adicionales. Tenga en cuenta que es posible que deba agregar un operador lógico como AND u OR para tener en cuenta las condiciones adicionales.

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

• Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso. Si ha agregado una cláusula WHERE, debe probar la consultar utilizando el botón Probar consulta para habilitar el botón Siguiente.

• Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 3: Revisar los esquemas de datos

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

• Esquema de datos: Se muestra el esquema de datos de respuesta. Si la operación utiliza una transformación, los esquemas de datos se vuelven a mostrar más adelante durante la asignación de transformación proceso, donde puede asignar campos de destino utilizando objetos de origen, secuencias de comandos, variables, valores personalizados y más.

  La versión de la API REST de Salesforce que se utiliza depende de la versión del agente Jitterbit que esté utilizando. Consulte 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, debe avanzar nuevamente a través de cada paso de configuración de la actividad, realizando al menos un cambio (como agregar y quitar un carácter del final del nombre de la actividad) para forzar una actualización del esquema.

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

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

• Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Próximos pasos

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

Completar la operación

Después de configurar una actividad de Consulta de Salesforce, complete la configuración de la operación agregando y configurando otras actividades, transformaciones o secuencias de comandos como pasos de la operación. También puede configurar los ajustes de operación de una operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujo de trabajo o en flujos de trabajo diferentes.

Una vez que se crea una actividad de Consulta de Salesforce, se puede acceder a las acciones del menú para esa actividad desde el panel del proyecto en las pestañas Flujos de trabajo o Componentes, y desde el tela de diseño. Consulte menú de acciones de la actividad para más detalles.

Las actividades de Consulta de Salesforce se pueden utilizar como fuente con estos patrones de operación:

• Patrón de archivo
• Patrón de Transformación
• Patrón de archivo de dos objetivos (ya sea como primera o segunda fuente)
• Patrón de dos transformaciones (como primera o segunda fuente)

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

Las operaciones que contienen una actividad de Salesforce solo pueden tener una actividad de Salesforce y no pueden contener también ninguna otra actividad excepto aquellas asociadas con la API, Base de datos, Compartir archivos, FTP, HTTP, Almacenamiento local, Almacenamiento temporal, o Variable conectores.

Una actividad de Salesforce se puede utilizar como un etapa 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 utilizarla en otro lugar (consulte Reutilización de componentes).

Otros patrones no son válidos si se utilizan actividades de Consulta de Salesforce. Consulte los patrones de validación en Validez de la operación página.

Dentro de una transformación, si se utiliza la opción para reflejar un esquema proporcionado por una actividad de Salesforce no masiva, entonces el esquema reflejado resultante se creará automáticamente con un nodo raíz adicional llamado records con los nodos secundarios reflejando el esquema. Cuando se asignan campos dentro de los nodos secundarios, el nodo se convierte en un nodo de bucle para permitir que todos los registros se recorra en bucle (consulte 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 caso de un error de SOAP (un error que resulta 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 después de que se produzca un error de SOAP. Para obtener instrucciones sobre cómo activar una acción en caso de un error de SOAP, consulte Acciones de operación.

Para utilizar la actividad con funciones de script, escriba los datos en una ubicación temporal y luego use esa ubicación temporal en la función de script.

Cuando esté listo, desplegar y ejecute la operación y valide el comportamiento verificando los registros de operación.

Ver archivos de éxito y fracaso

Si está ejecutando 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 Operaciones en tiempo de ejecución de la Management Console. Seleccione la operación correspondiente en la tabla Operaciones en tiempo de ejecución y haga clic en la pestaña Registros de actividad en la sección inferior de la pantalla para mostrar los enlaces de descarga de los archivos, si están disponibles:

• Descarga de archivo exitoso: Si está ejecutando la operación en un agente privado, haga clic en el enlace Descargar para guardar los registros de éxito como un archivo CSV.

• Descargar archivo de error: Si está ejecutando la operación en un agente privado, haga clic en el enlace Descargar para guardar los registros de fallas como un archivo CSV.