SAP SuccessFactors

O conetor do SAP SuccessFactors permite-lhe realizar operações de inserção, eliminação, atualização e leitura nos dados do SAP SuccessFactors.

Antes de começar

Antes de usar o conector do SAP SuccessFactors, 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.

• Para criar uma conta paga do SuccessFactors com o ID da SAP, consulte o artigo Início rápido com o SAP SuccessFactors.

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. Conector: selecione SAP SuccessFactors 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 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. ID da empresa: identificador exclusivo da sua empresa. Isto é necessário para a autenticação.
   9. Formato de dados: o formato de dados no qual pretende obter os dados. Selecione ATOM ou JSON.
   10. Include Navigation Properties: um valor booleano que indica se as propriedades de navegação devem ser incluídas na lista de colunas.
   11. Purge Type: PurgeType é um parâmetro opcional que determina se vai ser feita uma atualização incremental ou completa numa entidade.
   12. Use Client Side Paging: indica se o CData ADO.NET Provider for SAP SuccessFactors deve usar a paginação do lado do cliente.
   13. Usar nomes a apresentar: booleano que determina se devem ou não ser usadas etiquetas SAP.
   14. Usar proxy: indica se deve usar as definições de proxy do sistema ou não. Esta definição tem precedência sobre outras definições de proxy, pelo que tem de definir ProxyAutoDetect como FALSE para usar definições de proxy personalizadas.
   15. Esquema de autenticação de proxy: o tipo de autenticação a usar para autenticar no proxy ProxyServer.
   16. Utilizador do proxy: um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
   17. Palavra-passe do proxy: uma palavra-passe a usar para a autenticação no proxy ProxyServer.
   18. Tipo de SSL do proxy: o tipo de SSL a usar ao ligar ao proxy ProxyServer.
   19. (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.
   20. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   21. 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. 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 Anexo do ponto final e escolha o anexo necessário na lista Anexo do ponto final.
        Nota: para saber como criar uma associação de ponto final, consulte Associação de serviço do PSC e Associação de ponto final. Depois de criar a associação do ponto final, esta fica visível na lista Associação do ponto final.

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

      A ligação do SAP SuccessFactors suporta os seguintes tipos de autenticação:

      • Nome de utilizador e palavra-passe

   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 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.
  • Esquema de autenticação: o esquema usado para autenticação

Exemplo de tipo de ligação de autenticação básica

A tabela seguinte apresenta os valores de configuração de exemplo para o tipo de ligação de autenticação básica. Consulte a interface de criação de associações na consola para saber os campos obrigatórios e opcionais.

Nome do campo	Valor de exemplo
Região	us-central1
Conetor	SAP SuccessFactors
Versão do conetor	1
Nome da ligação	sapsf-basicauth-conn
Descrição	Ligação ao SuccessFactors
Conta de serviço	[e-mail]
ID da empresa	SFPART068178
Endereço do anfitrião	https://HOST_NAME.successfactors.eu/
Nome de utilizador	sfadmin
Palavra-passe	PASSWORD
Esquema de autenticação	Básico

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 SAP SuccessFactors pode processar 10 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 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.

Ações

Esta secção apresenta todas as ações suportadas pela ligação do SuccessFactors.

Ação UpsertEntity

Esta ação permite-lhe inserir ou atualizar um registo para uma entidade.

Parâmetros de entrada da ação UpsertEntity

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
entityType	de string	True	Tipo de entidade a ser carregado.
payload	objeto	True	Payload de inserção/atualização no formato JSON.

Parâmetros de saída da ação UpsertEntity

Esta ação devolve o estado 200 (OK) com um corpo de resposta que indica todos os resultados de inserção/atualização.

Por exemplo, para saber como configurar a ação UpsertEntity, consulte os exemplos.

Exemplos de ações

Esta secção descreve como realizar algumas das ações neste conector.

Exemplo: atualize um registo na entidade PerPersonal

O exemplo seguinte atualiza um registo na entidade PerPersonal.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UpsertEntity e, de seguida, clique em Concluído.
3. 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:

   {
   "entityType": "PerPersonal",
   "payload": {
     "personIdExternal": "109031",
     "startDate": "1800-01-01 00:00:00.0",
     "firstName": "John",
     "lastName": "Job",
     "nationality": "IND"
     }
   }

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

[{
  "personIdExternal": "109031",
  "startDate": "1989-12-31 23:00:00.0"
}]

Exemplo: atualize um registo na entidade PaymentInformationDetailV3

O exemplo seguinte atualiza um registo na entidade PaymentInformationDetailV3.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UpsertEntity e, de seguida, clique em Concluído.
3. 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:

   {
     "entityType": "PaymentInformationDetailV3",
     "payload": {
       "PaymentInformationV3_effectiveStartDate": "2015-01-21 00:00:00.0",
       "PaymentInformationV3_worker": "82096",
       "externalCode": 563.0,
       "currency": "EUR"
     }
   }

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

[{
  "externalCode": 563.0,
  "PaymentInformationV3_effectiveStartDate": "2015-01-20 23:00:00.0",
  "PaymentInformationV3_worker": "82096"
}]

Exemplo: crie um registo numa entidade

O exemplo seguinte cria um registo na entidade TodoEntryV2.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UpsertEntity e, de seguida, clique em Concluído.
3. 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:

   {
     "entityType": "TodoEntryV2",
     "payload": {
       "todoEntryName": "Finish Your Tasks",
       "status": 1.0,
       "categoryId": "41",
       "LinkeduserNav": {
         "__metadata": {
           "uri": "https://apisalesdemo2.successfactors.eu/odata/v2/User('613577712')",
           "type": "SFOData.User"
         }
       }
     }
   }

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

[{
  "todoEntryId": 221443.0
}] 

Exemplos de entidades

Exemplo: listar registos de uma entidade

Este exemplo apresenta os registos da entidade FOCompany.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione FOCompany na lista Entity.
3. Selecione a operação LIST e, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conectores, pode definir o filterClause de acordo com o seu requisito.

   Por exemplo, definir a cláusula de filtro como externalCode='5100' and startDate='1900-01-01 00:00:00', lista apenas os registos cujo externalCode seja 5100 e startDate seja 1900-01-01 00:00:00.

Exemplo: obter um registo de uma entidade

Este exemplo obtém um registo da entidade User.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione User 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 Conectores, clique em EntityId e, de seguida, introduza 103032 no campo Valor predefinido.

   Aqui, 103032 é a chave principal da entidade Users.

Exemplo: elimine um registo de uma entidade

Este exemplo elimina um registo da entidade FOCompany.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione FOCompany na lista Entity.
3. Selecione a operação DELETE e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conectores, clique em entityId e, em seguida, introduza 113132 no campo Valor predefinido.

   Em alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, pode definir o filterClause. Por exemplo, externalCode='5100' and startDate='1900-01-01 00:00:00'.

Exemplo: crie um registo numa entidade

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione FOCompany 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:

   {
   "externalCode": "1000",
   "startDate": "1900-01-01 00:00:00.0",
   "standardHours": 40.0,
   "status": "I",
   "currency": "EUR",
   "country": "DEU"
   }

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

   {
   "externalCode": "1000",
   "startDate": "1900-01-01 00:00:00.0"
   }

Exemplo: crie um registo na entidade TimeZone

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione TimeZone 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:

   {
   "effectiveStartDate": "2023-08-16 00:00:00.0",
   "externalCode": "10013",
   "effectiveStatus": "A",
   "utcDstOffset": "UTC+01:00",
   "utcOffset": "+0100"
   }

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

   {
   "effectiveStartDate": "2023-08-16 00:00:00.0",
   "externalCode": "10013"
   }

Exemplo: atualize um registo numa entidade

Este exemplo atualiza um registo na entidade FOCompany.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione FOCompany 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 Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "description": "BestRun India"
   }

5. Na secção Entrada da tarefa da tarefa Conectores, clique em entityId e, em seguida, introduza 103032 no campo Valor predefinido.

   Em alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, pode definir o filterClause. Por exemplo, externalCode='5100' and startDate='1900-01-01 00:00:00'.

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

{
"externalCode": "5100",
"startDate": "1900-01-01 00:00:00.0"
}

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
company_id	STRING	True	Identificador exclusivo da sua empresa. Isto é necessário para a autenticação.
purge_type	STRING	Falso	PurgeType é um parâmetro opcional que determina se é feita uma atualização incremental ou completa numa entidade.
use_client_side_paging	BOOLEAN	Falso	Se o CData ADO.NET Provider for SAP SuccessFactors deve ou não usar a paginação do lado do cliente.
use_display_names	BOOLEAN	Falso	Booleano que determina se devem ou não ser usadas etiquetas SAP.
verbosidade	STRING	Falso	Nível de verbosidade para a ligação, varia de 1 a 5. Um nível de detalhe mais elevado regista todos os detalhes de comunicação (pedido,resposta e certificados SSL).
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

Use a ligação do SAP SuccessFactors 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.

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.