U.K.G

Mit dem UKG-Connector können Sie verschiedene Aktionen auf UKG-Daten ausführen.

Hinweise

Führen Sie die folgenden Schritte aus, bevor Sie den UKG-Connector verwenden:

  • In Ihrem Google Cloud-Projekt:
    • Weisen Sie dem Nutzer die IAM-Rolle roles/connectors.admin zu. Connector konfigurieren.
    • 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

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. 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:

  1. 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.

    Zur Seite „Verbindungen“

  2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
  3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
    1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

    2. Tippen Sie auf Weiter.
  4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
    1. Connector: Wählen Sie UKG aus der Drop-down-Liste der verfügbaren Connectors aus.
    2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
    3. 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 63 Zeichen haben.
    4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
    5. Aktivieren Sie optional Cloud Logging. und wählen Sie dann eine Logebene aus. Die Logebene ist standardmäßig auf Error festgelegt.
    6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
    7. Dienst/Modul: Wählen Sie das UKG-Modul aus.
    8. Konfigurieren Sie optional die Einstellungen für den Verbindungsknoten:

      • 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.

    9. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    10. Tippen Sie auf Weiter.
  5. Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
    1. Destination Type: Wählen Sie einen Destination Type aus.
      • Wählen Sie aus der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse für das Ziel anzugeben.
      • Wenn Sie eine private Verbindung zu Ihren Backend-Systemen herstellen möchten, wählen Sie in der Liste Endpunktanhang und dann den erforderlichen Endpunktanhang 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.

    2. Tippen Sie auf Weiter.
  6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
    1. 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

        • Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

      • Tippen Sie auf WEITER.
  7. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
  8. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

  • Basisauthentifizierung
    • Nutzername: Der Nutzername für die Authentifizierung des Connectors.
    • 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 den Proof Key for Code Exchange (PKCE) aktivieren möchten.
    • Autorisierungs-URL: Autorisierungs-URL für Ihre App. Sie werden auf diese Seite weitergeleitet, um sich in Ihrer App anzumelden.
    • Access Token URL (Zugriffstoken-URL): Die URL, die für den Austausch des Zugriffstokens verwendet werden soll. Geben Sie die vollständige URL einschließlich Schema an.

Beispiele für Verbindungskonfiguration

In diesem Abschnitt werden die Beispielwerte für die verschiedenen Felder, die Sie beim Erstellen der Verbindung konfigurieren.

OAUTH 2.0 – Verbindungstyp „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
Modul für API-Spezifikation öffnen Zeiterfassung
Ausführlichkeit 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 verarbeiten. pro Knoten, und throttles Transaktionen über diesen Grenzwert hinaus. Standardmäßig weist Integration Connectors einer Verbindung 2 Knoten zu (für bessere Verfügbarkeit).

Informationen zu den für Integration Connectors geltenden Limits finden Sie unter Beschränkungen.

Aktionen

Mit diesem Connector können Sie verschiedene Aktionen für UKG-Daten ausführen.

In diesem Abschnitt sind die vom UKG-Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

Aktion "RetrieveAllEmployeeGroupsOrByName"

Hiermit werden alle Mitarbeitergruppen nach Name abgerufen.

Eingabeparameter der Aktion RetrieveAllEmployeeGroupsOrByName

Parametername Datentyp Erforderlich Beschreibung
all_details boolean Wahr Ein boolescher Wert, der angibt, ob es sich bei der Antwort um eine Lightweight-Antwort handelt, d. h. eine Antwort, die nur ID- und Namensfelder enthält.
name String Wahr Der Name einer Mitarbeitergruppe.

So konfigurieren Sie beispielsweise die Aktion RetrieveAllEmployeeGroupsOrByName. Siehe Beispiele.

PayCode-Aktion erstellen

Erstellt einen Zahlungscode

Eingabeparameter der Aktion "PayCode erstellen"

