Configure mensagens de saída com uma API do API Manager no Jitterbit Design Studio

Introdução

Este padrão de design de integração configura uma regra de fluxo de trabalho do Salesforce que envia uma mensagem de saída para uma API do API Manager quando um objeto muda (neste exemplo, o objeto Conta). 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 este padrão, siga estas seções na ordem:

• Parte 1: No Salesforce, configure uma regra de fluxo de trabalho para enviar uma mensagem de saída quando um objeto muda e baixe o arquivo WSDL que define a mensagem.
• Parte 2: No Design Studio, configure uma cadeia de operações para receber a mensagem de saída do Salesforce e armazenar os valores mapeados em um banco de dados.
• Parte 3: No API Manager, configure uma API como um ponto de extremidade para o Salesforce.
• Parte 4: Retorne ao Salesforce para atualizar a URL do ponto de extremidade da mensagem de saída, ative a mensagem de saída e, em seguida, teste o padrão de design de integração concluído.

Parte 1: Configure uma regra de fluxo de trabalho do Salesforce e baixe o arquivo WSDL

1. No Salesforce, selecione Configuração > Ferramentas de Plataforma > Automação de Processos > Regras de Fluxo de Trabalho.

2. Na página Regras de Fluxo de Trabalho, clique no botão Nova Regra (destacado na imagem abaixo). Se um diálogo Experimente no Flow Builder abrir, clique em Continuar com Regras de Fluxo de Trabalho.

   

3. Na página Nova Regra de Fluxo de Trabalho, clique no menu Objeto, selecione Conta e clique em Próximo.

   

4. Na página Conta, insira valores para os seguintes campos 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 que for Editado.
   • Critérios da Regra: Clique em Executar Esta Regra Se, em seguida, selecione Fórmula Avalia como Verdadeira.
   • No campo da fórmula, insira true.

   

5. Na página Editar Regra, clique em Adicionar Ação de Fluxo de Trabalho, em seguida, selecione Nova Mensagem de Saída (destacada na imagem abaixo).

   

6. Na página Nova Mensagem de Saída, insira valores para os seguintes campos e clique em Salvar:

   • Nome: Sua escolha de nome.
   • Nome Único: 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. Esta URL temporária será atualizada posteriormente.
   • Usuário para Enviar Como: Insira o usuário que envia a mensagem de saída. O valor padrão é 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 serem enviados. Neste exemplo, apenas Nome e Telefone estão selecionados. O campo Id é selecionado automaticamente, pois é o campo chave do objeto.

   

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

   

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

   

9. Na página Detalhes da Mensagem de Fluxo de Trabalho de Saída da mensagem, clique no link Clique para WSDL na linha rotulada como Endpoint WSDL (destacada na imagem abaixo).

   

10. Um arquivo XML é aberto em uma nova janela do navegador. Salve o arquivo com a extensão .wsdl. 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 do 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 Mensagem de Saída do Salesforce.

   

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

6. Na janela Novo Script, defina os valores para os seguintes campos, clique em Salvar, e depois 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 a define para o valor da variável global predefinida jitterbit.api.request.body.

7. Na janela da 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 Sources, e selecione New Source.

9. Na caixa de diálogo Select Type, selecione Global Variable, e clique em Continue.

10. Na janela New Source, defina os valores para os seguintes campos, clique em Save, e depois feche a janela de fonte:

    • Name: Salesforce API Request
    • Type: Global Variable
    • Global Variable Name: org.api.salesforce.request

    

Definir a operação 'Send API response'

1. Crie uma nova operação do tipo Transformation. Defina o nome da operação como Send API Response.

   

2. Clique duas vezes em Transformation. Na caixa de diálogo Select Transformation, clique em Create New Transformation.

3. Na etapa NAME da janela New Transformation, insira os valores para os seguintes campos, e clique em Next >:

   • Name: Send API Response.
   • Source: (None).
   • Target: SOAP/WSDL Response.

   

