1. Introdução
Este codelab orienta você a receber detalhes de eventos de um tópico do Pub/Sub do Google Cloud usando o SDK ABAP para Google Cloud. Vamos aproveitar os seguintes serviços do Google Cloud:
- Cloud Pub/Sub
- Cloud Shell
Pré-requisitos
- Verifique se você tem acesso a um sistema SAP com o ABAP SDK for Google Cloud instalado.
- Consulte o codelab Instalar o teste da plataforma ABAP no Google Cloud Platform e instalar o SDK do ABAP para configurar um novo sistema.
- Você criou um tópico
PUBSUB_DEMO_TOPIC
como parte do codelab "Enviar eventos do SAP para o Pub/Sub usando o SDK ABAP" no seu projeto do Google Cloud. Se não tiver sido criado, use o comando abaixo para criar:
gcloud pubsub topics create PUBSUB_DEMO_TOPIC
O que você vai criar
Você vai criar o seguinte:
- Uma conta de serviço com permissões de "Inscrição" para interagir com a API Pub/Sub.
- Um programa ABAP para receber e confirmar mensagens do seu tópico do Pub/Sub.
2. Requisitos
- Navegadores, como o Chrome ou o Firefox.
- Um projeto do Google Cloud com o faturamento ativado ou Crie uma conta de teste sem custo financeiro de 90 dias para o Google Cloud Platform.
- GUI do SAP (Windows ou Java) instalado no sistema. Se o SAP GUI já estiver instalado no seu laptop, conecte-se ao SAP usando o endereço IP externo da VM como o IP do servidor de aplicativos. Se você estiver usando um Mac, também poderá instalar o SAP GUI para Java disponível neste link.
3. Antes de começar
- No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud (por exemplo:
abap-sdk-poc
). - Verifique se o faturamento está ativado para seu projeto do Cloud. Saiba como verificar se o faturamento está ativado em um projeto. Pule esta etapa se você estiver usando a conta de teste sem custo financeiro de 90 dias.
- Você vai usar o Cloud Shell, um ambiente de linha de comando executado no Google Cloud. No console do Cloud, clique em Ativar o Cloud Shell no canto superior direito:
- Execute os comandos a seguir para fazer a autenticação da sua conta e definir o projeto padrão como
abap-sdk-poc
. A zonaus-west4-b
é usada como exemplo. Se necessário, mude o projeto e a zona nos comandos a seguir de acordo com sua preferência.
gcloud auth login
gcloud config set project abap-sdk-poc
gcloud config set compute/zone us-west4-b
- Como parte do codelab anterior "Enviar evento para o Pub/Sub", você já deve ter ativado a API Pub/Sub, criado o tópico e publicado mensagens no Pub/Sub.
4. Criar uma conta de serviço para acesso ao Pub/Sub
Usar uma conta de serviço com o papel Subscriber
é a maneira mais segura de o programa ABAP receber mensagens do Pub/Sub. Essa função limita as permissões apenas à recuperação de mensagens, evitando possíveis vulnerabilidades de segurança.
Criar a conta de serviço
Para criar uma conta de serviço com a função necessária, siga estas etapas:
- Execute o seguinte comando no terminal do Cloud Shell:
gcloud iam service-accounts \
create abap-sdk-pubsub-subscriber \
--display-name="Service Account for Pub/Sub Subscriber"
- Agora adicione os papéis necessários à conta de serviço criada na etapa acima:
gcloud projects add-iam-policy-binding abap-sdk-poc \
--member='serviceAccount:abap-sdk-pubsub-subscriber@abap-sdk-poc.iam.gserviceaccount.com' \
--role='roles/pubsub.subscriber'
O comando acima usa abap-sdk-poc
como marcador de posição para o projeto do Google Cloud. Substitua abap-sdk-poc
pelo ID do projeto.
- Para verificar se o papel foi adicionado, acesse a página IAM. A conta de serviço que você criou vai aparecer com o papel atribuído a ela.
5. Noções básicas sobre as assinaturas de pull
Em uma assinatura de pull, o sistema SAP atua como o cliente do assinante e inicia solicitações para um servidor do Pub/Sub para recuperar mensagens. O cliente assinante usa a API REST Pull.
Principais métodos de API
API Google Cloud Pub/Sub
- pull: inicia uma solicitação para buscar mensagens.
- acknowledge: sinaliza ao Pub/Sub que uma mensagem foi processada.
Equivalentes do SDK do ABAP para Google Cloud
- /GOOG/CL_PUBSUB_V1 -> PULL_SUBSCRIPTIONS
- /GOOG/CL_PUBSUB_V1 -> ACKNOWLEDGE_SUBSCRIPTIONS
Fluxo de mensagens para uma assinatura de pull
A imagem a seguir mostra o fluxo de trabalho entre um cliente de assinante e uma assinatura de pull.
- Solicitação de pull:seu sistema SAP (o assinante) usa o método de pull para solicitar mensagens do servidor do Pub/Sub.
- Resposta de pull: o servidor do Pub/Sub responde com zero ou mais mensagens e IDs de confirmação. Uma resposta com zero mensagens ou com um erro não indica necessariamente que não há mensagens disponíveis para receber. Essa resposta é a PullResponse, conforme mostrado na imagem.
- Confirmação:depois de processar uma mensagem, o sistema SAP usa o método de confirmação com o ID de confirmação recebido. Isso impede que o Pub/Sub reenvie a mensagem.
6. Como configurar sua assinatura e enviar mensagens
Criar uma assinatura de pull
- Execute este comando gcloud para criar uma assinatura de pull chamada
PUBSUB_DEMO_SUBSCRIPTION
que vai receber mensagens doPUBSUB_DEMO_TOPIC
:
gcloud pubsub subscriptions create PUBSUB_DEMO_SUBSCRIPTION \
--topic=PUBSUB_DEMO_TOPIC
Publicar mensagens
Escolha um destes métodos para enviar mensagens para PUBSUB_DEMO_TOPIC
:
- Reutilize seu programa:se você tiver o programa de um codelab anterior para publicação, use esse.
- Publicação direta: para um teste rápido, tente uma das seguintes opções:
- Console do Google Cloud: publique diretamente no Console do Google Cloud. Para mais detalhes, consulte a documentação do Pub/Sub.
- Comando gcloud: execute o seguinte comando:
gcloud pubsub topics publish PUBSUB_DEMO_TOPIC \
--message='{"eventType":"SalesOrderChanged","source":"SAPDEV100","eventTime":"20240207183048","SalesOrder":1000924}'
7. Criar configuração de chave do cliente
Agora que você configurou os pré-requisitos no Google Cloud, podemos prosseguir com a configuração no SAP.
Para a configuração relacionada à autenticação e conectividade, o ABAP SDK for Google Cloud usa as tabelas /GOOG/CLIENT_KEY
e /GOOG/SERVIC_MAP.
.
Para manter a configuração na tabela /GOOG/CLIENT_KEY
, siga estas etapas:
- Na GUI do SAP, insira o código da transação SPRO.
- Clique em IMG de referência SAP.
- Clique em ABAP SDK for Google Cloud > Configurações básicas > Configurar chave do cliente.
- Mantenha os valores a seguir nos campos. Não preencha os outros campos.
Campo | Valor |
Nome da chave do Google Cloud | PUBSUB_SUBSCRIBER |
Nome da conta de serviço do Google Cloud | abap-sdk-pubsub-subscriber@abap-sdk-poc.iam.gserviceaccount.com |
Escopo do Google Cloud | https://www.googleapis.com/auth/cloud-platform |
ID do projeto | abap-sdk-poc |
Classe de autorização | /GOOG/CL_AUTH_GOOGLE |
8. Criar um relatório ABAP para receber mensagens do Google Cloud Pub/Sub
- Faça login no sistema SAP.
- Acesse o código da transação
SE38
e crie um programa de relatório com o nomeZDEMO_RECEIVE_CPS_EVENTS.
. - No pop-up que abrir, forneça os detalhes conforme mostrado abaixo e clique em Salvar.
- No próximo pop-up, selecione Objeto local ou informe um nome de pacote, conforme apropriado.
- No Editor ABAP, adicione o seguinte código:
REPORT zdemo_receive_cps_events. TYPES: BEGIN OF ty_event_message, event_time TYPE timestamp, event_type TYPE char30, source TYPE char30, sales_order TYPE vbeln, END OF ty_event_message. DATA: ls_input TYPE /goog/cl_pubsub_v1=>ty_026, ls_input_ack TYPE /goog/cl_pubsub_v1=>ty_001, ls_event_msg TYPE ty_event_message. TRY. "Open HTTP Connection DATA(lo_client) = NEW /goog/cl_pubsub_v1( iv_key_name = 'PUBSUB_SUBSCRIBER' ). "Populate relevant parameters " Derive project id from the client object DATA(lv_p_projects_id) = CONV string( lo_client->gv_project_id ). " Name of the subscription from where we want to pull data DATA(lv_p_subscriptions_id) = CONV string( 'PUBSUB_DEMO_SUBSCRIPTION' ). " Max number of messages that will be received in 1 API call ls_input-max_messages = 1. "Call API method: pubsub.projects.subscriptions.pull lo_client->pull_subscriptions( EXPORTING iv_p_projects_id = lv_p_projects_id iv_p_subscriptions_id = lv_p_subscriptions_id is_input = ls_input IMPORTING es_output = DATA(ls_output) ev_ret_code = DATA(lv_ret_code) ev_err_text = DATA(lv_err_text) es_err_resp = DATA(ls_err_resp) ). IF lo_client->is_success( lv_ret_code ). DATA(ls_received_msg) = VALUE #( ls_output-received_messages[ 1 ] OPTIONAL ). IF ls_received_msg IS NOT INITIAL. "Messages published to Pub/Sub should be base-64 encoded, hence in order to get the exact message, we need to decode the data field. "However, attributes published to Pub/Sub should be accessible as data references. DATA(lv_msg) = |{ cl_http_utility=>decode_base64( encoded = ls_received_msg-message-data ) }|. /ui2/cl_json=>deserialize( EXPORTING json = lv_msg pretty_name = /ui2/cl_json=>pretty_mode-extended CHANGING data = ls_event_msg ). cl_demo_output=>new( )->begin_section( |Receive Events from Cloud Pubsub using ABAP SDK for Google Cloud| )->write_text( |The below event was successfully received with message ID { ls_received_msg-message-MESSAGE_ID }| )->write_data( ls_event_msg )->end_section( )->display( ). ls_input_ack-ack_ids = VALUE #( ( ls_received_msg-ack_id ) ). "Call API method: pubsub.projects.subscriptions.acknowledge "Acknowledge the messages so it is not pulled again. lo_client->acknowledge_subscriptions( EXPORTING iv_p_projects_id = lv_p_projects_id iv_p_subscriptions_id = lv_p_subscriptions_id is_input = ls_input_ack IMPORTING es_output = DATA(ls_output_ack) ev_ret_code = lv_ret_code ev_err_text = lv_err_text es_err_resp = ls_err_resp ). IF lo_client->is_success( lv_ret_code ). MESSAGE lv_msg TYPE 'S'. ELSE. MESSAGE lv_err_text TYPE 'E'. ENDIF. ELSE. MESSAGE 'No Messages were received!' TYPE 'S'. ENDIF. ELSE. MESSAGE lv_err_text TYPE 'E'. ENDIF. "Close HTTP Connection lo_client->close( ). CATCH /goog/cx_sdk INTO DATA(lo_exception). MESSAGE lo_exception->get_text( ) TYPE 'E'. ENDTRY.
- Salve e ative o relatório.
- Execute o relatório (F8).
Se a execução for bem-sucedida, você vai ver a saída do relatório, conforme mostrado abaixo:
9. Código do assinante do Pub/Sub do ABAP explicado
Essencialmente, esse programa ABAP se integra ao Google Cloud Pub/Sub como um assinante de mensagens. Ele verifica uma assinatura especificada em busca de novas mensagens sob demanda, as processa e confirma a recepção delas para evitar novas reenvios.
O programa vai realizar as seguintes atividades:
Detalhes
Estabelecer conexão:
- Ele estabelece uma conexão HTTP com o serviço do Google Cloud Pub/Sub usando a classe
/GOOG/CL_PUBSUB_V1
.
Definir parâmetros:
- ID do projeto: extrai o ID do projeto relevante em que a assinatura do Pub/Sub está localizada.
- Nome da assinatura:especifica o nome da assinatura de onde as mensagens serão extraídas (
PUBSUB_DEMO_SUBSCRIPTION
). - Limite de mensagens: define o número máximo de mensagens a serem recuperadas em uma única chamada de API (neste caso, 1).
Buscar mensagens:
- Chama o método
pull_subscriptions
para recuperar mensagens da assinatura especificada.
Processar mensagens recebidas:
- Se houver mensagens, o programa decodifica os dados, registra o conteúdo e envia um aviso.
Mensagens de confirmação:
- Chama o método
acknowledge_subscriptions
para enviar uma confirmação ao Pub/Sub indicando que as mensagens foram recebidas. Isso impede que elas sejam reenviadas.
Processar sucessos/erros:
- Fornece mensagens de sucesso se as mensagens forem recebidas e confirmadas e mostra mensagens de erro para vários cenários de falha (mensagens não recebidas, erros de API etc.).
Encerrar conexão:
- Fecha a conexão HTTP com o serviço do Pub/Sub.
10. Parabéns
Parabéns por concluir o codelab "Receber um evento do Cloud Pub/Sub usando o SDK ABAP para Google Cloud".
Você criou uma ponte entre o ABAP e o Google Cloud Pub/Sub. A conclusão do codelab demonstra um bom conhecimento de mensagens orientadas a eventos e como usar o SDK do ABAP para Google Cloud para integração com os serviços do Google Cloud. Muito bem!
Você desbloqueou um novo nível de integração entre ABAP e os serviços do Google Cloud. Amplie seus horizontes com estas opções incríveis:
- Como usar a API Translation com o ABAP SDK for Google Cloud
- Fazer upload de um objeto grande para um bucket do Cloud Storage usando a divisão em partes
- Como recuperar credenciais/segredos do Secret Manager com o SDK ABAP for Google Cloud
- Chamar o test-bison da Vertex AI no ABAP
- Chamar o BigQuery ML do ABAP
11. Limpar
Se você não quiser continuar com os outros codelabs relacionados ao SDK ABAP para Google Cloud, prossiga com a limpeza.
Excluir o projeto
- Exclua o projeto do Google Cloud:
gcloud projects delete abap-sdk-poc
Excluir recursos individuais
- Exclua a instância de computação:
gcloud compute instances delete abap-trial-docker
- Exclua as regras de firewall:
gcloud compute firewall-rules delete sapmachine
- Exclua a conta de serviço:
gcloud iam service-accounts delete \
abap-sdk-pubsub-subscriber@abap-sdk-poc.iam.gserviceaccount.com