UKG

Il connettore UKG consente di eseguire varie azioni sui dati UKG.

Prima di iniziare

Prima di utilizzare il connettore UKG, esegui le seguenti attività:

  • Nel tuo progetto Google Cloud:
    • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
    • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente "non umano" che deve eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta Creare un account di servizio.

    • Attiva i seguenti servizi:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Per informazioni su come attivare i servizi, consulta Abilitazione dei servizi.

    Se questi servizi o autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti verrà chiesto di attivarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore devi creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione distinta per ciascuna. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
  3. Nella sezione Posizione, scegli la località per la connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le aree geografiche supportate, consulta la sezione Località.

    2. Fai clic su AVANTI.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona UKG dall'elenco a discesa dei connettori disponibili.
    2. Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
    3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 49 caratteri.
    4. Facoltativamente, inserisci una descrizione per l'istanza di connessione.
    5. Se vuoi, attiva Cloud Logging e poi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
    6. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
    7. Servizio/modulo: seleziona il modulo UKG.
    8. Facoltativamente, configura le impostazioni del nodo di connessione:

      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, al contrario, meno nodi per elaborare meno transazioni. Per comprendere in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una maggiore disponibilità) e il numero massimo di nodi è impostato su 50.

    9. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    10. Fai clic su AVANTI.
  5. Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
    1. Tipo di destinazione: seleziona un Tipo di destinazione.
      • Seleziona Indirizzo host dall'elenco per specificare il nome host o l'indirizzo IP della destinazione.
      • Se vuoi stabilire una connessione privata ai tuoi sistemi di backend, seleziona Collegamento endpoint dall'elenco, quindi seleziona il collegamento dell'endpoint richiesto. dall'elenco Allegato endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con una maggiore sicurezza, puoi prendere in considerazione la configurazione di indirizzi IP statici in uscita per le tue connessioni, quindi configurare le regole del firewall in modo da inserire nella lista consentita solo gli indirizzi IP statici specifici.

      Per inserire destinazioni aggiuntive, fai clic su + AGGIUNGI DESTINAZIONE.

    2. Fai clic su AVANTI.
  6. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
    1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione UKG supporta i seguenti tipi di autenticazione:

      • Autenticazione di base
      • OAUTH 2.0 - Codice di autorizzazione

        • Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

      • Fai clic su AVANTI.
  7. Rivedi: controlla i dettagli di connessione e autenticazione.
  8. Fai clic su Crea.

Configura autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

  • Autenticazione di base
    • Nome utente: il nome utente utilizzato per autenticare il connettore.
    • Password: il segreto Secret Manager contenente la password associata al connettore.
    • OAUTH 2.0 - Codice di autorizzazione
    • ID client: l'ID client utilizzato per richiedere i token di accesso.
    • Ampiezze: un elenco separato da virgole degli ambiti desiderati.
    • Client Secret: secret di Secret Manager contenente il client secret per l'app connessa che hai creato.
    • Abilita PKCE: seleziona questa opzione se vuoi attivare lo scambio della chiave di codice di prova (PKCE).
    • URL di autorizzazione: l'URL di autorizzazione per la tua app. Verrà visualizzata questa pagina per accedere all'app.
    • Access Token URL (URL token di accesso): l'URL da utilizzare per modificare il token di accesso. Fornisci l'URL completo, incluso lo schema.

Esempi di configurazione della connessione

Questa sezione elenca i valori di esempio per i vari campi che configuri durante la creazione della connessione.

OAUTH 2.0 - Tipo di connessione del codice di autorizzazione

Nome campo Dettagli
Località us-central1
Connettore UKG
Versione del connettore 1
Nome collegamento gcp-ukg-oauth-conn
Abilita Cloud Logging Sì
Livello di log Errore
Account di servizio SERVICEACCOUNT_NAME@developer.gserviceaccount.com
Apri modulo delle specifiche API Cronometraggio
Livello di verbosità 5
Numero minimo di nodi 2
Numero massimo di nodi 50
Tipo di destinazione Indirizzo host
Indirizzo host https://google-connect-dev.cfn.mykronos.com
ID client ZG******-****-****-****-*********uDN
Client secret Secret
Versione secret 1
URL di autorizzazione https://google-connect-dev.cfn.mykronos.com/oauth2/authorize
URL del token di accesso https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token

