UKG

El conector de UKG te permite realizar varias acciones con los datos de UKG.

Antes de empezar

Antes de usar el conector de UKG, haz lo siguiente:

  • En tu proyecto de Google Cloud:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
    • Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. Para obtener más información, consulta el artículo Crear una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para saber cómo habilitar servicios, consulta Habilitar servicios.

    Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.

Configurar el conector

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

  2. Haz clic en + CREAR NUEVA para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación de la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

    2. Haz clic en SIGUIENTE.
  4. En la sección Detalles de la conexión, haz lo siguiente:
    1. Conector: selecciona UKG en la lista desplegable de conectores disponibles.
    2. Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
    3. En el campo Connection Name (Nombre de conexión), introduce un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir los siguientes criterios:

      • Los nombres de conexión pueden contener letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
      • Los nombres de conexión no pueden tener más de 49 caracteres.
    4. Si quiere, puede introducir una Descripción para la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es Error.
    6. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Servicio o módulo: selecciona el módulo de UKG.
    8. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo influyen los nodos en el precio de tu conector, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    9. También puedes hacer clic en + AÑADIR ETIQUETA para añadir una etiqueta a la conexión en forma de par clave-valor.
    10. Haz clic en SIGUIENTE.
  5. En la sección Destinations (Destinos), introduce los detalles del host remoto (sistema backend) al que quieras conectarte.
    1. Tipo de destino: selecciona un Tipo de destino.
      • Para especificar el nombre de host o la dirección IP de destino, selecciona Dirección de host y introduce la dirección en el campo Host 1.
      • Para establecer una conexión privada, selecciona Endpoint attachment (Endpoint adjunto) y elige el adjunto que quieras de la lista Endpoint Attachment (Endpoint adjunto).

      Si quieres establecer una conexión pública con tus sistemas backend con seguridad adicional, puedes configurar direcciones IP de salida estáticas para tus conexiones y, a continuación, configurar las reglas de tu cortafuegos para que solo se permitan las direcciones IP estáticas específicas.

      Para introducir más destinos, haga clic en +AÑADIR DESTINO.

    2. Haz clic en SIGUIENTE.
  6. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

      La conexión de UKG admite los siguientes tipos de autenticación:

      • Autenticación básica
      • OAUTH 2.0 - Código de autorización
      • Para saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

      • Haz clic en SIGUIENTE.
  7. Revisar: revisa los detalles de la conexión y la autenticación.
  8. Haz clic en Crear.

Configurar la autenticación

Introduce los detalles en función de la autenticación que quieras usar.

  • Autenticación básica
    • Nombre de usuario: el nombre de usuario que se usa para autenticar el conector.
    • Contraseña: secreto de Secret Manager que contiene la contraseña asociada al conector.
  • OAUTH 2.0: código de autorización
    • ID de cliente: el ID de cliente que se usa para solicitar tokens de acceso.
    • Scopes: lista separada por comas de los permisos deseados.
    • Secreto de cliente: secreto de Secret Manager que contiene el secreto de cliente de la aplicación conectada que has creado.
    • Habilitar PKCE: selecciona esta opción si quieres habilitar la clave de prueba para el intercambio de código (PKCE).
    • URL de autorización: URL de autorización de su aplicación. Se le redirigirá a esta página para iniciar sesión en su aplicación.
    • URL del token de acceso: la URL que se usará para intercambiar el token de acceso. Proporciona una URL completa, incluido el esquema.

Ejemplos de configuración de conexiones

En esta sección se indican los valores de ejemplo de los distintos campos que se configuran al crear la conexión.

OAUTH 2.0: tipo de conexión de código de autorización

Nombre del campo Detalles
Ubicación us-central1
Conector UKG
Versión del conector 1
Nombre de la conexión gcp-ukg-oauth-conn
Habilitar Cloud Logging
Nivel de registro Error
Cuenta de servicio SERVICEACCOUNT_NAME@developer.gserviceaccount.com
Módulo de especificación de API abierta Precisión
Nivel de verbosidad 5
Número mínimo de nodos 2
Número máximo de nodos 50
Tipo de destino Dirección del host
Dirección del host https://google-connect-dev.cfn.mykronos.com
ID de cliente ZG******-****-****-****-*********uDN
Secreto de cliente Secret
Versión de secreto 1
URL de autorización https://google-connect-dev.cfn.mykronos.com/oauth2/authorize
URL de token de acceso https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token

Limitaciones del sistema

El conector de UKG puede procesar 30 transacciones por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

acciones

Este conector te permite realizar varias acciones con los datos de UKG.

En esta sección se enumeran las acciones admitidas por el conector de UKG. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Acción RetrieveAllEmployeeGroupsOrByName

Obtiene todos los grupos de empleados por nombre.

Parámetros de entrada de la acción RetrieveAllEmployeeGroupsOrByName

Nombre del parámetro Tipo de datos Obligatorio Descripción
all_details booleano Verdadero Valor booleano que indica si la respuesta es ligera, es decir, si solo contiene los campos ID y nombre.
name cadena Verdadero El nombre de un grupo de empleados.

Para ver un ejemplo de cómo configurar la acción RetrieveAllEmployeeGroupsOrByName, consulta Ejemplos.

Crear acción PayCode

Crea un código de pago.

Parámetros de entrada de la acción Create PayCode

Nombre del parámetro Tipo de datos Obligatorio Descripción
tipo cadena Verdadero El tipo de código de pago.
name cadena Verdadero Nombre del código de pago.
unidad cadena Verdadero Unidad del código de pago.
codeNumber entero Verdadero Número de código asignado a un código de pago.

Para ver un ejemplo de cómo configurar la acción CreatePayCode, consulta Ejemplos.

