Actividad de Consulta de Salesforce

Introducción

Una actividad de Consulta de Salesforce, utilizando su conexión de Salesforce, consulta datos de Salesforce y está destinada a ser utilizada como una fuente para proporcionar datos en una operación.

Crear una actividad de Consulta de Salesforce

Una instancia de una actividad de Consulta de Salesforce se crea a partir de una conexión de Salesforce utilizando su tipo de actividad Consulta.

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

Una actividad de Consulta de Salesforce existente se puede editar desde estas ubicaciones:

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

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

Configurar una actividad de Consulta de Salesforce

Siga estos pasos para configurar una actividad de Consulta de Salesforce:

• Paso 1: Ingrese un nombre y seleccione objetos
  Proporcione un nombre para la actividad y seleccione el(los) objeto(s) a consultar.

• Paso 2: Seleccione campos y cree condiciones
  Cree 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: Revisar los esquemas de datos
  Cualquier esquema de solicitud o respuesta generado desde el endpoint se muestra.

Paso 1: Ingresar un nombre y seleccionar objetos

En este paso, se proporciona un nombre para la actividad y se selecciona el(los) objeto(s) a consultar.

• 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 (/) ni dos puntos (:).

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

  • Copiar: Haga clic en el ícono Copiar configuración de actividad para copiar la configuración existente de este paso y del paso 2 en su portapapeles. La copia está habilitada solo después de que se haya validado una consulta en el paso 2 utilizando el botón Probar Consulta.

  • Pegar: Haga clic en el ícono Pegar configuración de actividad para pegar una configuración existente que se haya copiado de este paso o del paso 2. Cuando intente pegar una consulta, se muestra un cuadro de diálogo de confirmación indicando que cualquier configuración existente en los pasos 1 y 2 será sobrescrita.

    Consejo

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

  • Ver: Use el menú desplegable para filtrar la lista de objetos a todos los objetos, objetos estándar u objetos personalizados. Por defecto, 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 actualizar para recargar los objetos desde el endpoint de Salesforce. Esto es útil si recientemente agregó objetos a Salesforce que no son visibles en la lista de 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 llena con los objetos disponibles, tenga en cuenta los siguientes consejos de solución de problemas:

    • La conexión de Salesforce puede no ser exitosa. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

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

      Nombre de usuario, contraseña, token de seguridad inválidos; o usuario bloqueado. [INVALID_LOGIN]
      

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

• Seleccionar Objeto(s) Relacionado(s): Opcionalmente, para incluir objetos hijos o padres en la consulta, seleccione la casilla junto a cada objeto relacionado que desee incluir. Esto se conoce como una consulta de relación.

  Nota

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

  • Actualizar: Haga clic en el ícono de actualizar para recargar los campos en los objetos relacionados para esta actividad desde el punto final de Salesforce. Las selecciones existentes en Seleccionar Objeto(s) Relacionado(s) permanecen solo si esos objetos se utilizan en el paso 2. Cualquier objeto que no se utilice en el paso 2 tiene su selección despejada.

• Previsualizar Campos: Para previsualizar campos de un objeto específico, haga clic directamente en el nombre del objeto bajo Seleccionar Objeto(s) Relacionado(s). Tenga en cuenta que habilitar la previsualización de campos es independiente de qué casillas de verificación de campos están seleccionadas. Es decir, puede previsualizar campos para 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: 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 asegurarte de que sea válida antes de proceder al siguiente paso.

• Seleccionar Campos y Crear Condiciones: Esta sección muestra los campos para el(los) objeto(s) seleccionado(s) que están disponibles en el endpoint de Salesforce. Los objetos que se seleccionaron en el paso anterior se muestran en negrita.

  • Buscar: Ingresa 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 listados se filtran en tiempo real con cada pulsación de tecla.

  • Seleccionar Todo: Al usar el cuadro de búsqueda para filtrar, puedes usar esta casilla de verificación para seleccionar todos los campos visibles a la vez (los objetos y los campos colapsados no se seleccionan).

  • Seleccionar Campos: Selecciona las casillas de verificación de los campos que deseas incluir en la consulta para que se agreguen automáticamente a la declaración SOQL a 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.

