Workday

Com o conector do Workday, você pode se conectar a uma instância do Workday e acessar os dados dele como um banco de dados tradicional.

Antes de começar

Antes de usar o conector do Workday, faça o seguinte:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando 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 acessar 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 PostgreSQL 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 exceder 63 caracteres.
   4. Como opção, insira uma Descrição para a instância de conexão.
   5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
   6. 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.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   7. Locatário: o locatário da conta. Por exemplo, abc_cms1. É possível encontrar o nome do locatário nos detalhes de configuração da instância do Workday.
   8. Serviço: os serviços específicos de que você quer recuperar dados. Insira como uma lista separada por vírgulas. Por exemplo, absenceManagement,common,compensation,recruiting,payroll,person
   9. Versão do WSDL: é a versão do WSDL a ser usada.
   10. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Básico: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
   • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
   • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
     • Sempre: a conexão será sempre com SSL ativado.
     • Nunca: a conexão não está com SSL ativado.
     • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
   • Na seção Servidor proxy, insira os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do host: especifique o nome do host ou o endereço IP do destino.

          Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

          • Crie um anexo do serviço PSC.
          • Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
   11. Também é possível clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
   12. 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. Você pode configurar qualquer um dos seguintes tipos de destino:
      • URL de base: clique em + Adicionar destino e insira o URL de base da instância do Workday. Por exemplo, https://wd5-impl-service23.workday.com
      • URL da API: clique em + Adicionar destino e insira o URL da API da sua instância do Workday. Por exemplo, https://wd5-impl-service23.workday.com/srx/api/v1/TENANT
      • URL do WSDL: clique em + Adicionar destino e insira o URL WSDL da instância do Workday.

      É possível usar o protocolo REST ou SOAP para se comunicar com sua instância do Workday. Para entender como configurar a conexão para cada um dos protocolos, consulte Configurar conexão para REST ou SOAP.

   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.

      A conexão do Workday é compatível com os tipos de autenticação a seguir:

      • Nome de usuário e senha
      • Código de autorização OAuth 2.0

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

   2. Clique em Próxima.
7. Revisão: revise os detalhes de conexão e autenticação.
8. Clique em Criar.

Configurar conexão para REST ou SOAP

Configuração para REST

Para que a conexão use o protocolo REST, você precisa usar o tipo de autenticação OAuth 2.0 – Código de autorização e configurar os seguintes campos:

Na seção Detalhes da conexão:

• Locatário
• Serviço
• Versão do WSDL

Na seção Destinos:

• URL de base
• URL da API

Na seção Autenticação:

• ID do cliente
• Chave secreta do cliente

Configuração para SOAP

Para que a conexão use o protocolo SOAP, utilize o tipo de autenticação Nome de usuário e senha e configure os seguintes campos:

Na seção Detalhes da conexão:

• Locatário
• Serviço
• Versão do WSDL

Na seção Destinos:

• URL de base

Na seção Autenticação:

• Nome de usuário
• Senha

Configurar a autenticação

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

• Nome de usuário e senha
  • Nome de usuário: nome de usuário para o conector
  • Senha: a senha do Secret Manager que contém a senha associada ao conector.

• Código de autorização OAuth 2.0
• ID do cliente: ID do cliente conforme fornecido pelo aplicativo externo.
• Escopos: escopos de permissão.
• Chave secreta do cliente: selecione a chave Gerenciador de secrets. É necessário criar a chave secreta do Secret Manager antes de configurar esta autorização.
• Versão do secret: a versão do secret do cliente no Secret Manager.
• URL de autorização: insira o URL de autorização que foi gerado quando você criou a instância do Workday.
• Connection Type:selecione um tipo de conexão.

Para o tipo de autenticação OAuth 2.0 - Authorization code, depois de criar a conexão, realize mais algumas etapas para configurá-la. Para mais informações, consulte Outras etapas após a criação da conexão.

Observação:se você estiver usando o tipo de autenticação OAuth 2.0 - Authorization code e tiver feito mudanças de configuração no app Workday, autorize a conexão do Workday novamente. Para entender como fazer isso, consulte Reautorização para o código de autorização.

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas outras etapas depois de criar a conexão:

1. Na página Conexões, localize a conexão recém-criada.

   O Status do novo conector será Autorização necessária.

2. Clique em Autorização necessária.

   O painel Editar autorização será exibido.

3. Copie o valor de Redirect URI no seu aplicativo externo.
4. Verifique os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

Reautorização do código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de configuração no aplicativo Workday, autorize a conexão do Workday novamente. Para autorizar uma conexão novamente, siga estas etapas:

1. Clique na conexão necessária na página Conexões.

   A página de detalhes da conexão será aberta.

2. Clique em Editar para editar os detalhes da conexão.
3. Verifique os detalhes de OAuth 2.0 - Código de autorização na seção Autenticação.

   Se necessário, faça as alterações necessárias.

4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
5. Clique em Editar autorização na seção Autenticação. Isso mostra o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • List
  • Receber
  • Criação
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Observação : todas as entidades e ações terão um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro, como os nomes dos parâmetros e o tipo de dados correspondente. O esquema (metadados) de entidades e ações é buscado pela conexão no tempo de execução do back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. Será necessário atualizar o esquema manualmente. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

Limitações do sistema

O conector do Workday pode processar três transações por segundo, por nó, e limita todas as transações acima 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.

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você for um cliente com pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição de conexão.
• Se você for um cliente com base em assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Exemplos de operações de entidade

Esta seção mostra como executar algumas das operações de entidade neste conector.

Exemplo: listar todos os registros

Este exemplo lista todos os registros na entidade Scorecards.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Scorecards na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples ('). Por exemplo, Id='13b1724a91ce448bad2f1986321fc70f'. Também é possível especificar várias condições de filtro usando os operadores lógicos. Por exemplo, Id='13b1724a91ce448bad2f1986321fc70f' and Inactive=false.

Exemplo: acessar um registro

Este exemplo recebe um registro com o ID especificado da entidade Scorecards.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Scorecards na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em IdEntidade e insira 1|CN=admin,CN=Users,DC=test-ldap,DC=com no campo Valor padrão.

   Aqui, 1|CN=admin,CN=Users,DC=test-ldap,DC=com é um valor de chave primária na entidade Scorecards.

Exemplo: criar um registro

Este exemplo cria um registro na entidade PayrollInputs.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione PayrollInputs na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "Worker_Id": "21327",
   "Worker_Descriptor": "Worker 2"
   }

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

   {
   "Id": "c3c68bc9a13f901d43ca8e5ddcaa0000"
   }

Exemplo: atualizar um registro

Neste exemplo, o registro é atualizado com o ID especificado na entidade Scorecards.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Scorecards na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "ScorecardDescription": "New updated description",
   "ScorecardName": "Scorecard_1"
   }

5. Clique em entityId e insira f368471438b14705a1178c6744d75853 no campo Valor padrão.

Exemplo: excluir um registro

Este exemplo exclui o registro com o ID especificado na entidade Scorecards.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Scorecards na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e digite e002de05784910123c443f7eb0970722 no campo Valor padrão.

Observação : se sua entidade tiver uma chave primária composta, será possível especificar uma cláusula de filtro. Por exemplo, Id='e002de05784910123c443f7eb0970722' and Inactive=false.

Usar o Terraform para criar conexões

É possível usar o recurso do Terraform 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 a criação de conexões, consulte Exemplo de modelo.

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

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
locatário	STRING	Falso	O locatário da conta.
externo	STRING	Falso	Os serviços específicos dos quais os dados serão recuperados. Insira como uma lista separada por vírgulas.
Versão do DSL	STRING	Falso	A versão do WSDL a ser usada.
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 autenticação no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

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

Depois que você cria a conexão, ela fica disponível na Apigee Integration e no Application Integration. É possível usar a conexão em uma integração por meio da tarefa "Conectores".

• Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte a Tarefa "Conectores".
• 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

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.