SAP Gateway
O conector do SAP Gateway permite executar operações de inserção, exclusão, atualização e leitura no banco de dados do SAP Gateway.
Versões compatíveis
Esse conector usa a API SAP Gateway para ativar o acesso bidirecional aos serviços SAP que usam o gateway. As seguintes edições do SAP são compatíveis:
- Nuvem S/4 HANA
- S/4 HANA
- ERP do SAP
- qualquer outra edição do SAP compatível com a API SAP Gateway;
Antes de começar
Antes de usar o conector do SAP Gateway, faça o seguinte:
- 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 PRÓXIMA.
- Região: selecione um local na lista suspensa.
- Na seção Detalhes da conexão, faça o seguinte:
- Conector: selecione SAP Gateway 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.
- Para usar a conexão para assinaturas de eventos, selecione Ativar assinatura de eventos. Selecionando
isso exibe as seguintes opções:
- Ativar a assinatura de eventos com entidades e ações: selecione essa opção para usar a conexão para operações de assinatura de eventos e de conector (entidades e ações).
- Ativar somente inscrição de eventos: selecione esta opção para usar a conexão. apenas para inscrição em eventos. Se você selecionar essa opção, clique em Próxima e configurar a inscrição em eventos.
- Namespace: especifique o namespace do serviço do qual você quer recuperar dados. Isso é necessário se o serviço não for especificado no URL.
- Serviço: especifique o serviço com os dados que você quer recuperar. Isso é necessário se o serviço não for especificado no URL.
- CustomUrlParams: especifique os parâmetros de string de consulta personalizados que são incluídos na solicitação HTTP. Os parâmetros precisam ser codificados como uma string de consulta neste formato:
field1=value1&field2=value2
. Os valores da string de consulta precisam ser codificados por URL. - Formato de dados: o formato de dados onde os dados serão recuperados. Selecione XML ou JSON.
- Usar nomes de exibição: booleano que determina se os rótulos SAP serão usados ou não.
- 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.
- Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
- Clique em PRÓXIMA.
- Na seção Destinos, defina o URL do ambiente do Gateway SAP ou como o URL completo do serviço OData. Por exemplo, formato:
${ENVIRONMENT_URL}/sap/opu/odata/${NAMESPACE}/${SERVICE}/
e o URL de exemplo éhttps://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/
. Adicione propriedades adicionais usando a propriedade CustomUrlParams.- 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 PRÓXIMA.
- 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 do SAP Gateway:
- Nome de usuário e senha
- Anônimo
- Clique em PRÓXIMA.
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.
-
Anônimo
Se você quiser usar o login anônimo, selecione Não disponível.
- Chave de API: a chave de API do usuário autenticado no momento.
Configurar assinatura de eventos
Se você tiver ativado a assinatura do evento, insira os seguintes valores na seção Detalhes da assinatura do evento:
- Selecione um dos seguintes tipos de autenticação para o listener de eventos.
- Autenticação do Google. Se você ativar essa opção, siga as etapas em Autenticar usando JSON Web Tokens para configurar a autenticação para o SDK do ABAP. Além disso, verifique se a conta de serviço tem o papel roles/connectors.listener e seu token de acesso é usado para autenticação.
- Autenticação de chave de API. Se você selecionar essa opção, deverá ter criado uma chave de API e a salvou como secret do Secret Manager. Para mais informações, consulte Criar uma chave de API.
- Insira o nome do campo do tipo de evento. Esse campo identifica o tipo de evento
associadas à solicitação de evento recebida.
{ "event_type": "user.created", ... // other request fields ... }
- Selecione Ativar conectividade particular para ter uma conexão segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, será necessário realizar outras etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinaturas de eventos.
- Insira a configuração de mensagens inativas. Se você configurar mensagens inativas, a conexão gravará
os eventos não processados para o tópico do Pub/Sub especificado. Digite os seguintes detalhes:
- ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico de mensagens inativas do Pub/Sub.
- Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
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 de entidade, essas operações sem suporte não serã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 do Gateway SAP pode processar no máximo nove transações por segundo por nó.
Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.
- Os seguintes recursos não são compatíveis:
- Autenticação com base em OAuth2.0
- ETags
- Inserção profunda
- Operações baseadas em arquivos
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 SalesOrderSet
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
SalesOrderSet
na listaEntity
. - Selecione a operação
List
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, você também pode
filtrar o conjunto de resultados especificando uma cláusula de filtro.
Por exemplo,
City='Bangalore'
. Você também pode especificar várias condições de filtro usando os operadores lógicos. Por exemplo,City='Bangalore' and region='asia-south2'
.
Exemplo: acessar um registro
Este exemplo recebe um registro com o ID especificado da entidade SalesOrderSet
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
SalesOrderSet
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
13
no campo Valor padrão.Aqui,
13
é um valor de chave primária na entidadeSalesOrderSet
.
Exemplo: criar um registro
Este exemplo cria um registro na entidade SalesOrderSet
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
SalesOrderSet
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
:{ "Vbeln":"999", "Erdat":"2020-08-25 00:00:00", "Erzet":"13:12:31", "Ernam":"Test" }
Se a integração for bem-sucedida, o campo
connectorOutputPayload
da tarefa do conector terá um valor semelhante a este:{ "Vbeln": "999" }
Exemplo: criar um registro
Este exemplo cria um registro na entidade SalesPriceSet
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
SalesPriceSet
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
:{ "Vbeln": "129", "Posnr": "000000", "Knumh": "SUN25MAY", "Kpein": 1.0 }
Se a integração for bem-sucedida, o campo
connectorOutputPayload
da tarefa do conector terá um valor semelhante a este:{ "Posnr": "000000", "Vbeln": "129" }
Exemplo: atualizar um registro
Este exemplo atualiza um registro na entidade SalesOrderSet
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
SalesOrderSet
na listaEntity
. - Selecione a operação
Update
e clique em Concluído. - Na seção Entrada da tarefa da tarefa Connectors, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campoDefault Value
:{ "Ernam": "Test123" }
- Clique em entityId e insira
99
no campo Valor padrão.Se a integração for bem-sucedida, o campo
connectorOutputPayload
da tarefa do conector terá uma semelhante a:{ "Vbeln": "999" }
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 |
---|---|---|---|
namespace | STRING | Falso | Especifique o namespace do serviço de onde você quer recuperar dados. Isso é necessário se o serviço não for especificado no URL. |
serviço | STRING | Falso | Especifique o serviço do qual você quer recuperar dados. Isso é necessário se o serviço não for especificado no URL. |
custom_url_params | STRING | Falso | O CustomUrlParams permite especificar parâmetros de string de consulta personalizados que estão incluídos na solicitação HTTP. Os parâmetros devem ser codificados como uma string de consulta no formato field1=value1&field2=value2. Os valores da string de consulta precisam ser codificados por URL. |
data_format | ENUM | Falso | O formato de dados no qual os dados serão recuperados. Selecione XML ou JSON. Os valores aceitos são: XML, JSON |
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 | SECRET | Falso | Uma senha a ser usada para autenticar 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 SAP Gateway em uma integração
Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.
- Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
- 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.