Dayforce HCM (Önizleme)
Çalışan başvuru koduna göre çalışan kişisel bilgilerini (kişiler, adresler, adlar) almak için Dayforce HCM API'sine bağlanır. İk yöneticilerine ve düşük kodlu geliştiricilere yöneliktir. Dayforce kiracısı, API kimlik bilgileri (Temel Kimlik Doğrulaması) ve uygun izinler gerektirir. Salt okunur; geçersiz başvuru kodları hata döndürer.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Service | Sınıf | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Dayforce Desteği |
| URL | https://www.dayforce.com/resources/help-center#support-for-employers |
| E-posta | MicrosoftPartnership@dayforce.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Dayforce AI |
| Web Sitesi | https://www.dayforce.com/ |
| Gizlilik ilkesi | https://www.dayforce.com/privacy |
| Kategoriler | AI; İnsan Kaynakları |
Dayforce HCM
Dayforce HCM bir insan sermayesi yönetim platformudur.
Bu bağlayıcı, bir çalışanın kişisel bilgilerini (ad, adres ve kişi ayrıntıları) dış başvuru koduyla (XRefCode) almanıza olanak tanıyan bir Dayforce API'sini kullanıma sunar. Bu verileri Copilot Studio AI aracılarında ve diğer Power Platform senaryolarında bir araç olarak kullanabilirsiniz.
Yayımcı: Dayforce
Önkoşullar
Bu bağlayıcıyı kullanmak için şunları yapmanız gerekir:
- Microsoft Power Platform ortamı (örneğin, Copilot Studio'da bağlayıcıyı kullanmak için).
- Etkin bir Dayforce HCM ortamı (Soru-Cevap, UAT veya Üretim).
- Çalışan kişisel bilgilerini okuma iznine sahip bir Dayforce API kullanıcısı (hizmet hesabı).
- İstemci ad alanı da dahil olmak üzere Dayforce ortamınızın API URL'si .
- Bu, kiracınız için Dayforce API'sini çağırmak için kullanılan temel URL'dir, örneğin:
https://{environmentHost}/{basePath}/api/{clientNamespace} - Tam biçim, Dayforce ortam yapılandırmanıza bağlıdır. URL'yi bilmiyorsanız Dayforce yöneticinize başvurun.
- Bu, kiracınız için Dayforce API'sini çağırmak için kullanılan temel URL'dir, örneğin:
Desteklenen İşlemler
Bağlayıcı şu anda aşağıdaki işlemi kullanıma sunar.
Çalışan Kişisel Bilgilerini Alma
İşlem Kimliği:Get_Employee_Personal_Info
Yöntem:GET
XRefCode'larını temel alarak tek bir çalışan için kişisel bilgilerin filtrelenmiş, basitleştirilmiş bir görünümünü alır.
İstek
- yol parametresi
-
xRefCode(dize, gerekli)
Alınacak çalışanın dış başvuru kodu. Değerin var olan bir çalışanın XRefCode değeriyle tam olarak eşleşmesi gerekir; aksi takdirde hizmet 400 Hatalı İstek döndürür.
-
Bağlayıcı, çağrıyı dahili olarak, bağlantı oluşturma zamanında sağlanan API URL'sini kullanarak Dayforce Çalışanları uç noktasına yönlendirir ve ilgili kişisel bilgileri genişletir ve bağlayıcının betiği tarafından kolaylaştırılmış bir JSON nesnesine dönüştürülür.
Yanıt
Başarılı olduğunda (HTTP 200), bağlayıcı tam Dayforce çalışan yükünü döndürmez .
Bunun yerine, şu yapıya sahip dönüştürülmüş bir nesne döndürür:
{
"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"
}
]
}
Daha açık belirtmek gerekirse:
Üst düzey alanlar
-
firstName– Çalışanın adı. -
lastName– Çalışanın soyadı. -
addresses– Filtrelenmiş adres girdilerinin listesi. -
contacts– Filtrelenmiş kişi girişlerinin listesi.
-
Adres nesnesi (
addresses[])-
address1– Birincil adres satırı. -
address2– İkincil adres satırı. -
address3– Ek adres satırı. -
city– Şehir adı. -
postalCode– Posta veya posta kodu. -
country– Ülke adı (Dayforce Ülke adıyla eşlenir). -
state– Eyalet veya bölge adı (Dayforce Eyalet adıyla eşlenir). -
contactInformationType– Dayforce iletişim bilgileri türüne göre adres türünü açıklayan kısa ad (örneğin, "Giriş", "Postalama").
-
Kişi nesnesi (
contacts[])-
personContactId– Kişi kaydı için iç sayısal tanımlayıcı. -
contactInformationType– Kişi türünü açıklayan kısa ad (örneğin, "Mobil", "Ev Telefonu", "İş E-postası"). -
electronicAddress– "Çevrimiçi profil" stili kişiler için (e-posta veya diğer elektronik adresler gibi). -
contactNumber– Telefon stili kişiler için (örneğin, cep telefonu veya sabit hat numaraları). -
country– İlgili kişiyle ilişkili ülke değeri (varsa). -
effectiveStart– Bu iletişim bilgilerinin geçerlilik başlangıç tarihi (varsa).
-
Not: Bağlayıcının betiği ham Dayforce yükünü kasıtlı olarak filtreler.
Yalnızca yukarıda gösterilen alanlar bu işlemin çağıranlarına gösterilir.
Hata oluştuğunda API şunları döndürür:
-
400 Hatalı İstek – Hatalı biçimlendirilmiş istekler veya geçersiz
xRefCodeiçin. - 500 İç Sunucu Hatası – Beklenmeyen sunucu tarafı hataları için.
Hata yanıtları, temel alınan Dayforce API'sinden alınan tanılama bilgilerini içerir.
Kimlik Bilgilerini Alma
Bu bağlayıcı, Dayforce API'sine bağlanmak için Temel kimlik doğrulamasını kullanır.
Gerekli kimlik bilgilerini almak için:
Dayforce'ta API kullanıcısı oluşturma veya tanımlama
- Dayforce yöneticiniz veya uygulama ekibinizle birlikte çalışın.
- API kullanıcısının ortamınız için çalışan kişisel bilgilerine okuma erişimi olduğundan emin olun.
Aşağıdaki değerleri toplayın
API URL'si – İstemci ad alanı da dahil olmak üzere Dayforce kiracınız için temel API URL'si. Bu, bağlayıcının istekleri Dayforce ortamınıza yönlendirmek için kullanacağı URL'dir. Sondaki eğik çizgiyi eklemeyin.
- Örnek:
https://{environmentHost}/{basePath}/api/{clientNamespace}
Önemli: Bazı Dayforce ortamları, ortama özgü bir URL'ye (örneğin,
https://dayforcehcm.com/api/{clientNamespace}) otomatik olarak yeniden yönlendiren bir evrensel URL (örneğin,https://us252-services.dayforcehcm.com/api/{clientNamespace}) kullanır. Bağlayıcıyı yapılandırırken, her zaman evrensel URL yerine son çözümlenen URL'yi kullanın. Ortamınızın Swagger belgeleri sayfasına giderek (örneğin,https://dayforcehcm.com/api/{clientNamespace}/swagger/index.html) ve tarayıcınızın yönlendirildiği URL'yi not ederek son URL'yi belirleyebilirsiniz.- Örnek:
Kullanıcı adı : Dayforce API'sinin kullanıcı adı.
Parola – Dayforce API parolası.
Bağlayıcı bağlantısı oluştururken bu değerleri kullanın
- Power Platform bağlantısı iletişim kutusunda:
- Dayforce ortamınızın API URL'sini girin.
- Dayforce API kullanıcısının kullanıcı adını ve parolasını girin.
- Bağlayıcı, istekleri doğru Dayforce kiracısına yönlendirmek için API URL'sini ve çağrının kimliğini doğrulamak için kimlik bilgilerini kullanır.
- Power Platform bağlantısı iletişim kutusunda:
API URL'nizden veya API kullanıcı ayrıntılarınızdan emin değilseniz, Dayforce desteğine veya iç Dayforce yöneticinize başvurun.
Başlangıç Yapmak
Bu bağlayıcıyı test etmenin ve kullanmanın önerilen yolu, bunu Copilot Studio AI aracısına araç olarak eklemektir.
1. Bağlantı oluşturma
Copilot Studio'da bağlayıcıyı kullanmadan önce bir bağlantı olduğundan emin olun:
- Power Platform yöneticisi veya oluşturucu deneyiminde Veri>Bağlantıları'na gidin.
- + Yeni bağlantı'yı seçin.
- Dayforce HCM bağlayıcınızı (bu bağlayıcı) arayın.
- İstendiğinde şunları sağlayın:
- API URL'si – Dayforce kiracınızın (istemci ad alanı dahil) temel API URL'si. Sondaki eğik çizgiyi eklemeyin.
- Kullanıcı adı – Dayforce API kullanıcı adı.
- Parola – Dayforce API kullanıcı parolası.
- Bağlantıyı kaydedin.
2. Copilot Studio'da yapay zeka aracısı oluşturma ve bağlayıcıyı araç olarak ekleme
- Copilot Studio açın.
- Yeni bir yapay zeka aracısı oluşturun (veya Dayforce verilerini kullanmak istediğiniz mevcut bir aracıyı açın).
- Aracının Araçlar/Eklentiler (veya Bağlayıcılar) bölümüne gidin.
- Dayforce HCM bağlayıcınızı araç olarak ekleyin.
- Bağlayıcının daha önce oluşturduğunuz bağlantıyı kullandığından emin olun.
3. AI aracısından bağlayıcıyı çağırın
- Yapay zeka aracısı yazma deneyiminizde:
- Aracının çalışan bilgilerini almasını istediğiniz konu, eylem veya eklenti çağrısı oluşturun veya düzenleyin.
-
Çalışan Kişisel Bilgilerini Al işlemini kullanan bir araç çağrısı yapılandırın:
- Kullanıcı girişini ("çalışan kodu") parametresiyle eşleyin
xRefCode.
- Kullanıcı girişini ("çalışan kodu") parametresiyle eşleyin
- Döndürülen alanları kullanın:
-
firstNamevelastNameyapay zeka aracısının yanıtlarında kullanılabilir (örneğin, "John Smith için adres ve iletişim bilgileri buradadır.") - Çalışanın adresini ve
addressesiletişim bilgilerini görüntülemek veya gerekçelerini göstermek için aracı mantığında ve kullanıncontacts.
-
Bu kurulum, yapay zeka aracınızın Dayforce HCM bağlayıcısını güvenli bir şekilde araç olarak çağırmasına, yalnızca filtrelenen alanları almasına ve bu sonuçları yanıtlara veya karar alma sürecine eklemesine olanak tanır.
Bilinen Sorunlar ve Sınırlamalar
Yalnızca tek çalışanlı arama
İşlem, XRefCode'a göre tek seferde bir çalışanın verilerini alır. Diğer özniteliklere (ad veya e-posta gibi) göre toplu sorgular veya aramalar bu bağlayıcı tanımı tarafından desteklenmez.Tam XRefCode eşleşmesi gerekiyor
Parametresi,xRefCodevar olan bir çalışanın dış başvuru koduyla tam olarak eşleşmelidir. Değer geçersizse veya yoksa, hizmet 400 Hatalı İstek yanıtı döndürür.Salt okunur işlemler
Bağlayıcının bu sürümü salt okunurdur. Çalışan bilgilerinin oluşturulmasını, güncelleştirilmesini veya silinmesini desteklemez.Ortama özgü yapılandırma
Bağlayıcı geçerli bir Dayforce API URL'si gerektirir (bağlantı oluşturma zamanında sağlanır). URL gerçek Dayforce ortamı yapılandırmanızla eşleşmiyorsa, çağrılar bağlantı veya yönlendirme hatalarıyla başarısız olur. API URL'sine sondaki eğik çizgiyi eklemeyin.Filtrelenmiş yük
Temel alınan Dayforce API'sinde burada gösterilenden çok daha fazla alan döndürülüyor. Bağlayıcının betiği bu verileri kasıtlı olarak filtreleyip yalnızca ,firstName,lastNameveaddresses[]içinecontacts[]yeniden şekillendirer.Veri görünürlüğü Dayforce yapılandırmasına bağlıdır
Bir çalışan için döndürülen alanlar ve değerler, Dayforce ortamınızın nasıl yapılandırıldığına (roller, güvenlik ve hangi veri öğelerinin etkinleştirildiğine veya dolduruldığına) bağlıdır.
Sık Sorulan Sorular
S1: "API URL'si" alanı ne için kullanılır?
API URL'si, istemci ad alanı da dahil olmak üzere Dayforce kiracınızın temel URL'sidir. Bağlayıcı, tüm API isteklerini doğru Dayforce ortamına yönlendirmek için bunu kullanır. URL sonunda eğik çizgi olmamalıdır.
Bu değeri bilmiyorsanız Dayforce yöneticinize veya uygulama ekibinize başvurun.
S2: Geçersiz xRefCodebir sağlarsam ne olur?
mevcut bir çalışanla xRefCode eşleşmiyorsa, hizmet 400 Hatalı İstek yanıtı döndürür. Temel alınan Dayforce API hatası bağlayıcı aracılığıyla ortaya çıkar.
S3: Tek bir aramada birden çok çalışanı alabilir miyim?
Bu bağlayıcı tanımıyla değil. Geçerli işlem, sağlanan xRefCodeöğesine bağlı olarak tek bir çalışanın çağrı başına kişisel bilgilerini alır.
Dağıtım Yönergeleri (CLI – paconn)
Power Platform Bağlayıcıları CLI'sını (paconn)kullanarak bu bağlayıcıyı özel bağlayıcı olarak dağıtabilirsiniz.
1. Bağlayıcı yapıtlarını hazırlama
Yerel klasörde aşağıdaki dosyalara sahip olduğunuzdan emin olun (örneğin, ./dayforce-hcm-connector):
apiDefinition.swagger.jsonapiProperties.jsonscript.csx
Bunlar, Power Platform özel bağlayıcı çerçevesi tarafından beklenen yapıyla eşleşmelidir.
2. CLI'yi yükleme ve yapılandırma
- Henüz yapmadıysanız Power Platform Bağlayıcıları CLI'sını (
paconn) yükleyin. - Microsoft'un belgelerine göre kullanarak (örneğin, kullanarak) hedef ortamınızda/kiracınızda
paconnoturum açınpaconn login.
3. Bağlayıcıyı oluşturma
Şuna benzer bir komut çalıştırın:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx
- Bu komutu bağlayıcı dosyalarını içeren klasörde çalıştırdığınızdan emin olun veya her dosyanın tam yollarını sağlayın.
- Oluşturma işleminden sonra bağlayıcı, hedef ortamınızda özel bağlayıcı olarak görünür.
4. Bağlayıcıyı güncelleştirin (gerekirse)
Daha sonra , apiDefinition.swagger.jsonveya apiProperties.jsonüzerinde değişiklik script.csxyaparsanız, var olan bağlayıcıyı şu şekilde güncelleştirebilirsiniz:
paconn update --api-def apiDefinition.swagger.json --api-prop apiProperties.json --script script.csx --connector-id <your-connector-id>
değerini, oluşturulan bağlayıcının kimliğiyle değiştirin <your-connector-id> .
5. Copilot Studio'da bağlantı oluşturma ve kullanma
Bağlayıcı dağıtıldıktan sonra:
- Veri>Bağlantıları'na gidin ve Dayforce API URL'nizi ve kimlik bilgilerinizi kullanarak Dayforce HCM bağlayıcısı için yeni bir bağlantı oluşturun.
- Copilot Studio'da bu bağlayıcıyı yapay zeka aracınıza bir araç olarak ekleyin ve Başlarken bölümünde açıklandığı gibi Çalışan Kişisel Bilgilerini Al işlemini çağırın.
6. Güvenlik ve bağlantı paylaşımı
Bu bağlayıcı paylaşılamayan bir bağlantı modeli kullanır. Bu bağlayıcıyı kullanan bir Power App veya Copilot Studio aracısını paylaştığınızda, ilk kullanımda yalnızca definition paylaşılır; each kullanıcısının kendi kimlik bilgileriyle kendi Dayforce bağlantısını oluşturması gerekir. Bağlantılar, bir kullanıcının Dayforce izinlerinin başka bir kullanıcı tarafından yeniden kullanılmasına izin veren bir şekilde paylaşılamaz. Tüm kimlik doğrulama türleri Paylaşılamaz olarak yapılandırıldığından, bağlantı paylaşımı platform düzeyinde engellenir ve her kullanıcının her zaman kendi Dayforce bağlantısını kurması gerekir.
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Çalışan Kişisel Bilgilerini Alma |
Bu işlem, XRef Code'a göre bir çalışanla ve kişisel bilgileriyle (ör. Ad, Adresler ve Kişiler) ilgili verileri alır |
Çalışan Kişisel Bilgilerini Alma
Bu işlem, XRef Code'a göre bir çalışanla ve kişisel bilgileriyle (ör. Ad, Adresler ve Kişiler) ilgili verileri alır
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Çalışan Başvuru Kodu
|
xRefCode | True | string |
Alınacak çalışanın benzersiz tanımlayıcısı (dış başvuru kodu). Sağlanan değer bir çalışanın tam eşleşmesi olmalıdır; aksi takdirde, hatalı bir istek (400) hatası döndürülür. |
Döndürülenler
- Vücut
- Payload_Employee
Tanımlar
ProcessResult
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kod
|
Code | string | |
|
Bağlam
|
Context | string | |
|
Seviye
|
Level | string | |
|
Mesaj
|
Message | string |
Çalışan
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Çalışan Kimlik Numarası
|
EmployeeId | integer | |
|
İrtibatlar
|
Contacts | PersonContactCollection | |
|
Adresler
|
Addresses | PersonAddressCollection | |
|
GlobalPersonId
|
GlobalPersonId | string | |
|
XRefCode
|
XRefCode | string | |
|
NewXRefCode
|
NewXRefCode | string | |
|
YaygınAd
|
CommonName | string | |
|
Gösterim Adı
|
DisplayName | string | |
|
İlk İsim
|
FirstName | string | |
|
Soyadı
|
LastName | string | |
|
Baş harfler
|
Initials | string | |
|
Kızlık Soyadı
|
MaidenName | string | |
|
MiddleName
|
MiddleName | string | |
|
Başlık
|
Title | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
PersonContactCollection
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Eşya
|
Items | array of PersonContact |
PersonAddressCollection
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Eşya
|
Items | array of PersonAddress |
PersonContact
| Name | Yol | Tür | Description |
|---|---|---|---|
|
PersonContactId
|
PersonContactId | integer | |
|
ContactInformationType
|
ContactInformationType | ContactInformationType | |
|
Kişi Numarası
|
ContactNumber | string | |
|
Ülke
|
Country | Country | |
|
EffectiveEnd
|
EffectiveEnd | date-time | |
|
EffectiveStart
|
EffectiveStart | date-time | |
|
ElectronicAddress
|
ElectronicAddress | string | |
|
Uzantı
|
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
| Name | Yol | Tür | Description |
|---|---|---|---|
|
PersonAddressId
|
PersonAddressId | integer | |
|
Adres1
|
Address1 | string | |
|
Adres2
|
Address2 | string | |
|
Adres3
|
Address3 | string | |
|
Adres4
|
Address4 | string | |
|
Adres5
|
Address5 | string | |
|
Adres6
|
Address6 | string | |
|
Şehir
|
City | string | |
|
Posta Kodu
|
PostalCode | string | |
|
Ülke
|
Country | Country | |
|
Devlet
|
State | State | |
|
ContactInformationType
|
ContactInformationType | ContactInformationType | |
|
IsPayrollMailing
|
IsPayrollMailing | boolean | |
|
DisplayOnTaxForm
|
DisplayOnTaxForm | boolean | |
|
DisplayOnEarningStatement
|
DisplayOnEarningStatement | boolean | |
|
EffectiveStart
|
EffectiveStart | date-time | |
|
EffectiveEnd
|
EffectiveEnd | date-time | |
|
İlçe
|
County | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
Ülke
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İsim
|
Name | string | |
|
XRefCode
|
XRefCode | string | |
|
Kısa Ad
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
ContactInformationType
| Name | Yol | Tür | Description |
|---|---|---|---|
|
ContactInformationTypeGroup
|
ContactInformationTypeGroup | ContactInformationTypeGroup | |
|
XRefCode
|
XRefCode | string | |
|
Kısa Ad
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
Devlet
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İsim
|
Name | string | |
|
XRefCode
|
XRefCode | string | |
|
Kısa Ad
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
ContactInformationTypeGroup
| Name | Yol | Tür | Description |
|---|---|---|---|
|
XRefCode
|
XRefCode | string | |
|
Kısa Ad
|
ShortName | string | |
|
LongName
|
LongName | string | |
|
LastModifiedTimestamp
|
LastModifiedTimestamp | date-time |
Payload_Employee
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Veri
|
Data | Employee | |
|
ProcessResults
|
ProcessResults | array of ProcessResult |