Actividad de consulta de SAP SuccessFactors en Jitterbit Studio
Introducción
Una actividad de Consulta de SAP SuccessFactors, utilizando su conexión de SAP SuccessFactors, recupera datos de objetos de SAP SuccessFactors y está destinada a ser utilizada como fuente para proporcionar datos en una operación.
Crear una actividad de consulta de SAP SuccessFactors
Una instancia de una actividad de Consulta de SAP SuccessFactors se crea a partir de una conexión de SAP SuccessFactors 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 SAP SuccessFactors 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 SAP SuccessFactors
Siga estos pasos para configurar una actividad de Consulta de SAP SuccessFactors:
-
Paso 1: Ingrese un nombre y seleccione un objeto
Proporcione un nombre para la actividad y seleccione un objeto. -
Paso 2: Seleccione un subobjeto
Seleccione un subobjeto. -
Paso 3: Defina una cadena de filtro
Establezca condiciones para una consulta sobre los objetos seleccionados. -
Paso 4: Revise los esquemas de datos
Se mostrarán los esquemas de solicitud o respuesta.
Paso 1: Ingrese un nombre y seleccione un objeto
En este paso, proporcione un nombre para la actividad y seleccione un objeto. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
-
Menú de puntos finales: Si tiene múltiples puntos finales del mismo tipo de conector configurados, un menú en la parte superior de la pantalla muestra el nombre del punto final actual. Haga clic en el menú para cambiar a un punto final diferente. Para obtener más información, consulte Cambiar el punto final asignado en Pantallas de configuración.
- Editar punto final: Aparece cuando pasa el cursor sobre el nombre del punto final actual. Haga clic para editar la configuración de conexión del punto final seleccionado actualmente.
-
Nombre: Ingrese un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Consulta de SAP SuccessFactors y no debe contener barras diagonales
/o dos puntos:. -
Seleccionar un objeto: Esta sección muestra los objetos disponibles en el punto final de SAP SuccessFactors.
-
Objeto seleccionado: Después de seleccionar un objeto, se lista aquí.
-
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. Si los objetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el punto final al buscar, ingrese criterios de búsqueda y luego actualice, como se describe a continuación.
-
Actualizar: Haga clic en el ícono de actualizar o en la palabra Actualizar para recargar objetos desde el punto final de SAP SuccessFactors. Esto puede ser útil si se han agregado objetos a SAP SuccessFactors. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrada en la configuración.
-
Seleccionando un objeto: Dentro de la tabla, haga clic en cualquier parte de una fila para seleccionar un objeto. Solo se puede seleccionar un objeto. La información disponible para cada objeto se obtiene del punto final de SAP SuccessFactors:
- Nombre: El nombre del objeto
Consejo
Si la tabla no se llena con los objetos disponibles, la conexión a SAP SuccessFactors puede no ser exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.
-
-
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 pedirá que confirmes que deseas descartar los cambios.
Paso 2: Seleccionar un subobjeto
En este paso, selecciona un subobjeto. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
-
Seleccionar un Subobjeto: Esta sección muestra los subobjetos disponibles en el endpoint de SAP SuccessFactors.
-
Objeto Seleccionado: El objeto seleccionado en el paso anterior se lista aquí.
-
Subobjeto Seleccionado: Después de seleccionar un subobjeto, se lista aquí.
-
Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de subobjetos. La búsqueda no distingue entre mayúsculas y minúsculas. Si los subobjetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar subobjetos desde el endpoint al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.
-
Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para recargar subobjetos desde el endpoint de SAP SuccessFactors. Esto puede ser útil si se han agregado subobjetos a SAP SuccessFactors. Esta acción actualiza todos los metadatos utilizados para construir la tabla de subobjetos mostrada en la configuración.
-
Seleccionando un Subobjeto: Dentro de la tabla, haz clic en cualquier parte de una fila para seleccionar un subobjeto. Solo se puede seleccionar un subobjeto. La información disponible para cada subobjeto se obtiene del endpoint de SAP SuccessFactors:
-
Nombre: El nombre del subobjeto.
-
Descripción: La descripción del subobjeto.
-
Consejo
Si la tabla no se llena con los subobjetos disponibles, la conexión de SAP SuccessFactors puede no ser exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.
-
-
Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar 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.
-
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 pedirá que confirmes que deseas descartar los cambios.
Paso 3: Definir una cadena de filtro
En este paso, se define una Cadena de Filtro para una consulta utilizando los campos de objeto disponibles y la configuración de la consulta. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
La interfaz utilizada en este paso de la configuración de una actividad de Consulta de SAP SuccessFactors depende de la pestaña seleccionada:
-
Básico: Esta opción te permite construir la Cadena de Filtro con campos guiados.
-
Avanzado: Esta opción oculta los campos guiados y te permite modificar la Cadena de Filtro directamente.
Básico
Si se selecciona la pestaña Básico, se presenta la interfaz descrita a continuación.
Consejo
Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comienza escribiendo un corchete cuadrado abierto [ en el campo o haciendo clic en el ícono de variable para mostrar un menú que enumera las variables existentes de las que puedes elegir.
-
Campos de Objeto: Selecciona los campos que se utilizarán en la consulta según la clase de objeto seleccionada.
-
Buscar: Introduzca cualquier parte del nombre de un campo en el cuadro de búsqueda para filtrar la lista de campos del objeto seleccionado. 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.
-
Actualizar: Haga clic en el ícono de actualizar o en la palabra Actualizar para recargar los campos del objeto desde el endpoint de SAP SuccessFactors.
-
Seleccionar Todo en Clase de Objeto: 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.
-
Seleccionar Campos: Seleccione las casillas de verificación de los campos que desea incluir en la consulta para que se agreguen automáticamente a la Cadena de Filtro. También puede seleccionar todos los campos a la vez usando la casilla de verificación principal.
-
Tamaño de Página: Introduzca un tamaño de página para habilitar la paginación de resultados. El número de resultados en una página totalizará hasta el tamaño especificado. También se incluirá un enlace a la siguiente página de resultados en la respuesta.
-
Incluir Conteo: Seleccione para incluir el número de resultados de una consulta como parte de la respuesta.
-
Búsqueda de Texto Completo: Introduzca términos de búsqueda para consultar objetos en la clase de objeto seleccionada. El endpoint de SAP SuccessFactors maneja cómo se interpreta la búsqueda para una clase de objeto.
-
Omitir: Introduzca un número de resultados a omitir en la respuesta de la consulta.
-
Máximo: Introduzca un número máximo de resultados a recibir en la respuesta de la consulta.
-
Cláusulas Condicionales: Para agregar condicionales, use estos campos como entrada para ayudar a construir las cláusulas, que luego aparecerán en la Cadena de Filtro.
-
Objeto: Use el menú desplegable para seleccionar la clase de objeto que se utilizará para el condicional.
-
Campo: Use el menú desplegable para seleccionar el campo de la clase de objeto que se utilizará para el condicional.
-
Operador: Use el menú desplegable para seleccionar un operador apropiado:
Comparación Igual Mayor Que Mayor Que o Igual Menor Que Menor Que o Igual -
Valor: Ingresa el valor deseado para comparar con las selecciones del menú desplegable anterior.
-
Eliminar: Haz clic en el ícono de eliminar para quitar la condición de la tabla.
-
Agregar: Haz clic para añadir una nueva condición a la tabla y Cadena de Filtro.
-
Eliminar Todo: Haz clic para eliminar todas las condiciones de la tabla y Cadena de Filtro.
-
-
Cadena de Filtro: A medida que completes los otros campos en la pestaña Básica, la declaración de la cadena de filtro en este cuadro de texto se llena automáticamente con los campos seleccionados, condiciones y opciones de consulta.
Importante
Debido a una limitación del conector, si hay más de un filtro presente en la Cadena de Filtro, la operación fallará en tiempo de ejecución.
-
-
Probar Consulta: Haz clic para validar la consulta.
-
Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar 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.
-
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 pedirá que confirmes que deseas descartar los cambios.
Avanzado
Si se selecciona la pestaña Avanzado, se presenta la interfaz descrita a continuación.
Consejo
Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comienza escribiendo un corchete cuadrado abierto [ en el campo o haciendo clic en el ícono de variable para mostrar un menú con las variables existentes para elegir.
-
Campos de Objeto: Selecciona los campos que se utilizarán en la consulta según la clase de objeto seleccionada.
-
Tamaño de Página: Ingresa un tamaño de página para habilitar la paginación de resultados. El número de resultados en una página totalizará hasta el tamaño especificado. También se incluirá un enlace a la siguiente página de resultados en la respuesta.
-
Cadena de Filtro: Edita la declaración de la cadena de filtro directamente.
Importante
Debido a una limitación del conector, si hay más de un filtro presente en la Cadena de Filtro, la operación fallará en tiempo de ejecución.
-
Consulta de Prueba: Haz clic para validar la consulta. Si la consulta es válida, se muestra una muestra de hasta 10 registros recuperados de la consulta en una tabla. Si la consulta no es válida, se muestran mensajes de error relevantes. Si editas la cadena de filtro mientras estás en modo Avanzado, la consulta debe ser válida y validada a través de este botón para habilitar el botón Siguiente.
-
-
Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar 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.
-
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 4: Revisar los esquemas de datos
Cualquier esquema de solicitud o respuesta se muestra. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
-
Esquemas de Datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante mapeo de transformaciones.
El conector de SAP SuccessFactors utiliza la API OData v2 de SAP SuccessFactors HXM Suite. Consulta la documentación de la API para obtener información sobre los nodos y campos del esquema.
La actividad Consulta utiliza JSON en su esquema de respuesta.
-
Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para regenerar esquemas desde el punto final de SAP SuccessFactors. Esta acción también regenera un esquema en otras ubicaciones a lo largo del proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.
-
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 SAP SuccessFactors, completa la configuración de la operación añadiendo y configurando otras actividades o herramientas como pasos de operación. También puedes configurar los ajustes de la operación, que incluyen 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 del conector.
Las actividades de Consulta de SAP SuccessFactors se pueden utilizar como fuente con estos patrones de operación:
- Patrón de transformación
- Patrón de archivo de dos objetivos (como la primera fuente únicamente)
- Patrón de archivo HTTP de dos objetivos (como la primera fuente únicamente)
- Patrón de dos transformaciones (como la primera fuente únicamente)
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, despliegue y ejecute la operación y valide el comportamiento revisando los registros de la operación.