SuccessFactors do SAP
Com o conector SAP SuccessFactors, é possível executar operações de inserção, exclusão, atualização e leitura nos dados do SAP SuccessFactors.
Antes de começar
Antes de usar o conector SAP SuccessFactors, realize as seguintes tarefas:
- No seu projeto do Google Cloud, faça o seguinte:
- Conceder o papel do IAM roles/connectors.admin ao usuário e configurar o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.
- Ative os seguintes serviços:
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Para entender como ativar os serviços, consulte Como ativar serviços.
Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.
Configurar o conector
Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:
- No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
- Clique em + Criar novo para abrir a página Criar conexão.
- Na seção Local, escolha o local da conexão.
- Região: selecione um local na lista suspensa.
Para conferir a lista de todas as regiões com suporte, consulte Locais.
- Clique em Next.
- Região: selecione um local na lista suspensa.
- Na seção Detalhes da conexão, faça o seguinte:
- Conector: selecione SAP SuccessFactors na lista suspensa de conectores disponíveis.
- Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
- 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.
- Como opção, insira uma Descrição para a instância de conexão.
- Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
- 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.
- ID da empresa: o identificador exclusivo da sua empresa. Isso é necessário para a autenticação.
- Formato de dados: o formato de dados onde os dados serão recuperados. Selecione ATOM ou JSON.
- Incluir propriedades de navegação: um booleano que indica se as propriedades de navegação precisam ser incluídas na lista de colunas.
- Tipo de limpeza: PurgeType é um parâmetro opcional que determina se uma atualização incremental ou completa será realizada em uma entidade.
- Usar paginação do lado do cliente: se o provedor CData ADO.NET para SAP SuccessFactors precisa ou não usar a paginação do lado do cliente.
- Usar nomes de exibição: booleano que determina se os rótulos SAP serão usados ou não.
- Usar proxy: indica se é necessário usar as configurações de proxy do sistema ou não. Esta opção tem precedência sobre outras configurações de proxy, portanto, você precisará definir ProxyAutoDetect como FALSE para usar configurações de proxy personalizadas.
- Esquema de autenticação do proxy: o tipo de autenticação a ser usado para autenticar o proxy do ProxyServer.
- Usuário do proxy: um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
- Senha do proxy: uma senha a ser usada para autenticação no proxy ProxyServer.
- Tipo de SSL de proxy: o tipo de SSL a ser usado na conexão com o proxy ProxyServer.
- 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.
- Clique em + Adicionar destino.
- 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.
- Endereço do host: especifique o nome do host ou o endereço IP do destino.
- Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
- Clique em Next.
- Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
- Tipo de destino: selecione um Tipo de destino.
- Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
- Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.
Para inserir outros destinos, clique em +Adicionar destino.
- Clique em Next.
- Tipo de destino: selecione um Tipo de destino.
-
Na seção Autenticação, insira os detalhes da autenticação.
- Selecione um Tipo de autenticação e insira os detalhes relevantes.
Os seguintes tipos de autenticação são compatíveis com a conexão SuccessFactors do SAP:
- Nome de usuário e senha
- Clique em Next.
Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.
- Selecione um Tipo de autenticação e insira os detalhes relevantes.
- Revisão: revise os detalhes de conexão e autenticação.
- Clique em Criar.
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.
- Esquema de autenticação: o esquema usado para autenticação.
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.
- 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:
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 oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista
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,
. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista
Actions
estará vazia.
Limitações do sistema
O conector SAP SuccessFactors pode processar 10 transações por segundo, por nó, e limita as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.
Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.
Ações
Nesta seção, listamos todas as ações aceitas pela conexão SuccessFactors.
Ação UpsertEntity
Essa ação permite inserir e atualizar o registro de uma entidade.
Parâmetros de entrada da ação UpsertEntity
Nome do parâmetro | Tipo de dados | Obrigatório | Descrição |
---|---|---|---|
entityType | string | Verdadeiro | Tipo de entidade a ser atualizado/inserido. |
payload | objeto | Verdadeiro | Insira o payload no formato json. |
Parâmetros de saída da ação UpsertEntity
Essa ação retorna o status 200 (OK) com um corpo de resposta indicando todos os resultados de upsert.
Por exemplo, sobre como configurar a ação UpsertEntity
,
consulte Exemplos.
Exemplos de ação
Esta seção descreve como executar algumas das ações neste conector.
Exemplo: atualizar um registro em uma entidade
O exemplo a seguir atualiza um registro na entidade PerPersonal
.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
UpsertEntity
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault 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
o campo connectorOutputPayload
da tarefa do conector terá um valor semelhante
para o seguinte:
[{ "personIdExternal": "109031", "startDate": "1989-12-31 23:00:00.0" }]
Exemplo: atualizar um registro em uma entidade
O exemplo a seguir atualiza um registro na entidade PaymentInformationDetailV3
.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
UpsertEntity
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault 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 terá uma
semelhante a:
[{ "externalCode": 563.0, "PaymentInformationV3_effectiveStartDate": "2015-01-20 23:00:00.0", "PaymentInformationV3_worker": "82096" }]
Exemplo: criar um registro em uma entidade
O exemplo a seguir cria um registro na entidade TodoEntryV2
.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
UpsertEntity
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault 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ão um valor semelhante ao seguinte:
[{ "todoEntryId": 221443.0 }]
Exemplos de entidade
Exemplo: listar registros de uma entidade
Este exemplo lista os registros da entidade FOCompany
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
FOCompany
na listaEntity
. - Selecione a operação
LIST
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, você pode definir o
filterClause de acordo com sua exigência.
Por exemplo, definir a cláusula de filtro como
externalCode='5100' and startDate='1900-01-01 00:00:00'
, lista apenas os registros com externalCode é 5100 e startDate é 1900-01-01 00:00:00.
Exemplo: acessar um registro de uma entidade
Este exemplo busca um registro da entidade User
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
User
na listaEntity
. - Selecione a operação
GET
e clique em Concluído. - Na seção Task Input da tarefa Connectors, clique em EntityId e
e insira
103032
no campo Valor padrão.Aqui,
103032
é a chave primária da entidadeUsers
.
Exemplo: excluir um registro de uma entidade
Este exemplo exclui um registro da entidade FOCompany
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
FOCompany
na listaEntity
. - Selecione a operação
DELETE
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e
e insira
113132
no campo Valor padrão.Como alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, você pode defina o filterClause. Por exemplo,
externalCode='5100' and startDate='1900-01-01 00:00:00'
.
Exemplo: criar um registro em uma entidade
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
FOCompany
na listaEntity
. - Selecione a operação
Create
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault 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ão um valor semelhante ao seguinte:{ "externalCode": "1000", "startDate": "1900-01-01 00:00:00.0" }
Exemplo: criar um registro na entidade TimeZone
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
TimeZone
na listaEntity
. - Selecione a operação
Create
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault 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 terá uma semelhante a:{ "effectiveStartDate": "2023-08-16 00:00:00.0", "externalCode": "10013" }
Exemplo: atualizar um registro em uma entidade
Este exemplo atualiza um registro na entidade FOCompany
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
FOCompany
na listaEntity
. - Selecione a operação
Update
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "description": "BestRun India" }
- Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e
e insira
103032
no campo Valor padrão.Como alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, você pode defina 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 terá um valor semelhante
para o seguinte:
{ "externalCode": "5100", "startDate": "1900-01-01 00:00:00.0" }
Usar o Terraform para criar conexões
É possível usar o Terraform recurso para criar uma nova conexão.Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.
Para conferir um exemplo de modelo do Terraform para 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 |
---|---|---|---|
company_id | STRING | Verdadeiro | Identificador exclusivo da sua empresa. Isso é necessário para a autenticação. |
purge_type | STRING | Falso | PurgeType é um parâmetro opcional que determina se uma atualização incremental ou completa será realizada em uma entidade. |
use_client_side_paging | BOOLEAN | Falso | Se o provedor CData ADO.NET para SAP SuccessFactors precisa ou não usar a paginação do lado do cliente. |
use_display_names | BOOLEAN | Falso | Booleano que determina se os rótulos SAP serão usados. |
nível de detalhes | STRING | Falso | O nível de detalhes da conexão varia de 1 a 5. O nível de detalhes mais alto registrará todos os detalhes da comunicação (solicitação,resposta e certificados SSL). |
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 | SEGREDO | 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 SuccessFactors do SAP em uma integração
Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela 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.