Dayforce HCM (förhandsversion)

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Service	Class	Regioner
Copilot Studio	Premium	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Standard	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premium	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premium	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
Namn	Dayforce-support
URL	https://www.dayforce.com/resources/help-center#support-for-employers
E-postmeddelande	MicrosoftPartnership@dayforce.com

Metadata för anslutningsprogram
Publisher	Dayforce AI
Webbplats	https://www.dayforce.com/
Sekretesspolicy	https://www.dayforce.com/privacy
Kategorier	AI; Personal

Dayforce HCM

Dayforce HCM är en plattform för hantering av humankapital.
Den här anslutningsappen exponerar en Dayforce API-åtgärd som gör att du kan hämta en anställds personliga information (namn, adresser och kontaktuppgifter) med deras externa referenskod (XRefCode). Du kan använda dessa data som ett verktyg i Copilot Studio AI-agenter samt i andra Power Platform-scenarier.

Utgivare: Dayforce

---

Förutsättningar

Om du vill använda den här anslutningsappen behöver du:

• En Microsoft Power Platform-miljö (till exempel för att använda anslutningsappen i Copilot Studio).
• En aktiv Dayforce HCM-miljö (QA, UAT eller Produktion).
• En Dayforce API-användare (tjänstkonto) med behörighet att läsa personalinformation för anställda.
• API-URL:en för din Dayforce-miljö, inklusive klientnamnområdet.
  • Det här är den bas-URL som används för att anropa Dayforce-API:et för din klientorganisation, till exempel:
    https://{environmentHost}/{basePath}/api/{clientNamespace}
  • Det exakta formatet beror på din Dayforce-miljökonfiguration. Kontakta Dayforce-administratören om du är osäker på URL:en.

---

Åtgärder som stöds

Anslutningsappen exponerar för närvarande följande åtgärd.

Hämta personalinformation för medarbetare

Åtgärds-ID:Get_Employee_Personal_Info
Metod:GET

Hämtar en filtrerad, förenklad vy av personlig information för en enskild anställd baserat på deras XRefCode.

Förfrågan

• Sökvägsparameter
  • xRefCode (sträng, krävs)
    Den externa referenskoden för den medarbetare som ska hämtas. Värdet måste exakt matcha en befintlig medarbetares XRefCode. annars returnerar tjänsten en 400 felaktig begäran.

Internt dirigerar anslutningsappen anropet till Dayforce Employees-slutpunkten med hjälp av API-URL:en som angavs när anslutningen skapades och expanderar relevant personlig information som sedan omvandlas av anslutningsappens skript till ett effektiviserat JSON-objekt.

Svar

Vid lyckat resultat (HTTP 200) returnerar anslutningsappen inte hela Dayforce-medarbetarens nyttolast.
I stället returneras ett transformerat objekt med den här strukturen:

{
  "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"
    }
  ]
}

Mer specifikt:

• Fält på den översta nivån

  • firstName – Medarbetarens förnamn.
  • lastName – Medarbetarens efternamn.
  • addresses – En lista över filtrerade adressposter.
  • contacts – En lista över filtrerade kontaktposter.

• Adressobjekt (addresses[])

  • address1 – Primär adressrad.
  • address2 – Sekundär adressrad.
  • address3 – Ytterligare adressrad.
  • city – Ortnamn.
  • postalCode – Postnummer eller postnummer.
  • country – Landsnamn (mappat från Dayforce Country-namnet).
  • state – Namn på delstat eller provins (mappat från Dayforce State-namnet).
  • contactInformationType – Kort namn som beskriver typen av adress (till exempel "Home", "Mailing"), baserat på dayforce-kontaktinformationstypen.

• Kontaktobjekt (contacts[])

  • personContactId – Intern numerisk identifierare för kontaktposten.
  • contactInformationType – Kort namn som beskriver typen av kontakt (till exempel "Mobile", "Home Phone", "Work Email").
  • electronicAddress – För "onlineprofil" stil kontakter (till exempel e-post eller andra elektroniska adresser).
  • contactNumber – För telefonliknande kontakter (till exempel mobilnummer eller fasta nummer).
  • country – Landvärde som är associerat med kontakten (i förekommande fall).
  • effectiveStart – Gällande startdatum för denna kontaktinformation (om tillgängligt).

Obs! Anslutningsappens skript filtrerar avsiktligt den råa Dayforce-nyttolasten.
Endast fälten som visas ovan exponeras för anropare av den här åtgärden.

Vid fel returnerar API:et:

• 400 Felaktig begäran – för felaktiga begäranden eller ogiltig .xRefCode
• 500 Internt serverfel – För oväntade fel på serversidan.

Felsvar inkluderar diagnostikinformation från det underliggande Dayforce-API:et.

---

Hämta autentiseringsuppgifter

Den här anslutningsappen använder grundläggande autentisering för att ansluta till Dayforce-API:et.

Så här hämtar du de nödvändiga autentiseringsuppgifterna:

1. Skapa eller identifiera en API-användare i Dayforce

   • Arbeta med din Dayforce-administratör eller implementeringsteam.
   • Kontrollera att API-användaren har läsbehörighet till personalinformation för din miljö.