Parametername Datentyp Erforderlich Beschreibung
Typ String Wahr Die Art des Zahlungscodes.
name String Wahr Der Name des Zahlungscodes.
unit String Wahr Die Einheit für den Zahlungscode.
codeNumber integer Wahr Die einem Zahlungscode zugewiesene Codenummer.

Ein Beispiel für die Konfiguration der Aktion CreatePayCode finden Sie unter Beispiele.

DeletePayCodebyId-Aktion

Löscht einen Zahlungscode basierend auf der ID.

Eingabeparameter der Aktion DeletePayCodebyId

Parametername Datentyp Erforderlich Beschreibung
id integer Wahr Die ID eines Zahlungscodes.

So konfigurieren Sie beispielsweise die Aktion DeletePayCodebyId. Siehe Beispiele.

Aktion „Arbeitsregel nach ID“ aktualisieren

Aktualisiert die Arbeitsregel anhand der ID.

Eingabeparameter der Aktion „Arbeitsregel anhand der ID aktualisieren“

Parametername Datentyp Erforderlich Beschreibung
workRuleId integer Wahr ID der Arbeitsregel
workRuleVersion json Wahr Die Version der Arbeitsregel, die mit einer Arbeitsregel verknüpft ist.
name String Wahr Der Name einer Arbeitsregel.
Version integer Wahr Version der Arbeitsregel.

So konfigurieren Sie beispielsweise die Aktion Update Work Rule by ID. Siehe Beispiele.

Aktionsbeispiele

Beispiel: RetrieveAllEmployeeGroupsOrByName

In diesem Beispiel werden Mitarbeitergruppen abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion RetrieveAllEmployeeGroupsOrByName aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "Query parameters": {
    "all_details": true
  }
} 

     If the action is successful, the
  RetrieveAllEmployeeGroupsOrByName task's connectorOutputPayload response
  parameter will have a value similar to the following:
    
  
     
  [{
    "ResponseBody": "[{\"name\":\"$U-South Region\",\"id\":1401,\"orgMapGroupRef\":{\"id\":2452,\"qualifier\":\"$U-South Region\"},\"version\":0,\"updateDtm\":\"2020-03-04T16:06:46\",\"persistentId\":\"$U-South#Region\"},{\"name\":\"$U-Canada Region\",\"id\":1451,\"orgMapGroupRef\":{\"id\":2453,\"qualifier\":\"$U-Canada Region\"},\"version\":0,\"updateDtm\":\"2020-03-04T16:07:21\",\"persistentId\":\"}]

Beispiel – PayCode erstellen

In diesem Beispiel wird ein Zahlungscode erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Create PayCode aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Datenzuordnung auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input 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"
    }
  }

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von CreatePayCode hat einen Wert ähnlich dem folgenden:

     
  [{
    "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 Zahlungscode anhand der ID gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion DeletePayCodebyId aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
      {
  "Path parameters": {
    "id": 6002.0
  }
}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von DeletePayCodebyId hat einen Wert ähnlich dem folgenden:

     
 [{
  "ResponseBody": "",
  "StatusCode": 200.0
}]

Beispiel – Arbeitsregel nach ID aktualisieren

In diesem Beispiel wird die Arbeitsregel aktualisiert.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Update Work Rule by ID aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "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"
  }
}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von Update Work Rule by ID hat einen Wert ähnlich dem folgenden:

     
 [{
  "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.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Delete Fixed Rule by ID aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "Path parameters": {
    "id": 1152.0
  }
}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von Delete Fixed Rule by ID hat einen Wert ähnlich dem folgenden:

     
 [{
  "ResponseBody": "",
  "StatusCode": 204.0
}]

Beispiel – Abrechnungscodes abrufen

In diesem Beispiel werden akkubasierte Codes abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Retrieve Accrual Codes aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "Query parameters": {
    "id": 1303.0
  }
}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von Retrieve Accrual Codes hat einen Wert ähnlich dem folgenden:

     
 [{
  "ResponseBody": "[{\"id\":1303,\"typeId\":2,\"hoursPerDayInSeconds\":28800,\"name\":\"$LC Dia Familia\",\"shortName\":\"$LC Dia Familia\",\"typeName\":\"Day\",\"allowEdit\":true}]",
  "StatusCode": 200.0
}]

Beispiel – Öffnungszeiten festlegen

In diesem Beispiel werden die Geschäftszeiten erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Create Hours of Operation aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "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"
        }
      }]
    }]
  }
}

    4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe Create Hours of Operation einen Wert, der in etwa so aussieht:

     
[{
  "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 – Zeitachseneinstellung nach ID aktualisieren

In diesem Beispiel wird die Einstellung für die Zeitkarte aktualisiert.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Update Timecard Setting by ID aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "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}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von Update Timecard Setting by ID hat einen Wert ähnlich dem folgenden:

     
  [{
  "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 – Personeninformationsprofile abrufen

In diesem Beispiel werden Personeninformationsprofile abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Retrieve People Information Profiles aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
      {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "where": {
      "ids": [-1.0, 651.0]
    }
  }
}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von Retrieve People Information Profiles hat einen Wert ähnlich dem folgenden:

     
   [{
  "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.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Retrieve All Employment Terms aus und klicken Sie auf Fertig.
  3. Klicken Sie im Bereich Datenzuordnung auf Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Input ein: 
       {
  "Query parameters": {
    "id": 2202.0
  }
}

    4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe Retrieve All Employment Terms einen Wert, der in etwa so aussieht:

     
  [{
  "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.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Create Attestation Profiles aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "versionCount": 0.0,
    "name": "Empty Profile 3",
    "deleted": false,
    "attestationAssignments": []
  }
}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von Create Attestation Profiles hat einen Wert ähnlich dem folgenden:

     
[{
  "id": 434.0,
  "versionCount": 0.0,
  "name": "Empty Profile 3",
  "deleted": false
}]

Beispiel – Verlassen des Profils nach ID abrufen

In diesem Beispiel wird anhand der ID ein Urlaubsprofil abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Retrieve Leave Profile by Id aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "Path parameters": {
    "id": 3.0
  }
}

    4. Wenn die Aktion erfolgreich ist, connectorOutputPayload-Antwort der Aufgabe von Retrieve Leave Profile by Id hat einen Wert ähnlich dem folgenden:

     
 [{
  "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.

  1. Klicken Sie im Dialogfeld Configure connector task auf actions.
  2. Wählen Sie die Aktion Retrieve Available Rules aus und klicken Sie auf Fertig.
  3. Im Bereich Datenzuordnung Open Data Mapping Editor und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Input: 
     {
  "Query parameters": {
    "leave_case_id": 189.0
  }
}

    4. Wenn die Aktion erfolgreich war, hat der Antwortparameter connectorOutputPayload der Aufgabe Retrieve Available Rules einen Wert, der in etwa so aussieht:

     
 [{
  "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

Mit dem Terraform-Code Ressource, um eine neue Verbindung zu erstellen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Eine Beispiel-Terraform-Vorlage zum Erstellen von Verbindungen finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mithilfe von Terraform erstellen, müssen Sie in der Terraform-Konfigurationsdatei die folgenden Variablen festlegen:

Parametername Datentyp Erforderlich Beschreibung
proxy_enabled BOOLEAN Falsch Wählen Sie dieses Kontrollkästchen aus, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme ENUM Falsch Der für die Authentifizierung beim ProxyServer-Proxy zu verwendende Authentifizierungstyp. 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 VERTRAULICH Falsch Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.

UKG-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie in beiden Apigee-Integration und Anwendungsintegration Sie können die Verbindung über die Connectors-Aufgabe in einer Integration.

  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in der Apigee-Integration finden Sie unter Connectors-Aufgabe.
  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Tasks für Connectors.

Hilfe von der Google Cloud-Community erhalten

Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

Nächste Schritte