Dayforce HCM (versión preliminar)
Se conecta a dayforce HCM API para recuperar la información personal de los empleados (contactos, direcciones, nombres) por código de referencia de empleado. Diseñado para administradores de RR. HH. y desarrolladores de poco código. Requiere un inquilino de Dayforce, credenciales de API (autenticación básica) y permisos adecuados. Solo lectura; Los códigos de referencia no válidos devuelven errores.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Dayforce |
| URL | https://www.dayforce.com/resources/help-center#support-for-employers |
| Correo electrónico | MicrosoftPartnership@dayforce.com |
| Metadatos del conector | |
|---|---|
| Publicador | Dayforce AI |
| Sitio web | https://www.dayforce.com/ |
| Directiva de privacidad | https://www.dayforce.com/privacy |
| Categorías | IA; Recursos humanos |
Dayforce HCM
Dayforce HCM es una plataforma de gestión de capital humano.
Este conector expone una operación de Dayforce API que le permite recuperar la información personal de un empleado (nombre, direcciones y detalles de contacto) mediante su código de referencia externo (XRefCode). Puede usar estos datos como una herramienta en los agentes de inteligencia artificial de Copilot Studio, así como en otros escenarios de Power Platform.
Publicador: Dayforce
Prerrequisitos
Para usar este conector, necesita lo siguiente:
- Un entorno de Microsoft Power Platform (por ejemplo, para usar el conector en Copilot Studio).
- Un entorno activo de Dayforce HCM (QA, UAT o Producción).
- Un usuario de Dayforce API (cuenta de servicio) con permiso para leer información personal del empleado.
- La dirección URL de API del entorno de Dayforce, incluido el espacio de nombres de cliente.
- Esta es la dirección URL base que se usa para llamar a Dayforce API para el inquilino, por ejemplo:
https://{environmentHost}/{basePath}/api/{clientNamespace} - El formato exacto depende de la configuración del entorno de Dayforce. Póngase en contacto con el administrador de Dayforce si no está seguro de la dirección URL.
- Esta es la dirección URL base que se usa para llamar a Dayforce API para el inquilino, por ejemplo:
Operaciones admitidas
Actualmente, el conector expone la siguiente operación.
Obtener información personal del empleado
Identificador de la operación:Get_Employee_Personal_Info
Método:GET
Recupera una vista filtrada y simplificada de la información personal de un solo empleado en función de su XRefCode.
Solicitud
-
Parámetro path
-
xRefCode(cuerda, requerida)
Código de referencia externo del empleado que se va a recuperar. El valor debe coincidir exactamente con el XRefCode de un empleado existente; de lo contrario, el servicio devuelve una solicitud incorrecta 400.
-
Internamente, el conector enruta la llamada al punto de conexión de Dayforce Employees mediante la dirección URL de API proporcionada en el momento de creación de la conexión y expande la información personal pertinente, que luego transforma el script del conector en un objeto JSON simplificado.
Respuesta
Si se ejecuta correctamente (HTTP 200), el conector no devuelve la carga completa de los empleados de Dayforce.
En su lugar, devuelve un objeto transformado con esta estructura:
{
"firstName": "string",
"lastName": "string",
"addresses": [
{
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"postalCode": "string",
"country": "string",
"state": "string",
"contactInformationType": "string"
}
],
"contacts": [
{
"personContactId": 0,
"contactInformationType": "string",
"electronicAddress": "string",
"contactNumber": "string",
"country": "string",
"effectiveStart": "2024-01-01T00:00:00Z"
}
]
}
Más concretamente:
campos de nivel superior
-
firstName– Nombre del empleado. -
lastName– Apellidos del empleado. -
addresses: lista de entradas de dirección filtradas. -
contacts: lista de entradas de contacto filtradas.
-
Objeto Address (
addresses[])-
address1– Línea de dirección principal. -
address2– Línea de dirección secundaria. -
address3– Línea de dirección adicional. -
city– Nombre de la ciudad. -
postalCode– Código postal o postal. -
country– Nombre del país (asignado a partir del nombre del país de Dayforce). -
state– Nombre de estado o provincia (asignado a partir del nombre de Dayforce State). -
contactInformationType– Nombre corto que describe el tipo de dirección (por ejemplo, "Inicio", "Correo"), basado en el tipo de información de contacto dayforce.
-
Objeto Contact (
contacts[])-
personContactId– Identificador numérico interno del registro de contacto. -
contactInformationType– Nombre corto que describe el tipo de contacto (por ejemplo, "Móvil", "Teléfono principal", "Correo electrónico de trabajo"). -
electronicAddress– Para contactos de estilo de "perfil en línea" (como correo electrónico u otras direcciones electrónicas). -
contactNumber– Para los contactos de estilo telefónico (por ejemplo, números móviles o de línea fija). -
country– Valor de país asociado al contacto (si procede). -
effectiveStart– Fecha de inicio efectiva de esta información de contacto (si está disponible).
-
Nota: El script del conector filtra intencionadamente la carga de Dayforce sin procesar.
Solo los campos mostrados anteriormente se exponen a los autores de llamadas de esta operación.
En caso de error, la API devuelve:
-
400 Solicitud incorrecta : para solicitudes con formato incorrecto o no válido
xRefCode. - 500 Error interno del servidor : para errores inesperados del lado servidor.
Las respuestas de error incluyen información de diagnóstico de dayforce API subyacente.
Obtención de credenciales
Este conector usa la autenticación básica para conectarse a Dayforce API.
Para obtener las credenciales necesarias:
Creación o identificación de un usuario de API en Dayforce
- Trabaje con su equipo de implementación o administrador de Dayforce.
- Asegúrese de que el usuario de la API tiene acceso de lectura a la información personal del empleado para su entorno.
Recopilación de los siguientes valores
DIRECCIÓN URL de API : la dirección URL de API base del inquilino de Dayforce, incluido el espacio de nombres de cliente. Esta es la dirección URL que usará el conector para enrutar las solicitudes al entorno de Dayforce. No incluya una barra diagonal final.
- Ejemplo:
https://{environmentHost}/{basePath}/api/{clientNamespace}
Importante: Algunos entornos de Dayforce usan una dirección URL universal (por ejemplo,
https://dayforcehcm.com/api/{clientNamespace}) que redirige automáticamente a una dirección URL específica del entorno (por ejemplo,https://us252-services.dayforcehcm.com/api/{clientNamespace}). Al configurar el conector, use siempre la dirección URL resuelta final en lugar de la dirección URL universal. Para determinar la dirección URL final, vaya a la página de documentación de Swagger del entorno (por ejemplo,https://dayforcehcm.com/api/{clientNamespace}/swagger/index.html) y observe la dirección URL a la que se redirige el explorador.- Ejemplo:
Nombre de usuario : nombre de usuario de Dayforce API.
Contraseña : contraseña de Dayforce API.
Uso de estos valores al crear una conexión de conector
- En el cuadro de diálogo conexión de Power Platform:
- Escriba la dirección URL de API del entorno de Dayforce.
- Escriba el nombre de usuario y la contraseña del usuario de Dayforce API.
- El conector usa la dirección URL de la API para enrutar las solicitudes al inquilino de Dayforce correcto y las credenciales para autenticar la llamada.
- En el cuadro de diálogo conexión de Power Platform:
Si no está seguro de la dirección URL de la API o de los detalles del usuario de la API, póngase en contacto con el soporte técnico de Dayforce o con el administrador interno de Dayforce.
Introducción
La manera recomendada de probar y usar este conector es agregarlo como una herramienta en un agente de INTELIGENCIA ARTIFICIAL de Copilot Studio.
1. Creación de una conexión
Antes de usar el conector en Copilot Studio, asegúrese de que existe una conexión:
- En la experiencia de administrador o creador de Power Platform, vaya a Conexiones de datos>.
- Seleccione + Nueva conexión.
- Busque el conector dayforce HCM (este conector).
- Cuando se le solicite, proporcione lo siguiente:
- DIRECCIÓN URL de API : la dirección URL de API base del inquilino de Dayforce (incluido el espacio de nombres de cliente). No incluya una barra diagonal final.
- Nombre de usuario: nombre de usuario de Dayforce API.
- Contraseña: contraseña de usuario de Dayforce API.
- Guarde la conexión.
2. Creación de un agente de IA en Copilot Studio y adición del conector como herramienta
- Abra Copilot Studio.
- Cree un nuevo agente de IA (o abra un agente existente en el que quiera usar los datos de Dayforce).
- Vaya a la sección Herramientas/complementos (o Conectores) del agente.
- Agregue el conector Dayforce HCM como herramienta.
- Asegúrese de que el conector usa la conexión que creó anteriormente.
3. Llamada al conector desde el agente de IA
- En la experiencia de creación del agente de IA:
- Cree o edite un tema, una acción o una llamada de complemento donde quiera que el agente recupere la información de los empleados.
- Configure una llamada de herramienta que use la operación Obtener información personal del empleado :
- Asigne la entrada del usuario (por ejemplo, "código de empleado") al
xRefCodeparámetro .
- Asigne la entrada del usuario (por ejemplo, "código de empleado") al
- Use los campos devueltos:
-
firstNameylastNamese pueden usar en las respuestas del agente de IA (por ejemplo, "Aquí está la dirección y la información de contacto de John Smith). - Use
addressesycontactsen la lógica del agente para mostrar o motivo sobre la dirección del empleado y los detalles de contacto.
-
Esta configuración permite que el agente de IA llame de forma segura al conector Dayforce HCM como una herramienta, recupere solo los campos filtrados e incorpore esos resultados en respuestas o toma de decisiones.
Problemas conocidos y limitaciones
Solo búsqueda de un solo empleado
La operación recupera los datos de un empleado a la vez, en función de XRefCode. Esta definición de conector no admite consultas o búsquedas masivas por otros atributos (como el nombre o el correo electrónico).Coincidencia exacta de XRefCode requerida
ElxRefCodeparámetro debe coincidir exactamente con el código de referencia externo de un empleado existente. Si el valor no es válido o no existe, el servicio devuelve una respuesta 400 Solicitud incorrecta.Operaciones de solo lectura
Esta versión del conector es de solo lectura. No admite la creación, actualización ni eliminación de información de los empleados.Configuración específica del entorno
El conector requiere una dirección URL válida de Dayforce API (proporcionada en el momento de creación de la conexión). Si la dirección URL no coincide con la configuración real del entorno de Dayforce, las llamadas producirán errores de conexión o enrutamiento. No incluya una barra diagonal final en la dirección URL de la API.Carga filtrada
La API de Dayforce subyacente devuelve muchos más campos de los que se exponen aquí. El script del conector filtra intencionadamente y vuelve a dar forma a estos datos solo enfirstName,lastName,addresses[]ycontacts[].La visibilidad de los datos depende de la configuración de Dayforce
Los campos y valores devueltos para un empleado dependen de cómo se configura el entorno de Dayforce (roles, seguridad y qué elementos de datos están habilitados o rellenados).
Preguntas más frecuentes
P1: ¿Para qué se usa el campo "DIRECCIÓN URL de API"?
La dirección URL de LA API es la dirección URL base del inquilino de Dayforce, incluido el espacio de nombres de cliente. El conector lo usa para enrutar todas las solicitudes de API al entorno de Dayforce correcto. La dirección URL no debe incluir una barra diagonal final.
Si no conoce este valor, póngase en contacto con el administrador de Dayforce o el equipo de implementación.
P2: ¿Qué ocurre si proporciono un valor no válido xRefCode?
xRefCode Si no coincide con un empleado existente, el servicio devuelve una respuesta 400 Solicitud incorrecta. El error subyacente de Dayforce API se muestra a través del conector.
P3: ¿Puedo recuperar varios empleados en una sola llamada?
No con esta definición de conector. La operación actual recupera la información personal de un solo empleado por llamada, en función del proporcionado xRefCode.
Instrucciones de implementación (CLI – paconn)
Puede implementar este conector como un conector personalizado mediante la CLI de Power Platform Connectors (paconn).
1. Preparar artefactos del conector
Asegúrese de que tiene los siguientes archivos en una carpeta local (por ejemplo, ./dayforce-hcm-connector):
apiDefinition.swagger.jsonapiProperties.jsonscript.csx
Deben coincidir con la estructura esperada por el marco de conector personalizado de Power Platform.
2. Instalación y configuración de la CLI
- Instale la CLI de Power Platform Connectors (
paconn) si aún no lo ha hecho. - Inicie sesión en el entorno o inquilino de destino mediante
paconnsegún la documentación de Microsoft (por ejemplo, mediantepaconn login).
3. Creación del conector
Ejecute un comando similar al siguiente:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx
- Asegúrese de ejecutar este comando en la carpeta que contiene los archivos del conector o proporcione rutas de acceso completas a cada archivo.
- Después de la creación, el conector aparecerá como un conector personalizado en el entorno de destino.
4. Actualice el conector (si es necesario)
Si posteriormente realiza cambios en apiDefinition.swagger.json, apiProperties.jsono script.csx, puede actualizar el conector existente con:
paconn update --api-def apiDefinition.swagger.json --api-prop apiProperties.json --script script.csx --connector-id <your-connector-id>
Reemplace <your-connector-id> por el identificador del conector que se creó.
5. Crear una conexión y usarla en Copilot Studio
Una vez implementado el conector:
- Vaya a Conexiones de datos> y cree una nueva conexión para el conector dayforce HCM mediante la dirección URL y las credenciales de Dayforce API.
- En Copilot Studio, agregue este conector como una herramienta al agente de IA y llame a la operación Obtener información personal del empleado , como se describe en la sección Introducción .
6. Seguridad y uso compartido de conexiones
Este conector usa un modelo de conexión que no se puede compartir. Cuando comparte un agente de Power App o Copilot Studio que usa este conector, solo el conector definition se comparte( each debe crear su propia conexión dayforce con sus propias credenciales al usarse primero. Las conexiones no se pueden compartir de una manera que permita que otro usuario reutilice los permisos dayforce de un usuario. Todos los tipos de autenticación se configuran como No se puede compartir, por lo que el uso compartido de conexiones se bloquea en el nivel de plataforma y cada usuario siempre es necesario para establecer su propia conexión de Dayforce.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Obtener información personal del empleado |
Esta operación recupera datos relacionados con un empleado y su información personal (por ejemplo, nombre, direcciones y contactos) por código XRef |
Obtener información personal del empleado
Esta operación recupera datos relacionados con un empleado y su información personal (por ejemplo, nombre, direcciones y contactos) por código XRef
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Código de referencia de empleado
|
xRefCode | True | string |
Identificador único (código de referencia externo) del empleado que se va a recuperar. El valor proporcionado debe ser la coincidencia exacta para un empleado; De lo contrario, se devolverá un error de solicitud incorrecta (400). |
Devoluciones
- Body
- Payload_Employee
Definiciones
ProcessResult
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | string | |
|
Context
|
Context | string | |
|
Level
|
Level | string | |
|
Mensaje
|
Message | string |
Empleado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificación de empleado
|
EmployeeId | integer | |
|
Contactos
|
Contacts | PersonContactCollection | |
|
Direcciones
|
Addresses | PersonAddressCollection | |
|
GlobalPersonId
|
GlobalPersonId | string | |
|
XRefCode
|
XRefCode | string | |
|
NewXRefCode
|
NewXRefCode | string | |
|
Nombre Común
|
CommonName | string | |
|
DisplayName (Nombre para mostrar)
|
DisplayName | string | |
|
Primer Nombre
|
FirstName | string | |
|
LastName
|
LastName | string | |
|
Initials
|
Initials | string | |
|
MaidenName
|
MaidenName | string | |
|
Segundo nombre
|
MiddleName | string | |
|
Título
|
Title | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
PersonContactCollection
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
Items | array of PersonContact |
PersonAddressCollection
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
Items | array of PersonAddress |
PersonContact
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
PersonContactId
|
PersonContactId | integer | |
|
ContactInformationType
|
ContactInformationType | ContactInformationType | |
|
ContactNumber
|
ContactNumber | string | |
|
País
|
Country | Country | |
|
EffectiveEnd
|
EffectiveEnd | date-time | |
|
EffectiveStart
|
EffectiveStart | date-time | |
|
ElectronicAddress
|
ElectronicAddress | string | |
|
Extension
|
Extension | string | |
|
IsForSystemCommunications
|
IsForSystemCommunications | boolean | |
|
IsPreferredContactMethod
|
IsPreferredContactMethod | boolean | |
|
IsUnlistedNumber
|
IsUnlistedNumber | boolean | |
|
FormattedNumber
|
FormattedNumber | string | |
|
IsVerified
|
IsVerified | boolean | |
|
IsRejected
|
IsRejected | boolean | |
|
ShowRejectedWarning
|
ShowRejectedWarning | boolean | |
|
NumberOfVerificationRequests
|
NumberOfVerificationRequests | integer | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
PersonAddress
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
PersonAddressId
|
PersonAddressId | integer | |
|
Address1
|
Address1 | string | |
|
Address2
|
Address2 | string | |
|
Address3
|
Address3 | string | |
|
Address4
|
Address4 | string | |
|
Address5
|
Address5 | string | |
|
Address6
|
Address6 | string | |
|
Ciudad
|
City | string | |
|
Código postal
|
PostalCode | string | |
|
País
|
Country | Country | |
|
Estado
|
State | State | |
|
ContactInformationType
|
ContactInformationType | ContactInformationType | |
|
IsPayrollMailing
|
IsPayrollMailing | boolean | |
|
DisplayOnTaxForm
|
DisplayOnTaxForm | boolean | |
|
DisplayOnEarningStatement
|
DisplayOnEarningStatement | boolean | |
|
EffectiveStart
|
EffectiveStart | date-time | |
|
EffectiveEnd
|
EffectiveEnd | date-time | |
|
Condado
|
County | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
País
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
Name | string | |
|
XRefCode
|
XRefCode | string | |
|
Nombre corto
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
ContactInformationType
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ContactInformationTypeGroup
|
ContactInformationTypeGroup | ContactInformationTypeGroup | |
|
XRefCode
|
XRefCode | string | |
|
Nombre corto
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
Estado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
Name | string | |
|
XRefCode
|
XRefCode | string | |
|
Nombre corto
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
ContactInformationTypeGroup
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
XRefCode
|
XRefCode | string | |
|
Nombre corto
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
Payload_Employee
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Datos
|
Data | Employee | |
|
ProcessResults
|
ProcessResults | array of ProcessResult |