UKG

Le connecteur UKG vous permet d'effectuer diverses actions sur les données UKG.

Avant de commencer

Avant d'utiliser le connecteur UKG, effectuez les tâches suivantes:

  • Dans votre projet Google Cloud :
    • Vérifiez que la connectivité réseau est configurée. Pour en savoir plus sur les modèles de réseau, consultez la section Connectivité réseau.
    • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez la page Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.

    2. Cliquez sur NEXT (Suivant).
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur: sélectionnez UKG dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 49 caractères.
    4. Saisissez éventuellement une Description pour l'instance de connexion.
    5. Vous pouvez également activer Cloud Logging, puis sélectionner un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. Service/Module: sélectionnez le module UKG.
    8. Vous pouvez également configurer les paramètres du nœud de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

    9. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
    10. Cliquez sur NEXT (Suivant).
  5. Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
    1. Type de destination : sélectionnez un type de destination.
      • Sélectionnez Adresse hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement du point de terminaison dans la liste, puis sélectionnez le rattachement du point de terminaison requis dans la liste Rattachement du point de terminaison.

      Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.

      Pour saisir d'autres destinations, cliquez sur + AJOUTER UNE DESTINATION.

    2. Cliquez sur NEXT (Suivant).
  6. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion UKG:

      • Authentification de base
      • OAUTH 2.0 – Code d'autorisation

        • Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

      • Cliquez sur NEXT (Suivant).
  7. Vérifiez vos informations de connexion et d'authentification.
  8. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

  • Authentification de base
    • Nom d'utilisateur: nom d'utilisateur utilisé pour authentifier le connecteur.
    • Mot de passe : Secret de Secret Manager contenant le mot de passe associé au connecteur.
    • OAUTH 2.0 – Code d'autorisation
    • ID client : ID client utilisé pour demander des jetons d'accès.
    • Champs d'application:liste des champs d'application souhaités, séparés par une virgule.
    • Code secret du client : secret Secret Manager contenant le code secret client pour l'application connectée que vous avez créée.
    • Activer PKCE: sélectionnez cette option si vous souhaitez activer la clé de vérification pour l'échange de code (PKCE).
    • URL d'autorisation: URL d'autorisation de votre application. Vous serez redirigé vers cette page pour vous connecter à votre application.
    • URL du jeton d'accès: URL à utiliser pour échanger le jeton d'accès. Fournissez l'URL complète, y compris le schéma.

Exemples de configuration de connexion

Cette section présente des exemples de valeurs pour les différents champs que vous configurez lors de la création de la connexion.

OAUTH 2.0 : type de connexion avec code d'autorisation

Nom du champ Détails
Emplacement us-central1
Connecteur UKG
Version du connecteur 1
Nom de connexion gcp-ukg-oauth-conn
Activer Cloud Logging Oui
Niveau de journalisation Erreur
Compte de service SERVICEACCOUNT_NAME@developer.gserviceaccount.com
Module de spécification Open API Chronométrage
Niveau de verbosité 5
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Type de destination Adresse de l'hôte
Adresse de l'hôte https://google-connect-dev.cfn.mykronos.com
ID client ZG******-****-****-****-*********uDN
Code secret du client Secret
Version de secret 1
URL d'autorisation https://google-connect-dev.cfn.mykronos.com/oauth2/authorize
URL de jeton d'accès https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token

Limites du système

