UKG

O conetor do UKG permite-lhe realizar várias ações nos dados do UKG.

Antes de começar

Antes de usar o conector UKG, conclua as seguintes tarefas:

No seu projeto do Google Cloud:
- Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
- Conceda a função de IAM roles/connectors.admin ao utilizador que está a configurar o conector.
- Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte o artigo Criar uma conta de serviço.
- Ative os seguintes serviços:
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Para saber como ativar serviços, consulte o artigo Ativar serviços.
Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.
Aceda à página Ligações
Clique em + CRIAR NOVO para abrir a página Criar associação.
Na secção Localização, escolha a localização para a associação.
1. Região: selecione uma localização na lista pendente.
  Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.
2. Clique em SEGUINTE.
Na secção Detalhes da associação, conclua o seguinte:
1. Conector: selecione UKG na lista pendente de conectores disponíveis.
2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
3. No campo Nome da associação, introduza um nome para a instância da associação.
  Os nomes das associações têm de cumprir os seguintes critérios:
  - Os nomes das associações podem usar letras, números ou hífenes.
  - As letras têm de ser minúsculas.
  - Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das associações não podem exceder 49 carateres.
4. Opcionalmente, introduza uma Descrição para a instância de associação.
5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível de registo está definido como Error.
6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
7. Serviço/módulo: selecione o módulo UKG.
8. Opcionalmente, configure as definições do nó de associação:
  - Número mínimo de nós: introduza o número mínimo de nós de ligação.
  - Número máximo de nós: introduza o número máximo de nós de ligação.
  Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.
9. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
10. Clique em SEGUINTE.
Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
1. Tipo de destino: selecione um Tipo de destino.
  - Para especificar o nome de anfitrião ou o endereço IP de destino, selecione Endereço do anfitrião e introduza o endereço no campo Anfitrião 1.
  - Para estabelecer uma ligação privada, selecione Endereço do anfitrião e adicione a associação do ponto final criada para o gateway SAP através do protocolo HTTPS.
  Se quiser estabelecer uma ligação pública aos seus sistemas de back-end com segurança adicional, pode considerar configurar endereços IP estáticos de saída para as suas ligações e, em seguida, configurar as regras da firewall para permitir apenas os endereços IP estáticos específicos.
  
  Para introduzir destinos adicionais, clique em +ADICIONAR DESTINO.
2. Clique em SEGUINTE.
Na secção Autenticação, introduza os detalhes de autenticação.
1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.
  Os seguintes tipos de autenticação são suportados pela ligação do UKG:
  - Autenticação básica
  - OAUTH 2.0 – Código de autorização
  - Clique em SEGUINTE.
Rever: reveja os detalhes da ligação e da autenticação.
Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

Autenticação básica
- Nome de utilizador: o nome de utilizador usado para autenticar o conetor.
- Palavra-passe: Secret do Secret Manager que contém a palavra-passe associada ao conector.

OAUTH 2.0 – Código de autorização

ID de cliente: o ID de cliente usado para pedir tokens de acesso.
Âmbitos:uma lista separada por vírgulas dos âmbitos pretendidos.
Segredo do cliente: segredo do Secret Manager que contém o segredo do cliente da app associada que criou.
Ativar PKCE: selecione esta opção se quiser ativar a chave de prova de troca de código (PKCE).
URL de autorização: URL de autorização da sua app. É feito o redirecionamento para esta página para iniciar sessão na sua app.
URL do token de acesso: o URL a usar para trocar o token de acesso. Indique o URL completo, incluindo o esquema.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo dos vários campos que configura quando cria a associação.

OAUTH 2.0 – Tipo de ligação com código de autorização

