Atividade Listar Canais do Microsoft Teams no Jitterbit Studio
Introdução
Uma atividade Listar Canais do Microsoft Teams, utilizando sua conexão do Microsoft Teams, recupera uma lista de canais para uma equipe no Microsoft Teams e é destinada a ser usada como um alvo para consumir dados em uma operação.
Problemas conhecidos
O conector do Microsoft Teams possui este problema conhecido:
-
Testar uma consulta em uma atividade Listar Canais do Microsoft Teams falha se o nome da equipe contiver espaços
-
Resumo: Testar uma consulta na etapa 2 de uma atividade Listar Canais do Microsoft Teams falha com um erro Consulta Inválida se o nome da equipe do Microsoft Teams contiver espaços.
-
Informações Adicionais: O problema é limitado ao teste da consulta. A configuração da atividade ainda pode ser concluída. Em tempo de execução, a operação retornará os detalhes do canal esperados.
-
Criar uma atividade Listar Canais do Microsoft Teams
Uma instância de uma atividade Listar Canais do Microsoft Teams é criada a partir de uma conexão do Microsoft Teams usando seu tipo de atividade Listar Canais.
Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.
Uma atividade existente Listar Canais do Microsoft Teams pode ser editada a partir destes locais:
- A tela de design (veja Menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).
Configurar uma atividade de Listar Canais do Microsoft Teams
Siga estas etapas para configurar uma atividade de Listar Canais do Microsoft Teams:
-
Etapa 1: Insira um nome e selecione uma equipe
Forneça um nome para a atividade e selecione uma equipe. -
Etapa 2: Defina uma string de filtro
Defina condições em uma consulta usando os campos do canal e aplique paginação a uma consulta. -
Etapa 3: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.
Etapa 1: Insira um nome e selecione uma equipe
Nesta etapa, forneça um nome para a atividade e selecione uma equipe. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Menu de endpoint: Se você tiver vários endpoints do mesmo tipo de conector configurados, um menu na parte superior da tela exibe o nome do endpoint atual. Clique no menu para alternar para um endpoint diferente. Para mais informações, veja Alterar o endpoint atribuído em Telasa de configuração.
- Editar endpoint: Aparece quando você passa o mouse sobre o nome do endpoint atual. Clique para editar a configuração de conexão do endpoint atualmente selecionado.
-
Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Listar Canais do Microsoft Teams e não deve conter barras invertidas
/ou dois pontos:. -
Selecionar uma equipe: Esta seção exibe as equipes disponíveis no endpoint do Microsoft Teams.
-
Equipe Selecionada: Após uma equipe ser selecionada, ela é listada aqui.
-
Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de equipes. A pesquisa não diferencia maiúsculas de minúsculas. Se as equipes já estiverem exibidas na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar as equipes do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.
-
-
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar as equipes do endpoint do Microsoft Teams. Isso pode ser útil se equipes foram adicionadas ao Microsoft Teams. Esta ação atualiza todos os metadados usados para construir a tabela de equipes exibida na configuração.
-
Selecionando uma Equipe: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar uma equipe. Apenas uma equipe pode ser selecionada. As informações disponíveis para cada equipe são obtidas do endpoint do Microsoft Teams:
-
Nome: O nome da equipe.
-
Descrição: A descrição da equipe. Se uma equipe não tiver uma descrição ou tiver uma descrição composta apenas por espaços em branco, o conector usará o nome da equipe como a descrição da equipe. Isso não afetará o esquema, a execução ou a resposta retornada.
Dica
Se a tabela não for preenchida com equipes disponíveis, a conexão do Microsoft Teams pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.
-
-
Salvar e Sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.
-
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Etapa 2: Definir uma string de filtro
Nesta etapa, uma String de Filtro de uma consulta é definida usando os campos de canal disponíveis e as configurações da consulta. Cada elemento da interface do usuário desta etapa é descrito abaixo.
Dica
Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir um menu listando as variáveis existentes para escolher.
A String de Filtro pode ser configurada nas abas Básica ou Avançada.
Nota
As alterações feitas em uma aba não serão refletidas na outra. A consulta da string de filtro para o modo que está selecionado quando o conector é fechado será a consulta utilizada para o conector.
-
Básica: Permite construir a String de Filtro com campos guiados.
-
Campos de Objeto: Selecione os campos a serem utilizados na consulta com base no canal selecionado.
-
Pesquisar: Digite qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos para o canal selecionado. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada tecla pressionada.
-
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar os campos do canal a partir do endpoint OData.
-
Selecionar Todos nos Canais: Ao usar a caixa de pesquisa para filtrar, você pode usar esta caixa de seleção para selecionar todos os campos visíveis de uma vez.
-
Selecionar Campos: Selecione as caixas de seleção dos campos que deseja incluir na consulta para que sejam automaticamente adicionados à String de Filtro. Você também pode selecionar todos os campos de uma vez usando a caixa de seleção pai.
-
-
Tamanho da Página: Digite um tamanho de página para habilitar a paginação dos resultados. O número de resultados em uma página totalizará até o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.
-
Incluir Contagem: Selecione para incluir o número de resultados de uma consulta como parte da resposta. Por exemplo, se uma consulta retornar 5 resultados no total, a resposta também incluirá
"@odata.count": 5. -
Pesquisa de Texto Completo: Digite termos de pesquisa para consultar na classe de objeto selecionada. O endpoint OData lida com a forma como a pesquisa é interpretada para uma classe de objeto.
-
Pular: Digite um número de resultados a serem pulados na resposta da consulta.
-
Top: Digite um número máximo de resultados a serem recebidos na resposta da consulta.
-
Cláusulas Condicionais: Para adicionar condicionais, use estes campos como entrada para ajudar a construir as cláusulas, que então aparecem na String de Filtro.
-
Objeto: Use o menu suspenso para selecionar a classe de objeto a ser utilizada para a condição.
-
Campo: Use o menu suspenso para selecionar o campo da classe de objeto a ser utilizado para a condição.
-
Operador: Use o menu suspenso para selecionar um operador apropriado:
Comparação Igual Maior que Maior ou igual a Menor que Menor ou igual a -
Valor: Insira o valor desejado para comparar com as seleções anteriores do menu suspenso.
-
Remover: Clique para remover a condição.
-
Adicionar: Clique para adicionar uma nova condição à tabela de Cláusulas Condicionais e String de Filtro.
-
Remover Todos: Clique para remover todas as condições da tabela de Cláusulas Condicionais e String de Filtro.
-
-
String de Filtro: À medida que você preenche os outros campos na aba Básico, a declaração da string de filtro nesta caixa de texto é automaticamente preenchida com os campos, condições e opções de consulta selecionados.
-
-
Avançado: Oculta os campos guiados e permite que você modifique a String de Filtro diretamente.
-
Tamanho da Página: Insira um tamanho de página para habilitar a paginação dos resultados. O número de resultados em uma página totalizará até o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.
-
String de Filtro: Edite a declaração da string de filtro diretamente.
-
-
Testar Consulta: Clique para validar a consulta. Se a consulta for válida, uma amostra de até 10 registros recuperados da consulta é exibida em uma tabela. Se a consulta não for válida, mensagens de erro relevantes são exibidas. Se você editar a string de filtro enquanto estiver no modo Avançado, a consulta deve ser válida e validada através deste botão para habilitar o botão Próximo.
-
Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.
-
Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 3: Revisar os esquemas de dados
Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.
Nota
Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.
O conector do Microsoft Teams utiliza a Microsoft Graph REST API v1.0. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.
Os esquemas de dados de solicitação e resposta consistem nesses nós e campos:
-
Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas a partir do endpoint do Microsoft Teams. Esta ação também regenera um esquema em outros locais ao longo do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.
-
Editar: Clique no ícone de editar acima de cada esquema de dados para entrar no editor desse esquema de dados. O editor permite que você adicione, exclua e reorganize nós e campos e altere seus tipos de dados. Todos os nós e campos recém-adicionados são definidos como
[0, 1]cardinalidade. As alterações feitas nos esquemas de dados devem ser aceitáveis para o endpoint e devem ser feitas apenas após consultar qualquer documentação disponível para o endpoint. Após fazer edições no esquema, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas redefinirá os esquemas para suas estruturas padrão. -
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Finalizado: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.
-
Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Próximas etapas
Após configurar uma atividade Listar Canais do Microsoft Teams, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.
As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para mais detalhes, consulte o menu de ações da atividade em Conceitos básicos do conector.
As atividades Listar Canais do Microsoft Teams podem ser usadas como um alvo com esses padrões de operação:
- Padrão de transformação
- Padrão de duas transformações (como o primeiro ou segundo alvo)
Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.
Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.