Acción DeletePayCodebyId

Elimina un código de pago según el ID.

Parámetros de entrada de la acción DeletePayCodebyId

Nombre del parámetro Tipo de datos Obligatorio Descripción
id entero Verdadero ID de un código de pago.

Para ver un ejemplo de cómo configurar la acción DeletePayCodebyId, consulta Ejemplos.

Actualizar regla de trabajo por ID

Actualiza una regla de trabajo mediante el ID.

Parámetros de entrada de la acción Update Work Rule by ID

Nombre del parámetro Tipo de datos Obligatorio Descripción
workRuleId entero Verdadero ID de la regla de trabajo
workRuleVersion json Verdadero Versión de la regla de trabajo asociada a una regla de trabajo.
name cadena Verdadero Nombre de una regla de trabajo.
version entero Verdadero Versión de la regla de trabajo.

Para ver un ejemplo de cómo configurar la acción Update Work Rule by ID, consulta Ejemplos.

Ejemplos de acciones

Ejemplo: RetrieveAllEmployeeGroupsOrByName

En este ejemplo se obtienen grupos de empleados.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción RetrieveAllEmployeeGroupsOrByName y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo 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\":\"}]
      

Ejemplo: crear un PayCode

En este ejemplo se crea un código de pago.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Create PayCode y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el 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. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea CreatePayCode tendrá un valor similar al siguiente:

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

Ejemplo: DeletePayCodebyId

En este ejemplo se elimina un código de pago en función del ID.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción DeletePayCodebyId y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
      {
      "Path parameters": {
        "id": 6002.0
      }
    } 
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DeletePayCodebyId tendrá un valor similar al siguiente:

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

Ejemplo: actualizar una regla de trabajo por ID

En este ejemplo se actualiza la regla de trabajo.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Update Work Rule by ID y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo 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 la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Update Work Rule by ID tendrá un valor similar al siguiente:

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

Ejemplo: Eliminar una regla fija por ID

En este ejemplo se elimina una regla fija específica.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Delete Fixed Rule by ID y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
     {
      "Path parameters": {
        "id": 1152.0
      }
    } 
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Delete Fixed Rule by ID tendrá un valor similar al siguiente:

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

Ejemplo: obtener códigos de acumulación

En este ejemplo se obtienen códigos de acumulación.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Retrieve Accrual Codes y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
     {
      "Query parameters": {
        "id": 1303.0
      }
    } 
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Retrieve Accrual Codes tendrá un valor similar al siguiente:

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

Ejemplo: crear un horario de apertura

En este ejemplo se crea un horario de apertura.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Create Hours of Operation y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo 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 la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Create Hours of Operation tendrá un valor similar al siguiente:

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

Ejemplo: actualizar la configuración de la tarjeta de registro por ID

En este ejemplo se actualiza el ajuste de tarjeta de tiempo específico.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Update Timecard Setting by ID y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el 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. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Update Timecard Setting by ID tendrá un valor similar al siguiente:

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

Ejemplo: obtener perfiles de información de personas

En este ejemplo se obtienen perfiles de información de personas.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Retrieve People Information Profiles y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
      {
      "Headers": {
        "Content-Type": "application/json"
      },
      "RequestBody": {
        "where": {
          "ids": [-1.0, 651.0]
        }
      }
    }
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Retrieve People Information Profiles tendrá un valor similar al siguiente:

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

Ejemplo: obtener todos los términos de empleo

En este ejemplo se obtienen todos los términos de empleo.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Retrieve All Employment Terms y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
       {
      "Query parameters": {
        "id": 2202.0
      }
    } 
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Retrieve All Employment Terms tendrá un valor similar al siguiente:

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

Ejemplo: crear perfiles de atestación

En este ejemplo se crean los perfiles de atestación.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Create Attestation Profiles y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
     {
      "Headers": {
        "Content-Type": "application/json"
      },
      "RequestBody": {
        "versionCount": 0.0,
        "name": "Empty Profile 3",
        "deleted": false,
        "attestationAssignments": []
      }
    }
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Create Attestation Profiles tendrá un valor similar al siguiente:

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

Ejemplo: Obtener un perfil de ausencia por ID

En este ejemplo se obtiene un perfil de ausencia en función del ID.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Retrieve Leave Profile by Id y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
     {
      "Path parameters": {
        "id": 3.0
      }
    } 
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Retrieve Leave Profile by Id tendrá un valor similar al siguiente:

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

Ejemplo: Obtener reglas disponibles

En este ejemplo se obtienen las reglas disponibles.

  1. En el cuadro de diálogo Configure connector task, haz clic en actions.
  2. Seleccione la acción Retrieve Available Rules y, a continuación, haga clic en Hecho.
  3. En la sección Asignación de datos Open Data Mapping Editor y, a continuación, introduce un valor similar al siguiente en el campo Input:
     {
      "Query parameters": {
        "leave_case_id": 189.0
      }
    } 
  4. Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Retrieve Available Rules tendrá un valor similar al siguiente:

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

Crear conexiones con Terraform

Puedes usar el recurso de Terraform para crear una conexión.

Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para crear una conexión, consulta la plantilla de ejemplo.

Cuando crees esta conexión con Terraform, debes definir las siguientes variables en el archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Obligatorio Descripción
proxy_enabled BOOLEAN Falso Seleccione esta casilla para configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso Tipo de autenticación que se usará para autenticar el proxy ProxyServer. Los valores posibles son: BASIC, DIGEST y NONE.
proxy_user STRING Falso Nombre de usuario que se usará para autenticar el proxy ProxyServer.
proxy_password SECRET Falso Contraseña que se usará para autenticarse en el proxy ProxyServer.

Usar la conexión de UKG en una integración

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos