UKG

O conector UKG permite realizar várias ações nos dados de UKG.

Antes de começar

Antes de usar o conector do UKG, siga estas tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceder o papel do IAM roles/connectors.admin ao usuário e configurar o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione UKG na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Serviço/módulo: selecione o módulo do UKG.
    8. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    9. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    10. Clique em PRÓXIMA.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

    2. Clique em PRÓXIMA.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão UKG:

      • Autenticação básica
      • OAUTH 2.0: código de autorização

        • Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

      • Clique em PRÓXIMA.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Autenticação básica
    • Nome de usuário: o nome de usuário usado para autenticar o conector.
    • Senha: a senha do Secret Manager que contém a senha associada ao conector.
    • OAUTH 2.0: código de autorização
    • ID do cliente: o ID do cliente usado para solicitar tokens de acesso.
    • Escopos: uma lista separada por vírgulas dos escopos desejados.
    • Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.
    • Ativar PKCE: selecione essa opção se você quiser ativar a troca de chave de prova de código (PKCE, na sigla em inglês).
    • URL de autorização: é o URL de autorização do app. Você será redirecionado para esta página para fazer login no app.
    • URL do token de acesso: o URL a ser usado para trocar o token de acesso. Forneça o URL completo, incluindo o esquema.

Exemplos de configuração de conexão

Esta seção lista os valores de exemplo para os vários campos que você configura ao criar a conexão.

OAUTH 2.0: tipo de conexão de código de autorização

Nome do campo Detalhes
Local us-central1
Conector UKG
Versão do conector 1
Nome da conexão gcp-ukg-oauth-conn
Ativar Cloud Logging Sim
Nível do registro Erro
Conta de serviço SERVICEACCOUNT_NAME@developer.gserviceaccount.com
Módulo de especificação da API aberta Controle de tempo
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Tipo de destino Endereço do host
Endereço do host https://google-connect-dev.cfn.mykronos.com
ID do cliente ZG******-****-****-****-*********uDN
Chave secreta do cliente Secret
Versão do secret 1
URL de autorização https://google-connect-dev.cfn.mykronos.com/oauth2/authorize
Acessar URL do token https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token

Limitações do sistema

O conector UKG pode processar 30 transações por segundo, por nó, e limita todas as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

corretivas

Esse conector permite realizar várias ações nos dados de UKG.

Esta seção lista as ações compatíveis com o conector do UKG. Para saber como configurar ações, consulte os Exemplos de ação.

Ação RetrieveAllEmployeeGroupsOrByName

Recupera todos os grupos de funcionários por nome.

Parâmetros de entrada da ação RetrieveAllEmployeeGroupsOrByName

Nome do parâmetro Tipo de dados Obrigatório Descrição
all_details booleano Verdadeiro Um booleano que indica se a resposta é leve, que é uma resposta contendo apenas os campos ID e nome.
name string Verdadeiro O nome de um grupo de funcionários.

Por exemplo, sobre como configurar a ação RetrieveAllEmployeeGroupsOrByName, consulte Exemplos.

Criar ação do PayCode

Cria um código de pagamento.

Parâmetros de entrada da ação Create PayCode

Nome do parâmetro Tipo de dados Obrigatório Descrição
tipo string Verdadeiro O tipo de código de pagamento.
name string Verdadeiro O nome do código de pagamento.
unit string Verdadeiro A unidade do código de pagamento.
codeNumber integer Verdadeiro O número de código atribuído a um código de pagamento.

Por exemplo, sobre como configurar a ação CreatePayCode, consulte Exemplos.

Ação DeletePayCodebyId

Exclui um código de pagamento com base no ID.

Parâmetros de entrada da ação DeletePayCodebyId

Nome do parâmetro Tipo de dados Obrigatório Descrição
id integer Verdadeiro O ID de um código de pagamento.

Por exemplo, sobre como configurar a ação DeletePayCodebyId, consulte Exemplos.

Ação "Atualizar regra de trabalho por ID"

Atualiza a regra de trabalho usando o ID.

Parâmetros de entrada da ação "Atualizar regra de trabalho por ID"

Nome do parâmetro Tipo de dados Obrigatório Descrição
workRuleId integer Verdadeiro ID da regra de trabalho
workRuleVersion json Verdadeiro A versão da regra de trabalho associada a uma regra de trabalho.
name string Verdadeiro O nome de uma regra de trabalho.
version integer Verdadeiro Versão da regra de trabalho.

