Enviar uma notificação do Microsoft Teams a partir de uma operação do Studio no Jitterbit Studio
Introdução
Este padrão de design de integração envia uma mensagem formatada para um canal do Microsoft Teams a partir de uma operação do Studio. A operação usa o conector Microsoft Teams para postar uma mensagem em um time e canal específicos via API Microsoft Graph. Este padrão é comumente usado para notificar um time quando um evento significativo ocorre, como o recebimento de um novo pedido, a criação de um registro ou a conclusão de uma operação com erros.
Antes de configurar o conector, é necessário concluir os pré-requisitos do Microsoft Teams, que exigem um registro de aplicativo do Azure no Microsoft Entra ID.
Padrão de design
A operação do Studio segue o padrão de transformação:
A atividade de origem fornece os dados usados para construir a mensagem (por exemplo, o resultado de uma consulta de banco de dados, um registro do Salesforce ou uma saída de script). A transformação constrói o texto da mensagem. A atividade Send Message do Microsoft Teams publica a mensagem no time e canal selecionados.
Parte 1: Concluir os pré-requisitos
O conector Microsoft Teams autentica usando OAuth 2.0, o que exige um registro de aplicativo no Microsoft Entra ID (anteriormente Azure Active Directory).
Siga as etapas em Pré-requisitos do Microsoft Teams para:
-
Registrar um aplicativo no portal do Microsoft Entra ID e anotar a ID do Aplicativo (cliente) e a ID do Diretório (locatário).
-
Criar um segredo do cliente para o aplicativo e anotar seu valor. O valor é visível apenas quando é criado pela primeira vez.
-
Conceder as permissões da API Microsoft Graph necessárias e clicar em Grant admin consent.
Mantenha a ID do locatário, ID do cliente, valor do segredo do cliente e seu nome de usuário e senha do Microsoft Entra ID disponíveis para a configuração da conexão.
Parte 2: Configurar a conexão do Microsoft Teams
-
No Studio, abra seu projeto e clique na aba Project endpoints and connectors na paleta de componentes de design.
-
Clique no conector Microsoft Teams para abrir a configuração da conexão.
-
Connection Name: Digite um nome como
Microsoft Teams. -
Tenant ID: Digite a ID do Diretório (locatário) do seu registro de aplicativo do Microsoft Entra ID.
-
Client ID: Digite a ID do Aplicativo (cliente) do seu registro de aplicativo.
-
Client Secret: Digite o valor do segredo do cliente do seu registro de aplicativo.
Dica
Armazene o segredo do cliente, nome de usuário e senha como variáveis de projeto com seus valores ocultos. Isso mantém as credenciais confidenciais fora da configuração da conexão diretamente e facilita sua rotação sem editar o projeto.
-
Username: Digite o nome de usuário que você usa para entrar no Microsoft Entra ID.
-
Password: Digite a senha da conta.
-
Clique em Test e depois em Save Changes.
Parte 3: Configurar a atividade Send Message
-
Na paleta de componentes de design, expanda o endpoint do Microsoft Teams e arraste o tipo de atividade Send Message para a tela de design.
-
Clique duas vezes na atividade para abrir sua configuração.
Etapa 1: Digite um nome e selecione um time
-
Name: Digite um nome como
Post Teams Notification. -
Na tabela Select a Team, clique em uma linha para selecionar o time que contém o canal de destino. A tabela é preenchida a partir do endpoint do Microsoft Teams. Se a tabela estiver vazia, verifique se o teste de conexão foi bem-sucedido.
-
Clique em Próximo.
Etapa 2: Selecione um canal
-
Na tabela Selecionar um Canal, clique em uma linha para selecionar o canal em que deseja postar. A tabela mostra os canais da equipe selecionada na etapa anterior.
-
Configurações Opcionais: Se você quiser enviar mensagens formatadas em HTML em vez de texto simples, expanda Configurações Opcionais e selecione Tipo de Conteúdo: 'HTML'.
-
Clique em Próximo.
Etapa 3: Analise os esquemas de dados
O conector gera esquemas de solicitação e resposta a partir do ponto de extremidade do Microsoft Teams. Analise-os e clique em Concluído.
O esquema de solicitação contém os seguintes campos em sendMessageRequest:
message: O conteúdo de texto da mensagem. Obrigatório.contentType: O tipo de conteúdo da mensagem. Este campo é preenchido automaticamente com base na configuração Tipo de Conteúdo: 'HTML' da etapa anterior.attachment: Um objeto opcional para anexar um arquivo, contendo os camposfileNameefileData. Arquivos maiores que 4 MB causarão falha na operação.
Parte 4: Mapeie a mensagem em uma transformação
Na transformação que precede a atividade Enviar Mensagem, mapeie o campo message do esquema de solicitação para um script que constrói a string da mensagem.
Por exemplo, para enviar uma notificação sobre um novo pedido, o script de transformação para sendMessageRequest/message poderia ser:
<trans>
"New order #" + $order_id + " received from " + $customer_name + " for $" + $order_total
</trans>
Em que order_id, customer_name e order_total são variáveis globais preenchidas por um script anterior ou mapeadas da atividade de origem.
Dica
Para incluir uma quebra de linha em uma mensagem de texto simples, use "\n" na string do script. Se você selecionou Tipo de Conteúdo: 'HTML', use a tag <br> em vez disso.
Verifique a integração
Implante e execute a operação para testar a notificação. Verifique os logs da operação para confirmar que a atividade Enviar Mensagem foi concluída sem erros. Se a mensagem não aparecer no canal do Teams, verifique se a equipe e o canal corretos foram selecionados na configuração da atividade e se o consentimento do administrador foi concedido para todas as permissões de API necessárias.