• Declaración SOQL: A medida que seleccionas campos, la declaración de consulta en el cuadro de texto en la parte superior derecha se completa automáticamente con el objeto y los campos seleccionados. Para usar una declaración SOQL personalizada, realiza las ediciones necesarias dentro de este cuadro de texto. Para referencia sobre cómo estructurar una declaración SOQL personalizada, consulta la documentación de Salesforce sobre Sintaxis SOQL SELECT.

• Incluir Filas Eliminadas: Selecciona esta casilla para incluir filas que están 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 ícono Copiar configuración de actividad para copiar la configuración existente de este paso y paso 1 en tu portapapeles. La copia está habilitada solo después de que una consulta ha sido validada usando el botón Probar Consulta.

• Pegar: Haz clic en el ícono Pegar configuración de actividad para pegar una configuración existente que ha sido copiada de este paso o paso 1. Cuando intentas pegar una consulta, se muestra un cuadro de diálogo de confirmación indicando que cualquier configuración existente en los pasos 1 y 2 será sobrescrita.

  Consejo

  Los botones Copiar y Pegar también se pueden usar en diferentes instancias de la actividad Consulta 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 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, utiliza 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 usando 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(los) operador(es) apropiado(s). La lista de operadores disponibles depende del tipo de dato del campo seleccionado.

    Comparación
    =	Igual
    !=	No igual
    <	Menor que
    <=	Menor o igual que
    >	Mayor que
    >=	Mayor o igual que
    LIKE	Como
    IN	EN
    NOT IN	NO EN
    INCLUDES	Aplica solo a listas de selección múltiple
    EXCLUDES	Aplica solo a listas de selección múltiple

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

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

    Advertencia

    Al usar variables globales en una cláusula WHERE, debe 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 (ver Definir un valor predeterminado en Variables globales).

• Agregar: Haga clic en el enlace para construir automáticamente la cláusula basada en 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, repita el proceso agregando selecciones adicionales. Tenga en cuenta que puede necesitar agregar un operador lógico como AND o OR para tener en cuenta las condiciones adicionales.

• Regresar: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.

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

• Descartar Cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pide que confirme que desea 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 mostrarán nuevamente más adelante durante el proceso de mapeo de transformaciones, donde puede mapear a campos de destino utilizando 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é 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 a través de cada paso de configuración de actividad nuevamente, realizando al menos un cambio (como agregar y eliminar un carácter del 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 regresar al paso anterior.

• Terminado: 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.

Siguientes 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 contenga 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 la configuración de la operación, que incluye la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

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

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

• Patrón de archivo
• Patrón de transformación
• Patrón de archivo de dos objetivos (como la primera o segunda fuente)
• Patrón de dos transformaciones (como la primera o segunda fuente)

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

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

Una actividad de Salesforce puede usarse como un paso de operación en solo una operación. Es decir, no se puede hacer referencia a la misma actividad múltiples veces dentro de otras operaciones. En su lugar, se puede hacer una copia de una actividad de Salesforce para usarla en otro lugar (ver Reutilización de componentes).

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

Dentro de una transformación, si se utiliza la opción de reflejar un esquema proporcionado por una actividad de Salesforce que no es de carga masiva, entonces el esquema reflejado resultante se creará automáticamente con un nodo raíz adicional llamado records con el(los) nodo(s) hijo(s) reflejando el esquema. Cuando los campos dentro del(los) nodo(s) hijo(s) se mapean, el nodo se convierte en un nodo de bucle para permitir que todos los registros se recorran (ver Nodos de bucle bajo 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 encabezados o incompatibilidad. Las acciones de operación pueden configurarse para ejecutar una operación o enviar un correo electrónico después de que ocurra un error SOAP. Para instrucciones sobre cómo activar una acción en un error SOAP, consulte 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és listo, despliega y ejecuta la operación y valida el comportamiento revisando los registros de la operación.

Ver archivos de éxito y fracaso

Si estás ejecutando una operación que contiene una actividad de Salesforce en un agente privado, los archivos de éxito y fracaso están disponibles para descarga en la página de Operaciones en Tiempo de Ejecución de la Consola de Administración. Selecciona la operación relevante en la tabla de Operaciones en Tiempo de Ejecución y haz 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:

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

• Descargar Archivo de Fracaso: Si estás ejecutando la operación en un agente privado, haz clic en el enlace Descargar para guardar los registros de fracaso como un archivo CSV.