Por exemplo, sobre como configurar a ação Update Work Rule by ID, consulte Exemplos.

Exemplos de ação

Exemplo: RetrieveAllEmployeeGroupsOrByName

Este exemplo recupera grupos de funcionários.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação RetrieveAllEmployeeGroupsOrByName e clique em Concluído.
  3. Na seção Mapeamento de dados, Open Data Mapping Editor e insira um valor semelhante ao seguinte no 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\":\"}]

Exemplo: criar PayCode

Este exemplo cria um código de pagamento.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Create PayCode e clique em Concluído.
  3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo 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 a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreatePayCode terá um valor semelhante a este:

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

Exemplo: DeletePayCodebyId

Este exemplo exclui um código de pagamento com base no ID.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação DeletePayCodebyId e clique em Concluído.
  3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Campo Input: 
      {
  "Path parameters": {
    "id": 6002.0
  }
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeletePayCodebyId terá um valor semelhante a este:

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

Exemplo: atualizar regra de trabalho por ID

Este exemplo atualiza a regra de trabalho.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Update Work Rule by ID e clique em Concluído.
  3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo 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. Se a ação for bem-sucedida, o Update Work Rule by ID resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: excluir regra fixa por ID

Este exemplo exclui uma regra fixa específica.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Delete Fixed Rule by ID e clique em Concluído.
  3. Na seção Mapeamento de dados, Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input: 
     {
  "Path parameters": {
    "id": 1152.0
  }
}

    4. Se a ação for bem-sucedida, o Delete Fixed Rule by ID resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: recuperar códigos de acumulação

Este exemplo recupera códigos auditivos.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Retrieve Accrual Codes e clique em Concluído.
  3. Na seção Mapeamento de dados, Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input: 
     {
  "Query parameters": {
    "id": 1303.0
  }
}

    4. Se a ação for bem-sucedida, o Retrieve Accrual Codes resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: criar horário de funcionamento

Este exemplo cria horários de funcionamento.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Create Hours of Operation e clique em Concluído.
  3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo 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. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Create Hours of Operation terá um valor semelhante a este:

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

Exemplo: atualizar configuração do cartão de tempo por ID

Este exemplo atualiza a configuração específica do card de horário.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Update Timecard Setting by ID e clique em Concluído.
  3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo 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 a ação for bem-sucedida, o Update Timecard Setting by ID resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: recuperar perfis de informações de pessoas

Este exemplo recupera perfis de informações de pessoas.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Retrieve People Information Profiles e clique em Concluído.
  3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Campo Input: 
      {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "where": {
      "ids": [-1.0, 651.0]
    }
  }
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Retrieve People Information Profiles terá um valor semelhante a este:

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

Exemplo: recuperar todos os termos de emprego

Este exemplo recupera todos os termos de emprego.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Retrieve All Employment Terms e clique em Concluído.
  3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Campo Input: 
       {
  "Query parameters": {
    "id": 2202.0
  }
}

    4. Se a ação for bem-sucedida, o Retrieve All Employment Terms resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: criar perfis de atestado

Este exemplo cria os perfis de atestado.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Create Attestation Profiles e clique em Concluído.
  3. Na seção Mapeamento de dados, Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input: 
     {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "versionCount": 0.0,
    "name": "Empty Profile 3",
    "deleted": false,
    "attestationAssignments": []
  }
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Create Attestation Profiles terá um valor semelhante a este:

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

Exemplo: recuperar o perfil de saída por ID

Este exemplo recupera um perfil de saída com base no ID.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Retrieve Leave Profile by Id e clique em Concluído.
  3. Na seção Mapeamento de dados, Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input: 
     {
  "Path parameters": {
    "id": 3.0
  }
}

    4. Se a ação for bem-sucedida, o Retrieve Leave Profile by Id resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: recuperar regras disponíveis

Este exemplo recupera as regras disponíveis.

  1. Na caixa de diálogo Configure connector task, clique em actions.
  2. Selecione a ação Retrieve Available Rules e clique em Concluído.
  3. Na seção Mapeamento de dados, Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input: 
     {
  "Query parameters": {
    "leave_case_id": 189.0
  }
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Retrieve Available Rules terá um valor semelhante a este:

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

Usar o Terraform para criar conexões

É possível usar o Terraform recurso para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte exemplo de modelo.

Ao criar essa conexão usando o Terraform, defina as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
proxy_enabled BOOLEAN Falso Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticar no proxy ProxyServer.

Usar a conexão do UKG em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
  • Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir