Configurar Mensagens de Saída com uma API API Manager

Introdução

Este padrão de design de integração configura um Salesforce regra de workflow que envia uma mensagem de saída para um API Manager API quando um objeto é alterado (neste exemplo, o objeto Account). Um projeto do Design Studio processa a mensagem de saída do Salesforce, mapeia os dados do objeto e os salva em um banco de dados.

Para configurar esse padrão, siga estas seções em ordem:

• Parte 1: No Salesforce, configure uma regra de workflow para enviar uma mensagem de saída quando um objeto for alterado e baixe o arquivo WSDL que define a mensagem.
• Parte 2: No Design Studio, configure uma cadeia de operação para receber a mensagem de saída do Salesforce e armazene os valores mapeados em um banco de dados.
• Parte 3: No API Manager, configure uma API como endpoint para Salesforce.
• Parte 4: retorne ao Salesforce para atualizar o URL do endpoint da mensagem de saída, ative a mensagem de saída e teste o padrão de design de integração concluído.

Parte 1: Configurar uma Regra de Workflow do Salesforce e Baixar o Arquivo WSDL

1. No Salesforce, selecione Configuração > Ferramentas da plataforma > Automação de processos > Regras de Workflow.

2. Na página Regras de Workflow, clique no botão Nova Regra (destacado na imagem abaixo). Se uma caixa de diálogo Experimentar no Flow Builder for aberta, clique em Continuar com regras de Workflow.

   

3. Na página Nova regra de Workflow, clique no menu Objeto, selecione Conta e clique em Avançar.

   

4. Na página Conta, insira os valores a seguir e clique em Salvar e Próximo:

   • Nome da regra: Sua escolha de nome.
   • Descrição: (Opcional) Uma descrição para esta regra.
   • Critérios de avaliação: Criado e sempre editado.
   • Critérios da regra: Clique em Executar esta regra se for e selecione Fórmula avaliada como verdadeira.
   • No campo de fórmula, insira true.

   

5. Na página Editar regra, clique em Adicionar ação de Workflow e selecione Nova mensagem de saída (destacado na imagem abaixo).

   

6. Na página Nova mensagem de saída, insira os valores a seguir e clique em Salvar:

   • Nome: Sua escolha de nome.
   • Nome exclusivo: Este nome é gerado automaticamente com base no valor de Nome e nas regras de nomenclatura do campo.
   • Descrição: (Opcional) Uma descrição para esta mensagem de saída.
   • URL do Endpoint: example.com. Este URL temporário será atualizado posteriormente.
   • Usuário para enviar como: Insira o usuário que envia a mensagem de saída. O valor padrão é seu nome de usuário do Salesforce.
   • Componente protegido: Não selecionado.
   • Enviar ID da sessão: Não selecionado.
   • Campos da conta para enviar: Selecione os campos do objeto a enviar. Neste exemplo, apenas Nome e Telefone estão selecionados. O campo Id é selecionado automaticamente porque é o campo-chave do objeto.

   

7. Na página Editar regra, clique em Concluído.

   

8. Na página Regra de Workflow, na seção Ações imediatas de Workflow, clique no link de descrição da mensagem de saída (destacado na imagem abaixo).

   

9. Na página Detalhes da mensagem de saída do Workflow da mensagem, clique no link Clique para WSDL na linha denominada Endpoint WSDL (destacado na imagem abaixo).

   

10. Um arquivo XML é aberto em uma nova janela do navegador. Salve o arquivo com um .wsdl extensão. Dependendo do seu sistema operacional, pode ser necessário definir a extensão do arquivo após o download.

Parte 2: Operações do Design Studio

Definir a Operação 'Mensagem de Saída do Salesforce'

1. Crie um novo projeto Design Studio.

2. Na lista de itens do projeto à esquerda, clique com o botão direito em Operações e selecione Nova Operação.

3. Na caixa de diálogo Selecionar tipo, selecione Script e clique em Continuar.

4. Na janela Operações, defina o nome da operação como Salesforce Outbound Message.

   