Nome do campo	Detalhes
Localização	us-central1
Conetor	UKG
Versão do conetor	1
Nome da ligação	gcp-ukg-oauth-conn
Ative o Cloud Logging	Sim
Nível de registo	Erro
Conta de serviço	SERVICEACCOUNT_NAME@developer.gserviceaccount.com
Módulo de especificação de API aberta	Registo de horas
Nível de verbosidade	5
Número mínimo de nós	2
Número máximo de nós	50
Tipo de destino	Morada do anfitrião
Endereço do anfitrião	https://google-connect-dev.cfn.mykronos.com
ID do cliente	ZG****----*******uDN
Segredo do cliente	Secreto
Versão do secret	1
URL de autorização	https://google-connect-dev.cfn.mykronos.com/oauth2/authorize
URL do token de acesso	https://google-connect-dev.cfn.mykronos.com/api/authentication/access_token

Nota: pode transmitir o seguinte URL como o nome do anfitrião, que é o endereço do anfitrião predefinido: https://login.UKG.com. Tem de usar um endereço de anfitrião diferente se a sua organização usar um ponto final de início de sessão personalizado.

Limitações do sistema

O conector UKG pode processar 30 transações por segundo, por nó, e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

Se for um cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

acções

Este conetor permite-lhe realizar várias ações nos dados do UKG.

Esta secção apresenta as ações suportadas pelo conetor UKG. Para compreender como configurar as ações, consulte Exemplos de ações.

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ória	Descrição
all_details	booleano	Verdadeiro	Um Booleano que indica se a resposta é simples, ou seja, uma resposta que contém apenas campos de ID e nome.
nome	de string	Verdadeiro	O nome de um grupo de funcionários.

Para ver um exemplo de como configurar a ação RetrieveAllEmployeeGroupsOrByName, consulte Exemplos.

Crie uma ação PayCode

Cria um código de pagamento.

Introduza os parâmetros da ação Create PayCode

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

Para ver um exemplo de como configurar a ação CreatePayCode, consulte Exemplos.

Ação DeletePayCodebyId

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

Introduza os parâmetros da ação DeletePayCodebyId

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
id	número inteiro	Verdadeiro	O ID de um código de pagamento.

Para ver um exemplo de como configurar a ação DeletePayCodebyId, consulte Exemplos.

Ação de atualização da regra de trabalho por ID

Atualiza a regra de funcionamento com o ID.

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

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
workRuleId	número inteiro	Verdadeiro	ID da regra de trabalho
workRuleVersion	json	Verdadeiro	A versão da regra de trabalho associada a uma regra de trabalho.
nome	de string	Verdadeiro	O nome de uma regra de trabalho.
versão	número inteiro	Verdadeiro	Versão da regra de trabalho.

Por exemplo, para saber como configurar a ação Update Work Rule by ID, consulte os exemplos.

Exemplos de ações

Exemplo: RetrieveAllEmployeeGroupsOrByName

Este exemplo obtém grupos de funcionários.

Na caixa de diálogo Configure connector task, clique em actions.
Selecione a ação RetrieveAllEmployeeGroupsOrByName e, de seguida, clique em Concluído.

Na secção Mapeamento de dados Open Data Mapping Editor e, de seguida, introduza 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: crie um PayCode

Este exemplo cria um código de pagamento.

Na caixa de diálogo Configure connector task, clique em actions.
Selecione a ação Create PayCode e, de seguida, clique em Concluído.

Na secção Mapeamento de dados Open Data Mapping Editor e, em seguida, introduza um valor semelhante ao seguinte no 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"
    }
  }

Se a ação for bem-sucedida, o parâmetro de resposta da CreatePayCode tarefaconnectorOutputPayload terá um valor semelhante ao seguinte:

 
  [{
    "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 elimina um código de pagamento com base no ID.

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

Se a ação for bem-sucedida, o parâmetro de resposta da DeletePayCodebyId tarefaconnectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: atualizar regra de trabalho por ID

Este exemplo atualiza a regra de trabalho.

Na caixa de diálogo Configure connector task, clique em actions.
Selecione a ação Update Work Rule by ID e, de seguida, clique em Concluído.

Na secção Mapeamento de dados Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no 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"
  }
}

