Introducción a la API de integración de nóminas

Note

Para que la integración de nóminas funcione para los clientes que usan las entidades mshr para Ceridian Dayforce, vaya a Integración de nóminas basada en API con Ceridian Dayforce.

Se aplica a estas aplicaciones de Dynamics 365:
Recursos humanos

Este artículo describe la API de integración de nóminas de Dynamics 365 Human Resources. La API permite integraciones optimizadas de un extremo a otro entre los recursos humanos y los sistemas de nómina asociados. La experiencia integrada comienza en Recursos Humanos con el perfil del empleado, salario y deducción e información de cotización. Cuando contrata a un empleado e ingresa el perfil requerido y la información de pago en Recursos Humanos, el sistema de nómina extrae esta información para usarla al procesar la nómina. Cualquier actualización realizada al empleado o la información de pago también se extrae para su uso en ejecuciones de pago posteriores.

Flujo de integración de nóminas.

Arquitectura técnica y flujo

El siguiente diagrama ilustra el flujo de integración técnica desde Finanzas y Operaciones a través de Microsoft Dataverse hasta el proveedor externo de nóminas:

Diagrama que muestra el flujo de integración de nóminas desde entidades de datos de Finanzas y Operaciones a través de la configuración de Dataverse hasta las APIs OData para proveedores de nóminas.

Modelo de datos

El siguiente diagrama ilustra las relaciones dentro de la API. Diversos tipos tienen claves extranjeras para otras entidades preexistentes en Recursos Humanos que no se ilustran aquí. Este documento proporciona información sobre las entidades específicas para los escenarios de integración de nóminas. Sin embargo, hay muchas otras entidades en la API web de Dataverse para Recursos Humanos que también podrían ser relevantes para tu integración. Algunas de estas entidades están referenciadas en relaciones de clave externa o propiedades de navegación.

Diagrama de las entidades de la API de nóminas vinculadas por PersonnelNumber, PositionId, PlanId y JobId, incluyendo empleado, puesto y plan de compensación.

Microsoft Dataverse

Esta API está construida sobre Microsoft Dataverse utilizando tablas virtuales. Realizas toda la interacción RESTful con esta API a través de la API Web de Microsoft Dataverse (OData), que gestiona la autenticación, los SLAs, el procesamiento por lotes, el control de concurrencia y el seguimiento de cambios.

Para más información sobre la API web de Dataverse, véase:

Habilitar la integración

Para habilitar y utilizar la API de integración de nóminas, complete los siguientes cuatro pasos en orden:

Paso 1: Configurar el trabajo por lotes
Paso 2: Habilitar entidades virtuales
Paso 3: Registrar la aplicación de Azure AD
Paso 4: Añadir la app a Dataverse

Paso 1: Configurar el trabajo por lotes

Antes de que las entidades virtuales puedan sincronizar datos, programa el trabajo por lotes de sincronización de datos de nómina en Dynamics 365 Human Resources. Este trabajo prepara y organiza los datos de nómina para su integración.

Para obtener instrucciones detalladas sobre cómo configurar la recurrencia del proceso por lotes y seleccionar entidades, consulte Programar el trabajo de sincronización de datos de nómina.

Paso 2: Habilitar entidades virtuales

Los endpoints de la API de integración de nóminas utilizan las capacidades de tabla virtual de Microsoft Dataverse. Por defecto, el sistema no despliega las tablas virtuales ni sus endpoints API asociados para entornos de Recursos Humanos.

  1. Asegúrate de que el sistema esté configurado con las soluciones de tablas virtuales y fuentes de datos necesarias. Para más información, consulte Configurar tablas virtuales Dataverse o Referencia de administrador para entidades virtuales.
  2. Inicie sesión en Power Apps Maker Portal.
  3. En la esquina superior derecha, selecciona el entorno adecuado.
  4. En el panel de navegación izquierdo, selecciona Tablas y luego selecciona Todo.
  5. Filtra la columna Tabla para la Entidad Financiera y de Operaciones Disponible.
  6. Selecciona la tabla y selecciona Editar en la barra de herramientas.
  7. Busca las entidades de integración de nóminas (con el prefijo PayIntV). Establece tanto Visible como seguimiento de cambios en Sí. Si ocurre un error, selecciona la fila y selecciona Editar fila usando el formulario en la barra de herramientas para actualizar la configuración.
  8. Repite estos pasos para todas las entidades de integración de nóminas necesarias.

Paso 3: Registrar la aplicación de Azure AD

Registrar una aplicación en Azure Active Directory (Microsoft Entra ID) para que la Plataforma de identidad de Microsoft pueda ofrecer servicios de autenticación y autorización para llamadas a la API.

  1. Abra el portal de Azure.
  2. En la lista de servicios de Azure, seleccione Registros de aplicación.
  3. Seleccione Nuevo registro.
  4. En el campo Nombre, introduce un nombre descriptivo para la aplicación (por ejemplo, Dynamics 365 Human Resources Virtual Tables).
  5. Seleccione Registrar.
  6. Fíjate en el ID de la aplicación (cliente) que aparece en el panel de Resumen del registro de la app.
  7. En el panel de navegación izquierdo, seleccione Certificados y secretos.
  8. En la sección Secretos de cliente, seleccione Nuevo secreto de cliente.
  9. Introduce una descripción, elige una duración de caducidad y selecciona Añadir.
  10. Registre el valor del secreto.

    Importante

    Registra el valor del secreto inmediatamente. No volverá a mostrarse después de que te alejes de esta página.

Para más información, consulte Inicio rápido: Registrar una aplicación en la plataforma de identidad de Microsoft.

Paso 4: Añadir la app a Dataverse

Añade la aplicación registrada como usuario de aplicación en Dataverse y encázala en Finanzas y Operaciones:

  1. Inicie sesión en el Centro de administración de Power Platform.
  2. En el panel de navegación, selecciona Gestionar>entornos y selecciona tu entorno.
  3. Selecciona Configuración>Usuarios + permisos>Usuarios de la aplicación.
  4. Selecciona Nuevo usuario de la aplicación, selecciona Añadir una aplicación y selecciona el ID de la aplicación (cliente) registrado en el Paso 3.
  5. Selecciona la unidad de negocio y asigna los roles de seguridad Usuario básico y Usuario básico de Finanzas y Operaciones al usuario de la aplicación.
  6. En la aplicación de Finance and Operations, ve a Administración del sistema>>Aplicaciones de Microsoft Entra ID.
  7. Selecciona Nuevo e introduce el ID del cliente y el nombre de la aplicación.
  8. En el campo ID de usuario , selecciona un usuario que tenga permiso para leer y escribir las entidades de integración de nóminas, y guarda el registro.

Cuando completas la configuración, los endpoints OData estarán listos para que el proveedor de nóminas lea y escriba datos. Para más detalles sobre las entidades disponibles y sus esquemas, consulte Empleado de nómina y entidades relacionadas.

Entidades:

Consulte también

Configurar parámetros de Human Resources
Configurar parámetros compartidos de Human Resources
¿Qué es Microsoft Dataverse?
Utilizar la API web de Microsoft Dataverse