5. Clique duas vezes na atividade Script da operação e clique em Criar novo Jitterbit Script.

6. Na janela Novo Script, defina os valores para o seguinte, clique em Salvar e feche a janela do script:

   • Nome: Receber mensagem de saída do Salesforce

   • Edite o script para corresponder ao seguinte:

     <trans>
     $org.api.salesforce.request=$jitterbit.api.request.body;
     </trans>
     

   

   Isso cria uma variável global e define-o com o valor da variável global predefinida jitterbit.api.request.body.

7. Na janela de operação Mensagem de saída do Salesforce, clique em Salvar.

8. Na lista de itens do projeto à esquerda, clique com o botão direito em Fontes e selecione Nova Fonte.

9. Na caixa de diálogo Selecionar tipo, selecione Variável global e clique em Continuar.

10. Na janela Nova Fonte, defina os valores para o seguinte, clique em Salvar e feche a janela de origem:

    • Nome: Solicitação de API do Salesforce
    • Tipo: Variável Global
    • Nome da variável global: org.api.salesforce.request

    

Defina a Operação 'Enviar Resposta da API'

1. Crie uma nova operação do tipo Transformação. Defina o nome da operação como Enviar resposta da API.

   

2. Clique duas vezes em Transformação. Na caixa de diálogo Selecionar Transformação, clique em Criar nova Transformação.

3. Na etapa NOME da janela Nova Transformação, insira os valores a seguir e clique em Avançar >:

   • Nome: Enviar resposta da API.
   • Fonte: (Nenhum).
   • Alvo: Resposta SOAP/WSDL.

   

4. Na etapa TARGET, selecione Selecionar um arquivo WSDL local, clique em Procurar..., selecione o arquivo WSDL baixado anteriormente e clique em Avançar > e aguarde validação de arquivo.

   

5. Na etapa TARGET, clique em Avançar >.

   

6. Na página Opções, clique em Concluir.

   

7. Na janela de transformação Enviar resposta da API, expanda todos os nós até o elemento [EV?] Ack (Boolean) estiver visível e clique duas vezes nele.

   

8. No Formula Builder, edite o script para corresponder ao seguinte e clique em OK para fechar o editor de script:

   <trans>
   true
   </trans>
   

   

   Esta é a resposta à solicitação SOAP do Salesforce.

9. Na janela Enviar transformações de resposta da API, clique em Salvar e feche a janela.

10. Na janela de operação Enviar resposta da API, clique com o botão direito no elemento Target, selecione Usar resposta da API e clique em Salvar:

    

    A operação Mensagem de saída do Salesforce:

    

11. Abra a operação Salesforce Outbound Message, selecione a seta para baixo ao lado do nome da operação e selecione Em caso de sucesso > Operação > Selecionar existente....

    

12. Na caixa de diálogo Selecionar operação bem-sucedida, selecione Enviar resposta da API e clique em OK.

    

13. Na janela de operação Mensagem de saída do Salesforce, clique em Salvar.

Defina a Operação 'Upsert Database'

1. Crie uma nova operação do tipo Transformação. Defina o nome da operação como Upsert Database.

   

2. Clique duas vezes na atividade Origem.

3. Na caixa de diálogo Selecionar origem, selecione Solicitação de API do Salesforce e clique em OK.

   

4. Clique duas vezes no elemento Target.

   

5. Na caixa de diálogo Selecionar destino, clique em Criar novo destino.

6. Na janela Novo destino, defina os valores para o seguinte, clique em Testar conexão e feche a janela Banco de dados:

   • Nome: Ponto final do banco de dados.
   • Tipo: Banco de dados.
   • Parâmetros de conexão: Defina os parâmetros do seu banco de dados. (Uma conexão com um servidor PostgreSQL é mostrada neste exemplo.)

   

7. Clique duas vezes no elemento Transformação.

   

8. Na caixa de diálogo Selecionar Transformação, clique em Criar nova Transformação.

9. Na janela Nova Transformação, insira os valores a seguir e clique em Avançar >:

   • Nome: Upsert Database.
   • Fonte: Solicitação SOAP/WSDL.

   

