U.K.G
Mit dem UKG-Connector können Sie verschiedene Aktionen für UKG-Daten ausführen.
Hinweise
Führen Sie vor der Verwendung des UKG-Connectors die folgenden Aufgaben aus:
- In Ihrem Google Cloud-Projekt:
- Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkkonnektivität.
- Weisen Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin zu.
- Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.
- Aktivieren Sie die folgenden Dienste:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.
Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.
Connector konfigurieren
Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:
- Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.
- Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
- Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
Eine Liste aller unterstützten Regionen finden Sie unter Standorte.
- Tippen Sie auf Weiter.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
- Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
- Connector: Wählen Sie UKG aus der Drop-down-Liste der verfügbaren Connectors aus.
- Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
- Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.
Verbindungsnamen müssen die folgenden Kriterien erfüllen:
- Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
- Buchstaben müssen Kleinbuchstaben sein.
- Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
- Verbindungsnamen dürfen maximal 49 Zeichen haben.
- Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
- Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf
Error
festgelegt. - Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
- Service/Module (Dienst/Modul): Wählen Sie das UKG-Modul aus.
- Konfigurieren Sie optional die Verbindungsknoteneinstellungen:
- Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
- Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.
Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.
- Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Tippen Sie auf Weiter.
- Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
- Zieltyp: Wählen Sie einen Zieltyp aus.
- Wenn Sie den Zielhostnamen oder die Ziel-IP-Adresse angeben möchten, wählen Sie Hostadresse aus und geben Sie die Adresse in das Feld Host 1 ein.
- Wenn Sie eine private Verbindung herstellen möchten, wählen Sie Endpunktanhang aus und wählen Sie den erforderlichen Anhang aus der Liste Endpunktanhang aus.
Wenn Sie eine öffentliche Verbindung zu Ihren Back-End-Systemen mit zusätzlicher Sicherheit herstellen möchten, können Sie statische ausgehende IP-Adressen für Ihre Verbindungen konfigurieren und dann Ihre Firewallregeln konfigurieren, um nur bestimmte statische IP-Adressen zuzulassen.
Wenn Sie weitere Ziele eingeben möchten, klicken Sie auf + ZIEL HINZUFÜGEN.
- Tippen Sie auf Weiter.
- Zieltyp: Wählen Sie einen Zieltyp aus.
-
Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
Die folgenden Authentifizierungstypen werden von der UKG-Verbindung unterstützt:
- Basisauthentifizierung
- OAUTH 2.0-Autorisierungscode
- Tippen Sie auf WEITER.
Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- Klicken Sie auf Erstellen.
Authentifizierung konfigurieren
Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.
- Basisauthentifizierung
- Nutzername: Der Nutzername, der zur Authentifizierung des Connectors verwendet wird.
- Passwort: Secret Manager-Secret mit dem Passwort, das mit dem Connector verknüpft ist.
OAUTH 2.0 – Autorisierungscode
- Client-ID: Die Client-ID, die zum Anfordern von Zugriffstokens verwendet wird.
- Bereiche:Eine durch Kommas getrennte Liste der gewünschten Bereiche.
- Client-Secret: Secret Manager-Secret mit dem Clientschlüssel für die verbundene Anwendung, die Sie erstellt haben.
- PKCE aktivieren: Wählen Sie diese Option aus, wenn Sie PKCE (Proof Key for Code Exchange) aktivieren möchten.
- Autorisierungs-URL: Autorisierungs-URL für Ihre App. Sie werden zu dieser Seite weitergeleitet, um sich in Ihrer App anzumelden.
- Zugriffstoken-URL: Die URL, die zum Austausch des Zugriffstokens verwendet werden soll. Geben Sie die vollständige URL einschließlich Schema an.
Beispiele für Verbindungskonfigurationen
In diesem Abschnitt werden die Beispielwerte für die verschiedenen Felder aufgeführt, die Sie beim Erstellen der Verbindung konfigurieren.
OAUTH 2.0-Verbindungstyp mit Autorisierungscode
Feldname | Details |
---|---|
Standort | us-central1 |
Connector | U.K.G |
Connector-Version | 1 |
Verbindungsname | gcp-ukg-oauth-conn |
Cloud Logging aktivieren | Ja |
Protokollebene | Fehler |
Dienstkonto | SERVICEACCOUNT_NAME@developer.gserviceaccount.com |
OpenAPI-Spezifikationsmodul | Zeitmessung |
Ausführlichkeitsgrad | 5 |
Mindestanzahl von Knoten | 2 |
Maximale Anzahl von Knoten | 50 |
Zieltyp | Hostadresse |
Hostadresse | https://google-connect-dev.cfn.mykronos.com |
Client-ID | ZG******-****-****-****-*********uDN |
Clientschlüssel | Secret |
Secret-Version | 1 |
Autorisierungs-URL | https://google-connect-dev.cfn.mykronos.com/oauth2/authorize |
Zugriffs-Token-URL | https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token |
Systembeschränkungen
Der UKG-Connector kann 30 Transaktionen pro Sekunde und Knoten verarbeiten und drosselt alle Transaktionen, die dieses Limit überschreiten. Standardmäßig werden für eine Verbindung zwei Knoten (für eine bessere Verfügbarkeit) zugewiesen.
Informationen zu den für Integration Connectors geltenden Limits finden Sie unter Limits.
Aktionen
Mit diesem Connector können Sie verschiedene Aktionen für UKG-Daten ausführen.
In diesem Abschnitt werden die vom UKG-Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.
Aktion „RetrieveAllEmployeeGroupsOrByName“
Ruft alle Mitarbeitergruppen nach Namen ab.
Eingabeparameter der Aktion „RetrieveAllEmployeeGroupsOrByName“
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
all_details | boolean | Wahr | Ein boolescher Wert, der angibt, ob die Antwort kurz ist. Eine kurze Antwort enthält nur die Felder „ID“ und „Name“. |
Name | String | Wahr | Der Name einer Mitarbeitergruppe. |
Beispiele für die Konfiguration der Aktion RetrieveAllEmployeeGroupsOrByName
finden Sie unter Beispiele.
PayCode-Aktion erstellen
Erstellt einen Zahlencode.
Eingabeparameter der Aktion „Create PayCode“
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
Typ | String | Wahr | Der Typ des Zahlencodes. |
Name | String | Wahr | Der Name des Paycodes. |
Einheit | String | Wahr | Die Einheit für den Lohncode. |
codeNumber | integer | Wahr | Die Codenummer, die einem Lohncode zugewiesen ist. |
Beispiele für die Konfiguration der Aktion CreatePayCode
finden Sie unter Beispiele.
DeletePayCodebyId-Aktion
Löscht einen Zahlencode anhand der ID.
Eingabeparameter der Aktion „DeletePayCodebyId“
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
id | integer | Wahr | Die ID eines Zahlencodes. |
Beispiele für die Konfiguration der Aktion DeletePayCodebyId
finden Sie unter Beispiele.
Aktion „Arbeitsregel nach ID aktualisieren“
Aktualisiert eine Arbeitsregel anhand der ID.
Eingabeparameter der Aktion „Update Work Rule by ID“
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
workRuleId | integer | Wahr | ID der Arbeitsregel |
workRuleVersion | json | Wahr | Die mit einer Arbeitsregel verknüpfte Version der Arbeitsregel. |
Name | String | Wahr | Der Name einer Arbeitsregel. |
Version | integer | Wahr | Version der Arbeitsregel. |
Beispiele für die Konfiguration der Aktion Update Work Rule by ID
finden Sie unter Beispiele.
Beispiele für Aktionen
Beispiel – RetrieveAllEmployeeGroupsOrByName
In diesem Beispiel werden Mitarbeitergruppen abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
RetrieveAllEmployeeGroupsOrByName
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Query parameters": { "all_details": true } }
If the action is successful, the
RetrieveAllEmployeeGroupsOrByName
task'sconnectorOutputPayload
response parameter will have a value similar to the following:
Beispiel: PayCode erstellen
In diesem Beispiel wird ein Zahlencode erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Create PayCode
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "RequestBody": { "type": "Regular", "unit": "HOUR", "visibleToTimecardSchedule": true, "name": "2nd Meal Premium qaazxse", "shortName": "2MP", "combined": false, "money": false, "totals": true, "excusedAbsence": false, "wageMultiplier": 1.0, "wageAddition": 0.0, "addToTimecardTotal": true, "visibleToUser": true, "visibleToReports": true, "checkAvailability": 0.0, "codeNumber": 7663.0, "cascadingDuration": false, "processDurationAsSeparateShift": false, "editCountsTowardsOvertimeLimits": false, "editCountsTowardsConsecutiveDayOT": false, "repeating": false, "payrollOnly": false, "timekeepingOnly": false, "netDown": false }, "Headers": { "Content-Type": "application/json" } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des CreatePayCode
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "type": "Regular", "unit": "HOUR", "visibleToTimecardSchedule": true, "id": 5904.0, "name": "2nd Meal Premium qaazxse", "shortName": "2MP", "combined": false, "money": false, "totals": true, "excusedAbsence": false, "wageMultiplier": 1.0, "wageAddition": 0.0, "addToTimecardTotal": true, "visibleToUser": true, "visibleToReports": true, "checkAvailability": 0.0, "codeNumber": 7663.0, "cascadingDuration": false, "processDurationAsSeparateShift": false, "editCountsTowardsOvertimeLimits": false, "editCountsTowardsConsecutiveDayOT": false, "repeating": false, "payrollOnly": false, "timekeepingOnly": false, "netDown": false }]
Beispiel – DeletePayCodebyId
In diesem Beispiel wird ein Zahlencode anhand der ID gelöscht.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
DeletePayCodebyId
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Path parameters": { "id": 6002.0 } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des DeletePayCodebyId
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "ResponseBody": "", "StatusCode": 200.0 }]
Beispiel: Arbeitsregel anhand der ID aktualisieren
In diesem Beispiel wird die Arbeitsregel aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Update Work Rule by ID
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Path parameters": { "id": 3701.0 }, "Headers": { "Content-Type": "application/json" }, "RequestBody": { "version": 1.0, "workRuleId": 3701.0, "name": "$AU Call Back Sasori", "workRuleVersion": [{ "effectiveWorkRuleId": 3801.0, "effectiveDateTime": "1853-01-01T00:00:00", "updateThisVersion": true, "expirationDateTime": "4000-01-01T00:00:00", "general": { "breaks": [], "coreHours": [], "includeMinimumWagesAdjustment": false, "deductions": [{ "id": 651.0, "qualifier": "$AU Oncall Allowance", "name": "$AU Oncall Allowance" }] }, "workRulePayCodeDistribution": { "payCodeDistributionName": "$AU Oncall", "deviations": [], "overtimes": [], "zones": [], "majorities": [] }, "workRuleAutoBreakPlacement": { "minimumTimeBetweenStartOfShiftAndFirstBreak": "0:0", "minimumTimeBetweenEndOfBreakAndShiftEnd": "0:0", "minimumTimeBetweenBreaks": "0:0", "shiftLengthsToExclude": [], "newShiftLengths": [] }, "version": 1.0 }], "ivrAlias": "1234567890" } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Update Work Rule by ID
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "workRuleId": 3701.0, "name": "$AU Call Back Sasori", "ivrAlias": "1234567890", "workRuleVersion": [{ "effectiveWorkRuleId": 3801.0, "effectiveDateTime": "1753-01-01T00:00:00", "updateThisVersion": false, "expirationDateTime": "3000-01-01T00:00:00", "general": { "breaks": [], "coreHours": [], "includeMinimumWagesAdjustment": false, "deductions": [{ "id": 651.0, "qualifier": "$AU Oncall Allowance", "name": "$AU Oncall Allowance" }] }, "workRulePayCodeDistribution": { "payCodeDistributionName": "$AU Oncall", "deviations": [], "overtimes": [], "zones": [], "majorities": [] }, "workRuleAutoBreakPlacement": { "minimumTimeBetweenStartOfShiftAndFirstBreak": "0:0", "minimumTimeBetweenEndOfBreakAndShiftEnd": "0:0", "minimumTimeBetweenBreaks": "0:0", "shiftLengthsToExclude": [], "newShiftLengths": [] }, "version": 3.0 }], "version": 3.0 }]
Beispiel: Feste Regel nach ID löschen
In diesem Beispiel wird eine bestimmte feste Regel gelöscht.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Delete Fixed Rule by ID
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Path parameters": { "id": 1152.0 } }
Wenn die Aktion erfolgreich ist, hat der connectorOutputPayload
-Antwortparameter der Aufgabe Delete Fixed Rule by ID
einen Wert, der dem folgenden ähnelt:
[{ "ResponseBody": "", "StatusCode": 204.0 }]
Beispiel: Accrual-Codes abrufen
In diesem Beispiel werden Abrechnungscodes abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Retrieve Accrual Codes
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Query parameters": { "id": 1303.0 } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Retrieve Accrual Codes
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "ResponseBody": "[{\"id\":1303,\"typeId\":2,\"hoursPerDayInSeconds\":28800,\"name\":\"$LC Dia Familia\",\"shortName\":\"$LC Dia Familia\",\"typeName\":\"Day\",\"allowEdit\":true}]", "StatusCode": 200.0 }]
Beispiel: Öffnungszeiten erstellen
In diesem Beispiel werden Öffnungszeiten erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Create Hours of Operation
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Headers": { "Content-Type": "application/json" }, "RequestBody": { "name": "$E-HoO Store 501 dummy3", "active": true, "effectiveVersions": [{ "effectiveSpan": { "startDate": "1900-01-01", "endDate": "3000-01-01" }, "unrestrictedEdit": true, "items": [{ "openTime": "09:00:00", "closeTime": "21:00:00", "closed": false, "holiday": false, "weekDay": { "id": -1.0, "qualifier": "EVERY_DAY" } }, { "openTime": "10:00:00", "closeTime": "17:00:00", "closed": false, "holiday": false, "weekDay": { "id": 1.0, "qualifier": "SUNDAY" } }, { "openTime": "10:00:00", "closeTime": "18:00:00", "closed": false, "holiday": false, "weekDay": { "id": 7.0, "qualifier": "SATURDAY" } }] }] } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Create Hours of Operation
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "id": 851.0, "name": "$E-HoO Store 501 dummy3", "active": true, "version": 1.0, "effectiveVersions": [{ "effectiveSpan": { "startDate": "1900-01-01", "endDate": "3000-01-01" }, "unrestrictedEdit": true, "items": [{ "id": 1051.0, "openTime": "09:00:00", "closeTime": "21:00:00", "closed": false, "holiday": false, "weekDay": { "id": -1.0, "qualifier": "EVERY_DAY" } }, { "id": 1052.0, "openTime": "10:00:00", "closeTime": "17:00:00", "closed": false, "holiday": false, "weekDay": { "id": 1.0, "qualifier": "SUNDAY" } }, { "id": 1053.0, "openTime": "10:00:00", "closeTime": "18:00:00", "closed": false, "holiday": false, "weekDay": { "id": 7.0, "qualifier": "SATURDAY" } }] }] }]
Beispiel: Zeiterfassungseinstellung nach ID aktualisieren
In diesem Beispiel wird die spezifische Zeiterfassungseinstellung aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Update Timecard Setting by ID
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Path parameters": { "id": 3872335.0 }, "RequestBody": { "id": 3872335.0, "name": "Hourly Timecard -Employee Sharp", "label": "Hourly Timecard - Employee View", "description": "Hourly Timecard - Employee View", "timecardType": { "id": "HourlyEmployee", "name": "Hourly Employee" }, "canEditFutureTimecard": false, "numberOfFutureDays": 0.0, "includeOvertimes": true, "fourPunchRow": false, "columnsOrder": [{ "id": "Date", "name": "Date" }, { "id": "Schedule", "name": "Schedule" }, { "id": "Absence", "name": "Absence" }, { "id": "In", "name": "In" }, { "id": "Transfer", "name": "Transfer" }, { "id": "Out", "name": "Out" }, { "id": "PayCode", "name": "Pay Code" }, { "id": "Amount", "name": "Amount" }, { "id": "Shift", "name": "Shift" }, { "id": "Daily", "name": "Daily" }, { "id": "Period", "name": "Period" }], "includeActivityEvent": false, "includeActivityAllocation": false, "includeActivityTotalActual": false, "includeActivityTotalAllocated": false, "includeActivityTotalVariance": false, "hidePaidCorrection": false}
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Update Timecard Setting by ID
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "id": 3872335.0, "name": "Hourly Timecard -Employee Sharp", "label": "Hourly Timecard - Employee View", "description": "Hourly Timecard - Employee View", "timecardType": { "id": "HourlyEmployee", "name": "Hourly Employee" }, "canEditFutureTimecard": false, "numberOfFutureDays": 0.0, "includeOvertimes": true, "fourPunchRow": false, "columnsOrder": [{ "id": "Date", "name": "Date" }, { "id": "Schedule", "name": "Schedule" }, { "id": "Absence", "name": "Absence" }, { "id": "In", "name": "In" }, { "id": "Transfer", "name": "Transfer" }, { "id": "Out", "name": "Out" }, { "id": "PayCode", "name": "Pay Code" }, { "id": "Amount", "name": "Amount" }, { "id": "Shift", "name": "Shift" }, { "id": "Daily", "name": "Daily" }, { "id": "Period", "name": "Period" }], "includeActivityEvent": false, "includeActivityAllocation": false, "includeActivityTotalActual": false, "includeActivityTotalAllocated": false, "includeActivityTotalVariance": false, "hidePaidCorrection": false, "paidCorrectionFilterEnabled": true}]
Beispiel: Personenprofilinformationen abrufen
In diesem Beispiel werden Informationen zu Personenprofilen abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Retrieve People Information Profiles
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Headers": { "Content-Type": "application/json" }, "RequestBody": { "where": { "ids": [-1.0, 651.0] } } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Retrieve People Information Profiles
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "ResponseBody": "[{\"id\":-1,\"description\":\"Default People Information Profile with Default People Information Settings\",\"name\":\"Default People Information Profile\",\"peopleInfoSetting\":{\"id\":-1,\"description\":\"Default People Information Profile with All Hyperfind Query\",\"hfquery\":{\"id\":1,\"hfName\":\"&Person.All_Home\",\"name\":\"All Home\"},\"name\":\"Default People Information Profile\"}},{\"id\":651,\"description\":\"All Home Employees\",\"name\":\"$R-All Home\",\"peopleInfoSetting\":{\"id\":649,\"description\":\"All Home Employees\",\"hfquery\":{\"id\":1,\"hfName\":\"&Person.All_Home\",\"name\":\"All Home\"},\"name\":\"$R-All Home\"}}]", "StatusCode": 200.0 }]
Beispiel – Alle Beschäftigungsbedingungen abrufen
In diesem Beispiel werden alle Beschäftigungsbedingungen abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Retrieve All Employment Terms
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Query parameters": { "id": 2202.0 } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Retrieve All Employment Terms
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "ResponseBody": "[{\"allowsInheritance\":false,\"isActive\":true,\"name\":\"$AU-Casual\",\"id\":2202,\"processType\":\"ENFORCE_END_DATE\",\"versions\":{\"employmentTermVersion\":[{\"id\":702,\"accrualProfile\":{\"id\":1402,\"qualifier\":\"$AU-Casual\",\"name\":\"$AU-Casual\"},\"endDate\":\"3000-01-01\",\"holidayProfile\":{\"id\":152,\"qualifier\":\"AU Casual Holiday Profile\",\"name\":\"AU Casual Holiday Profile\"},\"startDate\":\"1900-01-01\",\"minimumWage\":{}}]},\"persistentId\":\"$AU-Casual\"}]", "StatusCode": 200.0 }]
Beispiel: Attestierungsprofile erstellen
In diesem Beispiel werden die Attestierungsprofile erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Create Attestation Profiles
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Headers": { "Content-Type": "application/json" }, "RequestBody": { "versionCount": 0.0, "name": "Empty Profile 3", "deleted": false, "attestationAssignments": [] } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Create Attestation Profiles
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "id": 434.0, "versionCount": 0.0, "name": "Empty Profile 3", "deleted": false }]
Beispiel – Abrufen eines Urlaubs- und Abwesenheitsprofils anhand der ID
In diesem Beispiel wird ein Urlaubs- und Abwesenheitsprofil anhand der ID abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Retrieve Leave Profile by Id
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Path parameters": { "id": 3.0 } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Retrieve Leave Profile by Id
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "id": 3.0, "isActive": true, "leaveProfileCategory": [{ "id": 1.0, "qualifier": "Military", "leaveProfileCategoryConfigurableData": [{ "configurableData": { "id": 1.0, "qualifier": "Active Duty Period" } }], "leaveProfileCategoryRule": [], "leaveProfileCategoryType": [{ "leaveType": [{ "id": 21.0, "qualifier": "Military Duty Leave Tracking" }] }, { "leaveType": [{ "id": 53.0, "qualifier": "Personal Leave" }] }, { "leaveType": [{ "id": 59.0, "qualifier": "Vacation Leave" }] }] }, { "id": 2.0, "qualifier": "Self", "leaveProfileCategoryConfigurableData": [{ "configurableData": { "id": 2.0, "qualifier": "Amount Paid" } }, { "configurableData": { "id": 4.0, "qualifier": "Disability Case Number" } }]
Beispiel – Verfügbare Regeln abrufen
In diesem Beispiel werden die verfügbaren Regeln abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufactions
. - Wählen Sie die Aktion
Retrieve Available Rules
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Datenzuordnung auf
Open Data Mapping Editor
und geben Sie dann einen Wert ähnlich dem folgenden in FeldInput
ein:{ "Query parameters": { "leave_case_id": 189.0 } }
Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload
des Retrieve Available Rules
-Vorgangs einen Wert, der dem folgenden ähnelt:
[{ "leaveCase": { "id": 189.0, "qualifier": "Physical Therapy", "name": "Physical Therapy" }, "availableLeaveRules": [{ "id": 20.0, "availableLeaveTypes": [{ "id": 1.0, "paid": false, "enabled": true, "payCode": { "id": 107.0, "qualifier": "LV-ADAA Leave", "name": "LV-ADAA Leave" }, "accrualCode": { "id": 2.0, "qualifier": "LV-ADA Leave", "name": "LV-ADA Leave" }, "qualifier": "ADA Leave", "name": "ADA Leave" }, { "id": 11.0, "paid": false, "enabled": true, "presentedInLeaveRule": true, "payCode": { "id": 134.0, "qualifier": "LV-FMLA Injury Illness", "name": "LV-FMLA Injury Illness" }, "accrualCode": { "id": 12.0, "qualifier": "LV-FMLA", "name": "LV-FMLA" }, "qualifier": "FMLA Illness Injury", "name": "FMLA Illness Injury" }, { "id": 31.0, "paid": false, "enabled": true, "presentedInLeaveRule": true, "payCode": { "id": 165.0, "qualifier": "LV-Non FMLA Tracking", "name": "LV-Non FMLA Tracking" }, "accrualCode": { "id": 24.0, "qualifier": "LV-Tracking", "name": "LV-Tracking" }, "qualifier": "Non-FMLA Illness Injury", "name": "Non-FMLA Illness Injury" } }]
Verbindungen mit Terraform erstellen
Sie können die Terraform-Ressource verwenden, um eine neue Verbindung zu erstellen.
Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.
Ein Beispiel für eine Terraform-Vorlage zum Erstellen einer Verbindung finden Sie hier.
Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:
Parametername | Datentyp | Erforderlich | Beschreibung |
---|---|---|---|
proxy_enabled | BOOLEAN | Falsch | Aktivieren Sie dieses Kästchen, um einen Proxyserver für die Verbindung zu konfigurieren. |
proxy_auth_scheme | ENUM | Falsch | Der Authentifizierungstyp, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. Unterstützte Werte: BASIC, DIGEST, NONE |
proxy_user | STRING | Falsch | Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. |
proxy_password | SECRET | Falsch | Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet werden soll. |
UKG-Verbindung in einer Integration verwenden
Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung in einer Integration über die Aufgabe „Connectors“ verwenden.
- Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
- Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors-Aufgabe.