Se a ação for bem-sucedida, o parâmetro de resposta da Update Work Rule by ID tarefaconnectorOutputPayload 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: elimine uma regra fixa por ID

Este exemplo elimina uma regra fixa específica.

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

Se a ação for bem-sucedida, o parâmetro de resposta da Delete Fixed Rule by IDtarefaconnectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: obtenha códigos de acumulação

Este exemplo obtém códigos de acumulação.

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

Se a ação for bem-sucedida, o parâmetro de resposta da Retrieve Accrual Codes tarefaconnectorOutputPayload 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 um horário de funcionamento.

Na caixa de diálogo Configure connector task, clique em actions.
Selecione a ação Create Hours of Operation e, de seguida, clique em Concluído.

Na secção Mapeamento de dados Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no 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"
        }
      }]
    }]
  }
}

Se a ação for bem-sucedida, o parâmetro de resposta da Create Hours of Operation tarefaconnectorOutputPayload terá um valor semelhante ao seguinte:

 
[{
  "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: atualize a definição do cartão de ponto por ID

Este exemplo atualiza a definição específica do cartão de horas.

Na caixa de diálogo Configure connector task, clique em actions.
Selecione a ação Update Timecard Setting by ID e, de seguida, clique em Concluído.

Na secção Mapeamento de dados Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no 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}

Se a ação for bem-sucedida, o parâmetro de resposta da Update Timecard Setting by ID tarefaconnectorOutputPayload 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: obtenha perfis de informações de pessoas

Este exemplo obtém perfis de informações de pessoas.

Na caixa de diálogo Configure connector task, clique em actions.
Selecione a ação Retrieve People Information Profiles e, de seguida, clique em Concluído.

Na secção Mapeamento de dados Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input:

  {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "where": {
      "ids": [-1.0, 651.0]
    }
  }
}

Se a ação for bem-sucedida, o parâmetro de resposta da Retrieve People Information Profiles tarefaconnectorOutputPayload terá um valor semelhante ao seguinte:

 
   [{
  "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: obtenha todos os termos de emprego

Este exemplo obtém todos os termos de emprego.

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

Se a ação for bem-sucedida, o parâmetro de resposta da Retrieve All Employment Terms tarefaconnectorOutputPayload 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: crie perfis de atestação

Este exemplo cria os perfis de atestação.

Na caixa de diálogo Configure connector task, clique em actions.
Selecione a ação Create Attestation Profiles e, de seguida, clique em Concluído.

Na secção Mapeamento de dados Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input:

 {
  "Headers": {
    "Content-Type": "application/json"
  },
  "RequestBody": {
    "versionCount": 0.0,
    "name": "Empty Profile 3",
    "deleted": false,
    "attestationAssignments": []
  }
}

Se a ação for bem-sucedida, o parâmetro de resposta da Create Attestation Profiles tarefaconnectorOutputPayload terá um valor semelhante ao seguinte:

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

Exemplo: obtenha o perfil de ausência por ID

Este exemplo obtém um perfil de ausência com base no ID.

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

Se a ação for bem-sucedida, o parâmetro de resposta da Retrieve Leave Profile by Id tarefaconnectorOutputPayload 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: obtenha regras disponíveis

Este exemplo obtém as regras disponíveis.

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

Se a ação for bem-sucedida, o parâmetro de resposta da Retrieve Available Rules tarefaconnectorOutputPayload terá um valor semelhante ao seguinte:

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

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

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

Para ver um modelo do Terraform de exemplo para a criação de associações, consulte o modelo de exemplo.

Quando cria esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
proxy_enabled	BOOLEAN	Falso	Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a usar para a autenticação no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma palavra-passe a usar para autenticar no proxy ProxyServer.

Use a ligação do UKG numa integração

Depois de criar a associação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Google Cloud.

O que se segue?

Compreenda como suspender e retomar uma associação.
Compreenda como monitorizar a utilização do conector.
Compreenda como ver os registos do conector.