Le connecteur UKG peut traiter 30 transactions par seconde et par nœud, et limite les transactions au-delà de cette limite. Par défaut, les Integration Connectors allouent deux nœuds (pour une meilleure disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez la section Limites.

correctives

Ce connecteur vous permet d'effectuer diverses actions sur les données UKG.

Cette section répertorie les actions compatibles avec le connecteur UKG. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action RetrieveAllEmployeeGroupsOrByName

Récupère tous les groupes d'employés par nom.

Paramètres d'entrée de l'action RetrieveAllEmployeeGroupsOrByName

Nom du paramètre Type de données Obligatoire Description
all_details booléen Vrai Valeur booléenne indiquant si la réponse est légère, c'est-à-dire qu'elle ne contient que les champs d'ID et de nom.
nom chaîne Vrai Nom d'un groupe d'employés.

Pour obtenir des exemples de configuration de l'action RetrieveAllEmployeeGroupsOrByName, consultez la section Exemples.

Créer une action PayCode

Crée un code de paiement.

Paramètres d'entrée de l'action "Create PayCode" (Créer un code de paiement)

Nom du paramètre Type de données Obligatoire Description
type chaîne Vrai Type du code de paiement.
nom chaîne Vrai Nom du code de paiement.
unité chaîne Vrai Unité du code de paiement.
codeNumber entier Vrai Numéro de code attribué à un code de paiement.

Pour obtenir des exemples de configuration de l'action CreatePayCode, consultez la section Exemples.

Action DeletePayCodebyId

Supprime un code de paiement en fonction de l'ID.

Paramètres d'entrée de l'action DeletePayCodebyId

Nom du paramètre Type de données Obligatoire Description
id entier Vrai ID d'un code de paiement.

Pour obtenir des exemples de configuration de l'action DeletePayCodebyId, consultez la section Exemples.

Mettre à jour la règle de travail par action d'ID

Met à jour la règle de travail à l'aide de l'ID.

Paramètres d'entrée de l'action "Mettre à jour la règle de travail par ID"

Nom du paramètre Type de données Obligatoire Description
workRuleId entier Vrai ID de la règle de travail
workRuleVersion json Vrai Version de la règle de travail associée à une règle de travail.
nom chaîne Vrai Nom d'une règle de travail.
version entier Vrai Version de la règle de travail.

Pour obtenir des exemples de configuration de l'action Update Work Rule by ID, consultez la section Exemples.

Exemples d'actions

Exemple : RetrieveAllEmployeeGroupsOrByName

Cet exemple récupère des groupes d'employés.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action RetrieveAllEmployeeGroupsOrByName , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ 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\":\"}]

Exemple : Créer un code de paiement

Cet exemple crée un code de paiement.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Create PayCode, puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
      {
    "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. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche CreatePayCode aura une valeur semblable à celle-ci:

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

Exemple : DeletePayCodebyId

Cet exemple supprime un code de paiement en fonction de l'ID.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action DeletePayCodebyId , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
      {
  "Path parameters": {
    "id": 6002.0
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche DeletePayCodebyId aura une valeur semblable à celle-ci:

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

Exemple : Mettre à jour une règle de travail par ID

Cet exemple met à jour la règle de travail.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Update Work Rule by ID , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ 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. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Update Work Rule by ID aura une valeur semblable à celle-ci:

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

Exemple : Supprimer une règle fixe par ID

Cet exemple supprime une règle fixe spécifique.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Delete Fixed Rule by ID , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
     {
  "Path parameters": {
    "id": 1152.0
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Delete Fixed Rule by ID aura une valeur semblable à celle-ci:

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

Exemple : Récupérer les codes d'imputation

Cet exemple récupère les codes de précision.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Retrieve Accrual Codes , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
     {
  "Query parameters": {
    "id": 1303.0
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Retrieve Accrual Codes aura une valeur semblable à celle-ci:

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

Exemple : Créer des horaires d'ouverture

Cet exemple crée des heures d'ouverture.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Create Hours of Operation , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ 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. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Create Hours of Operation aura une valeur semblable à celle-ci:

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

Exemple : Mettre à jour le paramètre de la fiche de paie par ID

Cet exemple met à jour le paramètre de la fiche horaire spécifique.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Update Timecard Setting by ID , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ 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. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Update Timecard Setting by ID aura une valeur semblable à celle-ci:

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

Exemple : Récupération de profils d'informations sur les personnes

Cet exemple récupère des profils d'informations sur des personnes.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Retrieve People Information Profiles , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
      {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "where": {
      "ids": [-1.0, 651.0]
    }
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Retrieve People Information Profiles aura une valeur semblable à celle-ci:

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

Exemple : Récupérer tous les termes d'un contrat de travail

Cet exemple récupère tous les termes d'emploi.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Retrieve All Employment Terms , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
       {
  "Query parameters": {
    "id": 2202.0
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Retrieve All Employment Terms aura une valeur semblable à celle-ci:

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

Exemple : Créer des profils d'attestation

Cet exemple crée les profils d'attestation.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Create Attestation Profiles , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
     {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "versionCount": 0.0,
    "name": "Empty Profile 3",
    "deleted": false,
    "attestationAssignments": []
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Create Attestation Profiles aura une valeur semblable à celle-ci:

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

Exemple : Récupérer le profil de congé par ID

Cet exemple récupère un profil de congé en fonction de l'ID.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Retrieve Leave Profile by Id , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
     {
  "Path parameters": {
    "id": 3.0
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Retrieve Leave Profile by Id aura une valeur semblable à celle-ci:

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

Exemple : Récupérer les règles disponibles

Cet exemple récupère les règles disponibles.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur actions.
  2. Sélectionnez l'action Retrieve Available Rules , puis cliquez sur OK.
  3. Dans la section Mappage des données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input: 
     {
  "Query parameters": {
    "leave_case_id": 189.0
  }
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche Retrieve Available Rules aura une valeur semblable à celle-ci:

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

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour consulter un exemple de modèle Terraform permettant de créer une connexion, consultez l'exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre Type de données Requis Description
proxy_enabled VALEUR BOOLÉENNE Faux Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme ENUM Faux Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST et NONE.
proxy_user STRING Faux Nom d'utilisateur à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_password SECRET Faux Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.

Utiliser la connexion UKG dans une intégration

Une fois la connexion créée, elle devient disponible à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

  • Pour savoir comment créer et utiliser la tâche Connecteurs dans Apigee Integration, consultez la section Tâche Connecteurs.
  • Pour savoir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étape suivante