Dia de trabalho

O conetor do Workday permite-lhe estabelecer ligação a uma instância do Workday e aceder aos dados do Workday como uma base de dados tradicional.

Antes de começar

Antes de usar o conector do Workday, 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 IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
  • 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 Criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (Secret Manager API)
    • 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.

Configuração do Workday

Configure uma conta do Workday

Inicie sessão no Workday Login para criar uma conta do Workday. Para informações sobre a comunidade Workday, consulte o artigo Comunidade Workday. Para obter informações sobre as APIs REST, consulte o artigo APIs REST.

Configure um ID de cliente e um segredo do cliente para a autenticação OAuth 2.0

Para criar e registar um cliente da API no Workday, faça o seguinte:

1. Clique em Registar cliente da API no Workday.
2. Introduza o nome do cliente.
3. Selecione o tipo de concessão de cliente como concessão de código de autorização.
4. Selecione o tipo de token de acesso de portador, adicione outros âmbitos conforme necessário e clique em OK.
5. Introduza todos os detalhes e âmbitos necessários para registar o cliente API.
6. Para definir o tipo de autenticação SOAP, adicione o nome de utilizador e a palavra-passe.

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:

1. 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

2. Clique em + Criar novo para abrir a página Criar associação.
3. Na secção Localização, escolha a localização para a ligaçã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. Clicar em Seguinte.
4. Na secção Detalhes da associação, conclua o seguinte:
   1. Conetor: selecione Workday na lista pendente de conetores 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 ligação, introduza um nome para a instância de ligaçã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 do registo está definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
   7. 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.

   Nota: só pode personalizar os valores dos nós de associação se for cliente de pagamento conforme o uso.
   8. Inquilino: o inquilino da conta. Por exemplo, abc_cms1. Pode obter o nome do inquilino nos detalhes de configuração da sua instância do Workday.
   9. Serviço: o serviço ou os serviços específicos dos quais pretende obter dados. Introduzir como lista separada por vírgulas. Por exemplo, absenceManagement,common,compensation,recruiting,payroll,person
   10. Versão do WSDL: a versão do WSDL a usar.
   11. URL Web base: opcionalmente, introduza o URL Web base da aplicação Web Workday. Por exemplo, https://impl.workday.com/.
   12. (Opcional) Na secção Definições avançadas, selecione a caixa de verificação Usar proxy para configurar um servidor proxy para a ligação e configurar os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Os seguintes tipos de autenticação são suportados:
     • Básica: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Utilizador do proxy: um nome de utilizador a ser usado para autenticação com o servidor proxy.
   • Palavra-passe do proxy: o segredo do Secret Manager da palavra-passe do utilizador.
   • Tipo de SSL do proxy: o tipo de SSL a usar quando se liga ao servidor proxy. Os seguintes tipos de autenticação são suportados:
     • Automático: predefinição. Se o URL for um URL HTTPS, é usada a opção Túnel. Se o URL for um URL HTTP, é usada a opção NUNCA.
     • Sempre: a ligação está sempre ativada com SSL.
     • Nunca: a ligação não tem o SSL ativado.
     • Túnel: a ligação é feita através de um proxy de túnel. O servidor proxy abre uma ligação ao anfitrião remoto e o tráfego flui em ambas as direções através do proxy.
   • Na secção Servidor proxy, introduza os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do anfitrião: especifique o nome do anfitrião ou o endereço IP do destino.

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

          • Crie uma associação de serviço do PSC.
          • Crie uma associação de ponto final e, em seguida, introduza os detalhes da associação de ponto final no campo Endereço do anfitrião.
   13. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   14. Clicar em Seguinte.
5. Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
   1. Pode configurar qualquer um dos seguintes tipos de destino:
      • URL do serviço base: clique em + Adicionar destino e, em seguida, introduza o URL do serviço base da sua instância do Workday. Por exemplo, https://wdX-impl-services1.workday.com
      • URL da API: clique em + Adicionar destino e, em seguida, introduza 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, de seguida, introduza o URL do WSDL da sua instância do Workday.

      Pode usar o protocolo REST ou SOAP para comunicar com a sua instância do Workday. Para saber como configurar a ligação para cada um dos protocolos, consulte o artigo Configure a ligação para REST ou SOAP.

   2. Clicar em Seguinte.
6. 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 Workday:

      • Nome de utilizador e palavra-passe
      • OAuth 2.0 – Código de autorização

   Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

   2. Clicar em Seguinte.
7. Rever: reveja os detalhes da ligação e da autenticação.
8. Clique em Criar.

Configure a ligação para REST ou SOAP

Configuração para REST

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

Na secção Detalhes da ligação:

• Inquilino
• Serviço
• Versão do WSDL

Na secção Destinos:

• URL de base
• URL da API

Na secção Autenticação:

• ID do cliente
• Segredo do cliente

Configuração para SOAP

Para que a ligação use o protocolo SOAP, tem de usar o tipo de autenticação Nome de utilizador e palavra-passe e configurar os seguintes campos:

Na secção Detalhes da ligação:

• Inquilino
• Serviço
• Versão do WSDL

Na secção Destinos:

• URL de base

Na secção Autenticação:

• Nome de utilizador
• Palavra-passe

Configure a autenticação

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

• Nome de utilizador e palavra-passe
  • Nome de utilizador: nome de utilizador do 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: ID de cliente conforme fornecido pela sua aplicação externa.
• Âmbitos: âmbitos de autorização.
• Segredo do cliente: selecione o segredo do Secret Manager. Deve ter criado o segredo do Secret Manager antes de configurar esta autorização.
• Versão do Secret: versão do Secret do Secret Manager para o segredo do cliente.
• URL de autorização: introduza o URL de autorização que foi gerado quando criou a instância do Workday.
• Tipo de ligação: selecione um tipo de ligação.

Para o tipo de autenticação OAuth 2.0 - Authorization code, depois de criar a associação, deve efetuar alguns passos adicionais para configurar a autenticação. Para mais informações, consulte Passos adicionais após a criação da associação.

Nota: se estiver a usar o tipo de autenticação OAuth 2.0 - Authorization code e tiver feito alterações de configuração na sua aplicação Workday, tem de voltar a autorizar a ligação ao Workday. Para saber como autorizar novamente, consulte o artigo Autorização novamente para o código de autorização.

Passos adicionais após a criação da associação

Se selecionou OAuth 2.0 - Authorization code para a autenticação, tem de realizar os seguintes passos adicionais após criar a associação:

1. Na página Ligações, encontre a ligação criada recentemente.

   Tenha em atenção que o Estado do novo conetor é Autorização necessária.

2. Clique em Autorização obrigatória.

   É apresentado o painel Editar autorização.

3. Copie o valor do URI de redirecionamento para a sua aplicação externa.
4. Valide os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Nova autorização para o código de autorização

Se estiver a usar o tipo de autenticação Authorization code e tiver feito alterações de configuração na sua aplicação Workday, tem de voltar a autorizar a ligação ao Workday. Para autorizar novamente uma associação, siga estes passos:

1. Clique na associação necessária na página Associações.

   É apresentada a página de detalhes da associação.

2. Clique em Editar para editar os detalhes da associação.
3. Valide os detalhes de OAuth 2.0 – Código de autorização na secção Autenticação.

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

4. Clique em Guardar. Esta ação direciona para a página de detalhes da associação.
5. Clique em Editar autorização na secção Autenticação. É apresentado o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Exemplos de configuração de ligação

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

Tipo de ligação de palavra-passe do nome de utilizador

Nome do campo	Detalhes
Localização	us-central1
Conetor	Dia de trabalho
Versão do conetor	1
Nome da ligação	google-cloud-workday-soap-conn
Ative o Cloud Logging	Não
Conta de serviço	[e-mail]
Inquilino	TENANT_NAME
Serviço	SERVICE_NAME
Versão do WSDL	v41.0
Nível de verbosidade	5
Número mínimo de nós	2
Número máximo de nós	50
URL de base	BASE_URL
Autenticação	USER_PASSWORD
Nome de utilizador	NOME DE UTILIZADOR
Palavra-passe	PASSWORD
Versão do secret	1

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

Nome do campo	Detalhes
Localização	us-central1
Conetor	Dia de trabalho
Versão do conetor	1
Nome da ligação	google-cloud-workday-rest-conn
Ative o Cloud Logging	Não
Conta de serviço	[e-mail]
Inquilino	TENANT_NAME
Nível de verbosidade	5
Número mínimo de nós	2
Número máximo de nós	50
URL de base	BASE_URL
APIURL	API_URL
Autenticação	OAuth 2.0 – Código de autenticação
ID do cliente	CLIENT_ID
Âmbitos	sistema
Segredo do cliente	CLIENT_SECRET
Versão do secret	1
URL de autorização	AUTHORIZATION_URL
Tipo de ligação	REST

Para obter informações sobre a configuração do OAuth 2.0 para um cliente da API REST, consulte a documentação do Workday.

Tipo de ligação do utilizador do sistema de integração

Nome do campo	Detalhes
Localização	europe-west1
Conetor	Dia de trabalho
Versão do conetor	1
Nome da ligação	CONNECTION_NAME
Ative o Cloud Logging	Não
Conta de serviço	[e-mail]
Inquilino	TENANT_NAME
Serviço	SERVICE_NAME
Número mínimo de nós	2
Número máximo de nós	50
URL de base	BASE_URL
Autenticação	Utilizador do sistema de integração
ID do cliente	CLIENT_ID
Segredo do cliente	CLIENT_SECRET
Versão do secret	8
Símbolo de atualização	REFRESH_TOKEN
Versão do secret	7

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

Nota: pode ver as entidades, as operações e as ações de um conector na tarefa Conectores.

• Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

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

• Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:
  • Lista
  • Obter
  • Criar
  • Atualizar
  • Eliminar

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

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

Nota: todas as entidades e ações têm um esquema associado. Por exemplo, um esquema de ação tem os detalhes dos parâmetros, como os nomes dos parâmetros e o respetivo tipo de dados. O esquema (metadados) para entidades e ações é obtido pela ligação em tempo de execução a partir do seu back-end. Se existirem atualizações ao esquema, estas não são refletidas automaticamente nas suas associações existentes. Tem de atualizar o esquema manualmente. Para atualizar o esquema de uma associação, abra a página Detalhes da associação da associação e, de seguida, clique em Atualizar esquema da associação.

Limitações do sistema

O conector do Workday pode processar 3 transações por segundo, por nó, e limita quaisquer transações além deste 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 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.

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

Depois de criar a ligaçã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.

Exemplos de operações de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

Quando usa uma associação do Workday, o nome da entidade é apresentado no seguinte formato: "SCHEMA_NAME.ENTITY_NAME". Por exemplo, em "Staffing.Workers_training", Staffing é o nome do esquema e Workers_training é o nome da tabela.

Apenas as operações de listagem e obtenção são suportadas para uma vista, enquanto todas as operações CRUD são suportadas para uma tabela, conforme definido pela API Entity.

Exemplo: listar todos os registos

Este exemplo apresenta todos os registos 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, de seguida, clique em Concluído.
4. Opcionalmente, na secção Entrada de tarefas da tarefa Conectores, pode 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 pode especificar várias condições de filtro através dos operadores lógicos. Por exemplo, Id='13b1724a91ce448bad2f1986321fc70f' and Inactive=false.

Exemplo: obter um registo

Este exemplo obtém um registo 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, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em EntityId e, de seguida, introduza 1|CN=admin,CN=Users,DC=test-ldap,DC=com no campo Valor predefinido.

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

Exemplo: crie um registo

Este exemplo cria um registo 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, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 tem um valor semelhante ao seguinte:

   {
   "Id": "c3c68bc9a13f901d43ca8e5ddcaa0000"
   }

Exemplo: atualize um registo

Este exemplo atualiza o registo 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, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

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

5. Clique em entityId e, de seguida, introduza f368471438b14705a1178c6744d75853 no campo Valor predefinido.

Exemplo: elimine um registo

Este exemplo elimina o registo 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, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em entityId e, de seguida, introduza e002de05784910123c443f7eb0970722 no campo Valor predefinido.

Nota: se a sua entidade tiver uma chave principal composta, pode especificar uma cláusula de filtro. Por exemplo, Id='e002de05784910123c443f7eb0970722' and Inactive=false.

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 ligações, consulte o modelo de exemplo.

Quando criar 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
inquilino	STRING	Falso	O inquilino da conta.
serviço	STRING	Falso	O serviço ou os serviços específicos a partir dos quais pretende obter dados. Introduza como uma lista separada por vírgulas.
wsdlversion	STRING	Falso	A versão do WSDL a usar.
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 autenticar 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.
proxy_ssltype	ENUM	Falso	O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL

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 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 conetor.