UKG Pro

Cómo configurar la integración de UKG Pro en ADManager Plus

Requisitos previos

• UKG Pro requiere una clave de API de cliente válida y una clave de API de usuario de una cuenta de servicio web.

Privilegios

Para importar usuarios (acción de entrada): Asegúrese de que la cuenta de usuario utilizada para la autorización tiene permiso para leer todas las cuentas de usuario.

Para realizar cualquier acción o consulta en UKG Pro (acción de salida): Asegúrese de que la cuenta utilizada para la autorización tiene permiso para realizar la acción deseada.

Configuración de la autorización

• Inicie sesión en ADManager Plus y vaya a Directorio/Ajustes de la aplicación.
• Vaya a Integraciones de aplicaciones, luego busque y seleccione UKG Pro CUSTOM.
• Active el botón Habilitar integración con UKG Pro CUSTOM.
• En la página de configuración de UKG Pro CUSTOM, haga clic en Autorización.
• Ingrese las credenciales de la cuenta de servicio.
• Haga clic en Configurar.

Configuración del webhook de entrada

El webhook de entrada le permite obtener datos de usuario de UKG Pro para ADManager Plus. La correlación de atributos configurada en esta sección se puede elegir como fuente de datos durante la configuración de la automatización para realizar la acción deseada en la lista de usuarios recibida de la respuesta de la API. Para configurar un webhook de entrada para UKG Pro:

• En el Webhook de entrada, haga clic en Configuración del endpoint de UKG Pro.
• En la pestaña Configuración del endpoint, un endpoint (ENDPOINT DE USUARIOS de UKG Pro) viene preconfigurado con los campos de URL del endpoint, Método de API, Cabeceras y Parámetros para obtener las cuentas de usuario de UKG Pro. Para utilizar este endpoint preconfigurado, remplace {Ultipro_webservice_URL} por la URL del servicio web de su instancia de UKG Pro y {customer_api_key} por la clave de API de cliente disponible en la página de ajustes de UKG Pro en el campo US-Customer-Api-Key. Si desea utilizar un nuevo endpoint para importar usuarios, puede configurar uno utilizando el botón + Añadir endpoint de la API y llenando los campos necesarios según las referencias de la API de UKG Pro. Haga clic aquí para saber cómo.



Nota:

• El par clave-valor de la API está preconfigurado como cabecera para autenticar las solicitudes de la API, tal y como se configuró durante la Configuración de la autorización.
• Macros: Puede añadir macros a la configuración del endpoint para modificarlo dinámicamente, según sus necesidades, utilizando el componente selector de macros. Haga clic aquí para obtener más detalles
• Consulte las referencias de la API de UKG Pro y configure cabeceras y parámetros adicionales, si es necesario
• Configure los parámetros para recuperar sólo el conjunto de usuarios necesario con base en dateTimeChanged o dateTimeCreated. Por ejemplo, añada el parámetro dateTimeChanged = >%act.timestamp_dd-MM-yyyy_afterNDays_2% para obtener los usuarios que se han modificado en los dos últimos días. Esto ayuda a reducir el tiempo necesario para las iteraciones de automatización, minimizando el número de registros procesados en cada iteración.
• Una vez hecho esto, haga clic en Probar y guardar. Una ventana de respuesta mostrará todos los parámetros solicitados que se pueden obtener con la llamada a la API. Haga clic en Proceder.

Nota:

• Consulte las referencias de la API de UKG Pro para conocer los parámetros que debe configurar para obtener sólo parámetros específicos.
• Puede configurar varios endpoints para UKG Pro utilizando el botón + Añadir endpoint de la API. Haga clic aquí para saber cómo.
• Para recuperar los detalles personales de un usuario, configure el Endpoint de detalles personales. Para los detalles de empleo, configure el Endpoint de detalles de empleo. Para obtener ambos detalles, configure ambos endpoints. Si necesita información adicional, configure el endpoint correspondiente según las referencias de la API de UKG Pro.
• Haga clic en Fuente de datos - Asignación de atributos LDAP para correlacionar endpoints y asignar atributos LDAP de AD con los atributos respectivos en UKG Pro.

[ADManager Plus también le permite personalizar el formato de los atributos de UKG Pro]



• Haga clic en + Añadir nueva configuración y haga lo siguiente:
  • Ingrese el Nombre de la configuración y la Descripción, y seleccione la Categoría de automatización en el menú desplegable.
  • En el campo Seleccionar endpoint, seleccione el endpoint deseado y una Clave principal que sea exclusiva de un usuario (por ejemplo, employeeIdentifier).
  Nota: Cuando se configuran varios endpoints, esta Clave principal debe tener el mismo valor en todos ellos.
  • En el campo Asignación de atributos, seleccione el atributo en el menú desplegable Nombre del atributo LDAP y asócielo con la columna correspondiente en UKG Pro.
  • Si desea crear un nuevo formato personalizado, haga clic en Asignación de atributos.
  • Haga clic en Guardar.
• Configure una automatización con la acción requerida, la frecuencia de repetición y la asignación de atributos configurada anteriormente.

Configuración del webhook de salida

El webhook de salida le permite actualizar los cambios realizados en AD enviando la información desde ADManager Plus a UKG Pro y sincronizarlos con AD. Para configurar el webhook de salida para UKG Pro:

• En el Webhook de salida, haga clic en Configuración del webhook de UKG Pro.
• Haga clic en + Añadir webhook.
• Ingrese un nombre y una descripción para este webhook.
• Decida la acción que se debe realizar y consulte las referencias de la API de UKG Pro para conocer los detalles de la API, como la URL, las cabeceras, los parámetros y otros requisitos que serán necesarios.
• En el menú desplegable, seleccione el método HTTP que le permitirá realizar la acción deseada en el endpoint.
• Ingrese la URL del endpoint.
• Configure las Cabeceras, Parámetros, y Tipo de mensaje en el formato adecuado en función de la llamada a la API que desee realizar.
• Haga clic en Probar y guardar.
• A continuación, una ventana emergente mostrará una lista de usuarios y grupos de AD para probar la llamada a la API configurada. Seleccione el usuario o grupo deseado en el que se debe probar esta solicitud de API y haga clic en Aceptar. Esto realizará una llamada en tiempo real a la URL del endpoint, y los objetos seleccionados se modificarán según la configuración.
• A continuación, se mostrarán la respuesta del webhook y los detalles de la solicitud. Compruebe que se ajustan al comportamiento esperado de la API y haga clic en Guardar.
• Los webhooks configurados se pueden integrar en plantillas de orquestación, lo que permite la automatización programada o basada en eventos para realizar consecutivamente la acción configurada en el webhook de salida entre varias acciones sobre un grupo de usuarios o sobre usuarios individuales.