2. Samla in följande värden

   • API-URL – den grundläggande API-URL:en för din Dayforce-klientorganisation, inklusive klientnamnområdet. Det här är den URL som anslutningsappen använder för att dirigera begäranden till din Dayforce-miljö. Ta inte med ett avslutande snedstreck.

     • Exempel: https://{environmentHost}/{basePath}/api/{clientNamespace}

     Viktigt: Vissa Dayforce-miljöer använder en universell URL (till exempel https://dayforcehcm.com/api/{clientNamespace}) som automatiskt omdirigeras till en miljöspecifik URL (till exempel https://us252-services.dayforcehcm.com/api/{clientNamespace}). När du konfigurerar anslutningsappen ska du alltid använda den slutgiltiga, lösta URL:en i stället för den universella URL:en. Du kan fastställa den slutliga URL:en genom att gå till sidan Swagger-dokumentation för din miljö (till exempel https://dayforcehcm.com/api/{clientNamespace}/swagger/index.html) och notera den URL som webbläsaren omdirigeras till.

   • Användarnamn – Användarnamn för Dayforce API.

   • Lösenord – Dayforce API-lösenordet.

3. Använd dessa värden när du skapar en anslutningsanslutning

   • I dialogrutan Power Platform-anslutning:
     • Ange API-URL:en för din Dayforce-miljö.
     • Ange användarnamnet och lösenordet för Dayforce API-användaren.
   • Anslutningsappen använder API-URL:en för att dirigera begäranden till rätt Dayforce-klientorganisation och autentiseringsuppgifterna för att autentisera anropet.

Om du är osäker på din API-URL eller API-användarinformation kontaktar du Dayforce-supporten eller din interna Dayforce-administratör.

---

Komma igång

Det rekommenderade sättet att testa och använda den här anslutningsappen är att lägga till den som ett verktyg i en Copilot Studio AI-agent.

1. Skapa en anslutning

Innan du använder anslutningsappen i Copilot Studio kontrollerar du att det finns en anslutning:

1. Gå tillDataanslutningar> i Power Platform-administratörs- eller maker-upplevelsen.
2. Välj + Ny anslutning.
3. Sök efter din Dayforce HCM-anslutning (den här anslutningsappen).
4. När du uppmanas till det anger du:
   • API-URL – den grundläggande API-URL:en för din Dayforce-klientorganisation (inklusive klientnamnområdet). Ta inte med ett avslutande snedstreck.
   • Användarnamn – Dayforce API-användarnamn.
   • Lösenord – Dayforce API-användarlösenord.
5. Spara anslutningen.

2. Skapa en AI-agent i Copilot Studio och lägg till anslutningsappen som ett verktyg

1. Öppna Copilot Studio.
2. Skapa en ny AI-agent (eller öppna en befintlig agent där du vill använda Dayforce-data).
3. Gå till avsnittet Verktyg/plugin-program (eller anslutningsappar) i agenten.
4. Lägg till dayforce HCM-anslutningsappen som ett verktyg.
5. Kontrollera att anslutningsappen använder den anslutning som du skapade tidigare.

3. Anropa anslutningsappen från AI-agenten

1. I ai-agentens redigeringsupplevelse:
   • Skapa eller redigera ett ämne, en åtgärd eller ett plugin-anrop där du vill att agenten ska hämta information om anställda.
2. Konfigurera ett verktygsanrop som använder åtgärden Hämta personalinformation för medarbetare :
   • Mappa användarindata (till exempel "medarbetarkod") till parametern xRefCode .
3. Använd de returnerade fälten:
   • firstName och lastName kan användas i AI-agentens svar (till exempel "Här är adressen och kontaktinformationen för John Smith.").
   • Använd addresses och contacts i agentlogik för att visa eller resonera över medarbetarens adress och kontaktuppgifter.

Med den här konfigurationen kan AI-agenten på ett säkert sätt anropa Dayforce HCM-anslutningstjänsten som ett verktyg, hämta endast de filtrerade fälten och införliva dessa resultat i svar eller beslutsfattande.

---

Kända problem och begränsningar

• Sökning med en anställd
  Åtgärden hämtar data för en anställd i taget, baserat på XRefCode. Massfrågor eller sökningar med andra attribut (till exempel namn eller e-post) stöds inte av den här anslutningsdefinitionen.

• Exakt XRefCode-matchning krävs
  Parametern xRefCode måste matcha en befintlig medarbetares externa referenskod exakt. Om värdet är ogiltigt eller inte finns returnerar tjänsten ett svar på 400 Felaktig begäran.

• Skrivskyddade åtgärder
  Den här versionen av anslutningsappen är skrivskyddad. Den har inte stöd för att skapa, uppdatera eller ta bort information om anställda.

• Miljöspecifik konfiguration
  Anslutningsappen kräver en giltig Dayforce API-URL (tillhandahålls vid tidpunkten för anslutningens skapande). Om URL:en inte matchar din faktiska Dayforce-miljökonfiguration misslyckas anropen med anslutnings- eller routningsfel. Inkludera inte ett avslutande snedstreck i API-URL:en.

• Filtrerad nyttolast
  Det underliggande Dayforce-API:et returnerar många fler fält än vad som exponeras här. Anslutningsappens skript filtrerar och omformar avsiktligt dessa data till firstName, lastName, addresses[]och contacts[] endast.

• Datasynlighet beror på Dayforce-konfiguration
  De fält och värden som returneras för en anställd beror på hur din Dayforce-miljö har konfigurerats (roller, säkerhet och vilka dataelement som är aktiverade eller ifyllda).

---

Vanliga frågor och svar

F1: Vad används fältet "API URL" för?
API-URL:en är bas-URL:en för din Dayforce-klientorganisation, inklusive klientnamnområdet. Anslutningsappen använder den för att dirigera alla API-begäranden till rätt Dayforce-miljö. URL:en bör inte innehålla ett avslutande snedstreck.
Om du inte känner till det här värdet kontaktar du Dayforce-administratören eller implementeringsteamet.

F2: Vad händer om jag anger ett ogiltigt?xRefCode
Om inte xRefCode matchar en befintlig medarbetare returnerar tjänsten ett svar på 400 felaktig begäran. Det underliggande Dayforce API-felet visas via anslutningsappen.

F3: Kan jag hämta flera anställda i ett samtal?
Inte med den här anslutningsdefinitionen. Den aktuella åtgärden hämtar en enskild medarbetares personliga information per anrop, baserat på den angivna xRefCode.

---

Distributionsinstruktioner (CLI – paconn)

Du kan distribuera den här anslutningsappen som en anpassad anslutningsapp med hjälp av Power Platform Connectors CLI (paconn).

1. Förbereda anslutningsartefakter

Kontrollera att du har följande filer i en lokal mapp (till exempel ./dayforce-hcm-connector):

• apiDefinition.swagger.json
• apiProperties.json
• script.csx

Dessa bör matcha den struktur som förväntas av power platform-ramverket för anpassade anslutningsappar.

2. Installera och konfigurera CLI

1. Installera Power Platform Connectors CLI (paconn) om du inte redan har gjort det.
2. Logga in på målmiljön/klientorganisationen med hjälp av paconn enligt Microsofts dokumentation (till exempel med ).paconn login

3. Skapa anslutningsappen

Kör ett kommando som liknar:

paconn create   --api-def apiDefinition.swagger.json   --api-prop apiProperties.json --icon icon.png   --script script.csx

• Kontrollera att du kör det här kommandot i mappen som innehåller anslutningsfilerna eller ange fullständiga sökvägar till varje fil.
• När anslutningen har skapats visas den som en anpassad anslutningsapp i målmiljön.

4. Uppdatera anslutningsappen (om det behövs)

Om du senare gör ändringar apiDefinition.swagger.jsoni , apiProperties.jsoneller script.csx, kan du uppdatera den befintliga anslutningsappen med:

paconn update   --api-def apiDefinition.swagger.json   --api-prop apiProperties.json   --script script.csx   --connector-id <your-connector-id>

Ersätt <your-connector-id> med ID:t för anslutningsappen som skapades.

5. Skapa en anslutning och använd den i Copilot Studio

När anslutningsappen har distribuerats:

1. Gå tillDataanslutningar> och skapa en ny anslutning för Dayforce HCM-anslutningsappen med din Dayforce API-URL och dina autentiseringsuppgifter.
2. I Copilot Studio lägger du till den här anslutningsappen som ett verktyg i AI-agenten och anropar åtgärden Hämta personalinformation för medarbetare enligt beskrivningen i avsnittet Komma igång .

6. Säkerhets- och anslutningsdelning

Den här anslutningsappen använder en anslutningsmodell som inte kan delas. När du delar en Power App- eller Copilot Studio-agent som använder den här anslutningsappen måste endast anslutningsappen definition delas – each-användaren måste skapa en egen Dayforce-anslutning med sina egna autentiseringsuppgifter vid första användning. Anslutningar kan inte delas på ett sätt som gör att en användares Dayforce-behörigheter kan återanvändas av en annan. Alla autentiseringstyper är konfigurerade som Inte delningsbara, så anslutningsdelning blockeras på plattformsnivå och varje användare måste alltid upprätta en egen Dayforce-anslutning.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Type	Beskrivning	Obligatoriskt
användarnamn	securestring	Användarnamnet för det här API:et	Sann
lösenord	securestring	Lösenordet för det här API:et	Sann
Autentiseringstyp	snöre	Autentiseringstyp för att ansluta till ditt API	Sann
Klientnamnområde	snöre	klientnamnområde	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Hämta personalinformation för medarbetare

Den här åtgärden hämtar data som rör en anställd och hans/hennes personliga information (t.ex. namn, adresser och kontakter) via XRef Code

Hämta personalinformation för medarbetare

Definitioner

ProcessResult

Medarbetare

PersonContactCollection

PersonAddressCollection

PersonContact

PersonAddress

Land

ContactInformationType

Tillstånd

ContactInformationTypeGroup

Payload_Employee