10. Na etapa SOURCE, selecione Select an Existing WSDL File, selecione o arquivo WSDL carregado anteriormente e clique em Next > e aguarde a validação do arquivo.

    

11. Quando o arquivo for validado, clique em Avançar >.

    

12. Na página de opções, clique em Avançar >.

    

13. Na etapa TARGET, clique em Baixar lista de tabelas. Selecione a tabela do banco de dados de destino, clique na seta para a direita para movê-la para a lista Tabelas Selecionadas e clique em Avançar >.

    

14. Na etapa TARGET, certifique-se de que Inserir/Atualizar esteja selecionado e clique em Concluir.

    

15. Na janela de transformação Upsert Database, expanda as árvores de origem e de destino, mapeie os campos arrastando e soltando, depois clique em Salvar e feche a janela de transformação.

    

16. Na janela de operação Upsert Database, clique em Salvar e feche a janela.

17. Na operação Salesforce Outbound Message, clique duas vezes na atividade Receive Salesforce Outbound Message.

18. Na janela do script, edite o script para corresponder ao seguinte, clique em Salvar e feche a janela:

    <trans>
    $org.api.salesforce.request=$jitterbit.api.request.body;
    RunOperation("<TAG>Operations/Upsert Database</TAG>")
    </trans>
    

    

19. Na janela de operação Mensagem de saída do Salesforce, clique em Salvar.

    

20. Selecione Ações > Implantar. Na caixa de diálogo Implantar, em Selecione um tipo de implantação, selecione Tudo e clique em Implantar.

    

Parte 3: API Manager de API

1. Em API Manager, selecione Minhas APIs e clique em Nova API.

2. Na etapa 1 da página Publicar nova API, insira os valores a seguir e clique em Avançar:

   • Nome da API: Insira um nome para a API.
   • Ambiente: Selecione o ambiente onde o projeto do Design Studio foi implantado.
   • Raiz do Serviço: Deixe o valor inicial derivado do nome da API.
   • Número da versão: (Opcional) Insira um número de versão da API.
   • Descrição: (Opcional) Insira uma descrição para esta API.

   

3. Na etapa 2, selecione API Customizada como Tipo de serviço e clique em Adicionar serviço de API. Para o novo serviço de API, insira esses valores nos campos a seguir, clique em Salvar e em Avançar:

   • Método de solicitação: Use o menu para selecionar o método de solicitação POST para o serviço API. Por padrão, o método de solicitação é definido como GET.

   • Nome do serviço: Insira um nome de serviço.

   • Na aba Operação, selecione estes valores:

     • Atribuir projeto: No menu, selecione seu projeto do Cloud Studio.

     • Atribuir operação(ões):

       • Operação: Selecione a operação Mensagem de saída do Salesforce.

       • Tipo de resposta: Selecione Alvo final como o tipo de resposta.

   

4. Na etapa 3, clique em Pular esta etapa.

5. Na etapa 4, clique em Salvar e publicar.

   

6. Na caixa de diálogo intitulada Tudo definido, sua API está ativa!, clique em Copiar URL e, em seguida, clique em Dispensar.

Parte 4: Atualizar URL do Salesforce Endpoint e Ativar

1. No Salesforce, selecione Configuração > Ferramentas da plataforma > Automação de processos > Ações de Workflow > Mensagens de saída.
2. Na página Mensagens de saída, clique em Editar para sua mensagem de saída.

3. Substitua o conteúdo do campo Endpoint URL (destacado na imagem abaixo) pela URL copiada no final da seção anterior e clique em Salvar.

   

4. Na seção Regras de Workflow usando esta mensagem de saída, clique em Ativar para a regra (destacada na imagem abaixo).

   

Teste a Integração

Para testar esse padrão de design de integração, siga estas etapas:

1. No Salesforce, abra o aplicativo Serviço e selecione a aba Contas.
2. Edite um contato da conta e salve-o.
3. Faça login em seu banco de dados e consultar a tabela de destino.