Limitazioni di sistema

Il connettore UKG può elaborare 30 transazioni al secondo, per nodo, e throttles qualsiasi transazione oltre questo limite. Per impostazione predefinita, Integration Connectors alloca due nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

di correzione

Questo connettore ti consente di eseguire varie azioni sui dati UKG.

Questa sezione elenca le azioni supportate dal connettore UKG. Per capire come configurare le azioni, consulta Esempi di azioni.

Azione RetrieveAllEmployeeGroupsOrByName

Recupera tutti i gruppi di dipendenti per nome.

Parametri di input dell'azione RetrieveAllEmployeeGroupsOrByName

Nome parametro Tipo di dati Obbligatorio Descrizione
all_details boolean Vero Un valore booleano che indica se la risposta è leggera, ovvero una risposta contenente solo campi ID e nome.
nome string Vero Il nome di un gruppo di dipendenti.

Per esempio, su come configurare l'azione RetrieveAllEmployeeGroupsOrByName, consulta Esempi.

Crea azione PayCode

Crea un codice di pagamento.

Parametri di input dell'azione Crea PayCode

Nome parametro Tipo di dati Obbligatorio Descrizione
tipo string Vero Il tipo di codice pagamento.
nome string Vero Il nome del codice di pagamento.
unità string Vero L'unità per il codice pagamento.
codice integer Vero Il numero di codice assegnato a un codice di pagamento.

Ad esempio su come configurare l'azione CreatePayCode consulta gli esempi.

Azione DeletePayCodebyId

Consente di eliminare un codice pagamento in base all'ID.

Parametri di input dell'azione DeletePayCodebyId

Nome parametro Tipo di dati Obbligatorio Descrizione
ID integer Vero L'ID di un codice pagamento.

Ad esempio su come configurare l'azione DeletePayCodebyId consulta gli esempi.

Aggiornamento regola di lavoro per azione ID

Aggiorna la regola di lavoro utilizzando l'ID.

Parametri di input dell'azione Aggiorna regola lavoro per ID

Nome parametro Tipo di dati Obbligatorio Descrizione
workRuleId integer Vero ID della regola di lavoro
workRuleVersion json Vero La versione della regola di lavoro associata a una regola di lavoro.
nome string Vero Il nome di una regola di lavoro.
versione integer Vero Versione della regola di lavoro.

Ad esempio su come configurare l'azione Update Work Rule by ID consulta gli esempi.

Esempi di azioni

Esempio: RetrieveAllEmployeeGroupsOrByName

Questo esempio recupera i gruppi di dipendenti.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione RetrieveAllEmployeeGroupsOrByName e fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "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\":\"}]

Esempio: crea PayCode

Questo esempio crea un codice pagamento.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Create PayCode e poi fai clic su Fine.
  3. Nella sezione Mappatura dei dati Open Data Mapping Editor, quindi inserisci un valore simile al seguente nella Campo 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. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività CreatePayCode avrà un valore simile al seguente:

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

Esempio: DeletePayCodebyId