4. Na etapa TARGET, selecione Select a Local WSDL File, clique em Browse..., selecione o arquivo WSDL previamente baixado, e clique em Next > e aguarde a validação do arquivo.

   

5. Na etapa TARGET, clique em Next >.

   

6. Na página Options, clique em Finish.

   

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

   

8. No Construtor de Fórmulas, edite o script para corresponder ao seguinte, em seguida clique em OK para fechar o editor de scripts:

   <trans>
   true
   </trans>
   

   

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

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

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

    

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

    

11. Abra a operação Mensagem de Saída do Salesforce, selecione a seta para baixo ao lado do nome da operação, em seguida selecione Em Sucesso > Operação > Selecionar Existente....

    

12. Na caixa de diálogo Selecionar Operação de Sucesso, selecione Enviar Resposta da API, em seguida clique em OK.

    

13. Na janela da 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 Fonte.

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

   

4. Clique duas vezes no elemento Alvo.

   

5. Na caixa de diálogo Selecionar Alvo, clique em Criar Novo Alvo.

6. Na janela Novo Alvo, defina valores para o seguinte, clique em Testar Conexão, em seguida feche a janela Banco de Dados:

   • Nome: Endpoint de Banco de Dados.
   • Tipo: Banco de Dados.
   • Parâmetros de Conexão: Defina os parâmetros para o 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 valores para o seguinte, e clique em Próximo >:

   • Nome: Upsert Banco de Dados.
   • Fonte: Solicitação SOAP/WSDL.

   

10. Na etapa FONTE, selecione Selecionar um Arquivo WSDL Existente, depois selecione o arquivo WSDL previamente enviado, e clique em Próximo > e aguarde a validação do arquivo.

    

11. Quando o arquivo for validado, clique em Próximo >.

    

12. Na página de opções, clique em Próximo >.

    

13. Na etapa DESTINO, clique em Baixar Lista de Tabelas. Selecione a tabela de banco de dados de destino, clique na seta para a direita para movê-la para a lista de Tabelas Selecionadas, e clique em Próximo >.

    

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

    

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

    

16. Na janela da 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, depois 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 da operação Salesforce Outbound Message, clique em Salvar.

    

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

    

Parte 3: API Manager API

1. No API Manager, selecione APIs, e depois clique em Nova API.

2. Na etapa 1 da página Publicar Nova API, insira valores para os seguintes campos e clique em Próximo:

   • 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 Personalizada como o Tipo de Serviço e depois clique em Adicionar Serviço de API. Para o novo serviço de API, insira estes valores para os seguintes campos, clique em Salvar e depois clique em Próximo:

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

   • Nome do Serviço: Insira um nome para o serviço.

4. Na aba Operação, selecione estes valores:

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

   • Atribuir Operação(ões):

     • Operação: Selecione a operação Salesforce Outbound Message.

     • Tipo de Resposta: Selecione Final Target como o tipo de resposta.

   

5. Na etapa 3, clique em Pular Esta Etapa.

6. Na etapa 4, clique em Salvar & Publicar.

   

7. Na caixa de diálogo intitulada Tudo Pronto, Sua API está Ao Vivo!, clique em Copiar URL, depois clique em Dispensar.

Parte 4: Atualizar URL do endpoint do Salesforce e ativar

1. No Salesforce, selecione Configuração > Ferramentas de Plataforma > Automação de Processos > Ações de Fluxo de Trabalho > 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 URL do Endpoint (destacado na imagem abaixo) pela URL copiada no final da seção anterior, depois clique em Salvar.

   

4. Na seção Regras de Fluxo de Trabalho Usando Esta Mensagem de Saída, clique em Ativar para a regra (destacada na imagem abaixo).

   

Testar a integração

Para testar este 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 de conta e, em seguida, salve-o.
3. Faça login no seu banco de dados e consulte a tabela de destino.