Questo esempio elimina un codice pagamento in base all'ID.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione DeletePayCodebyId e fai clic su Fine.
  3. Nella sezione Mappatura dei dati Open Data Mapping Editor, quindi inserisci un valore simile al seguente nella Campo Input: 
      {
  "Path parameters": {
    "id": 6002.0
  }
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività DeletePayCodebyId avrà un valore simile al seguente:

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

Esempio: aggiorna la regola di lavoro in base all'ID

Questo esempio aggiorna la regola di lavoro.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Update Work Rule by ID e fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "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. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività Update Work Rule by ID avrà un valore simile al seguente:

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

Esempio: elimina regola fissa per ID

Questo esempio elimina una regola fissa specifica.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Delete Fixed Rule by ID e fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "Path parameters": {
    "id": 1152.0
  }
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task Delete Fixed Rule by ID avrà un valore simile al seguente:

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

Esempio - Recupero dei codici di accumulo

Questo esempio recupera i codici di accreditamento.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Retrieve Accrual Codes e poi fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "Query parameters": {
    "id": 1303.0
  }
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task Retrieve Accrual Codes avrà un valore simile al seguente:

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

Esempio: creare l'orario di apertura

Questo esempio crea gli orari di apertura.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Create Hours of Operation e poi fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "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. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task Create Hours of Operation avrà un valore simile al seguente:

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

Esempio - Aggiornamento dell'impostazione della scheda temporale per ID

Questo esempio aggiorna l'impostazione della scheda ora specifica.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Update Timecard Setting by ID e poi fai clic su Fine.
  3. Nella sezione Mappatura dei dati Open Data Mapping Editor, quindi inserisci un valore simile al seguente nella Campo 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. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività Update Timecard Setting by ID avrà un valore simile al seguente:

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

Esempio - Recupera i profili delle informazioni sulle persone

Questo esempio recupera i profili con le informazioni sulle persone.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Retrieve People Information Profiles e fai clic su Fine.
  3. Nella sezione Mappatura dei dati Open Data Mapping Editor, quindi inserisci un valore simile al seguente nella Campo Input: 
      {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "where": {
      "ids": [-1.0, 651.0]
    }
  }
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task Retrieve People Information Profiles avrà un valore simile al seguente:

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

Esempio - Recupera tutti i termini di impiego

Questo esempio recupera tutti i termini di impiego.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Retrieve All Employment Terms e fai clic su Fine.
  3. Nella sezione Mappatura dei dati Open Data Mapping Editor, quindi inserisci un valore simile al seguente nella Campo Input: 
       {
  "Query parameters": {
    "id": 2202.0
  }
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task Retrieve All Employment Terms avrà un valore simile al seguente:

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

Esempio - Creare profili di attestazione

Questo esempio crea i profili di attestazione.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Create Attestation Profiles e poi fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "versionCount": 0.0,
    "name": "Empty Profile 3",
    "deleted": false,
    "attestationAssignments": []
  }
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività Create Attestation Profiles avrà un valore simile al seguente:

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

Esempio: recuperare il profilo di abbandono in base all'ID

Questo esempio recupera un profilo di congedo in base all'ID.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Retrieve Leave Profile by Id e fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "Path parameters": {
    "id": 3.0
  }
}

    4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task Retrieve Leave Profile by Id avrà un valore simile al seguente:

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

Esempio: recupera le regole disponibili

Questo esempio recupera le regole disponibili.

  1. Nella finestra di dialogo Configure connector task, fai clic su actions.
  2. Seleziona l'azione Retrieve Available Rules e poi fai clic su Fine.
  3. Nella sezione Mappatura dei dati, Open Data Mapping Editor poi inserisci un valore simile al seguente nel Input campo: 
     {
  "Query parameters": {
    "leave_case_id": 189.0
  }
}

    4. Se l'azione viene eseguita correttamente, Risposta connectorOutputPayload dell'attività Retrieve Available Rules avrà un valore simile al seguente:

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

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta: Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di connessioni, vedi il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione Terraform:

Nome parametro Tipo di dati Obbligatorio Descrizione
proxy_enabled BOOLEANO Falso Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme ENUM Falso Il tipo di autenticazione da utilizzare per l'autenticazione al proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user STRING Falso Un nome utente da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_password SECRET Falso Una password da utilizzare per eseguire l'autenticazione sul proxy ProxyServer.

Utilizzare la connessione UKG in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'integrazione Apigee sia nell'integrazione delle applicazioni. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

  • Per informazioni su come creare e utilizzare l'attività Connectors in Apigee Integration, consulta Attività Connectors.
  • Per capire come creare e utilizzare l'attività Connettori in Application Integration, vedi Attività connettori.

Ricevi assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community Google Cloud ai forum Cloud.

Passaggi successivi