Atividade de consulta do Microsoft Dynamics 365 Business Central v2
Introdução
Uma atividade de Consulta do Microsoft Dynamics 365 Business Central v2, usando sua conexão do Microsoft Dynamics 365 Business Central v2, recupera registros de uma entidade no Microsoft Dynamics 365 Business Central e deve ser usado como uma fonte em uma operação.
Criar uma atividade de consulta do Microsoft Dynamics 365 Business Central v2
Uma instância de uma atividade Consulta do Microsoft Dynamics 365 Business Central v2 é criada a partir de uma conexão do Microsoft Dynamics 365 Business Central v2 usando seu tipo de atividade Consulta.
Para criar uma instância de uma atividade, arraste o tipo de atividade para a quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.
Uma atividade existente de Consulta do Microsoft Dynamics 365 Business Central v2 pode ser editada nestes locais:
- A quadro de design (veja menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).
Configurar uma atividade de consulta do Microsoft Dynamics 365 Business Central v2
Siga estas etapas para configurar uma atividade Consulta do Microsoft Dynamics 365 Business Central v2:
-
Etapa 1: Insira um nome e selecione uma empresa e um objeto
Forneça um nome para a atividade e especifique a empresa e o objeto. -
Etapa 2: Selecionar objetos filhos
Especifique os objetos filhos. -
Etapa 3: Definir uma sequência de caracteres de filtro
O Query Builder é usado para definir condições em uma consultar usando os campos de objeto e aplicar paginação a uma consultar. -
Etapa 4: Revise o esquema de dados
Todos os esquemas de resposta gerados a partir do endpoint são exibidos.
Etapa 1: insira um nome e selecione uma empresa e um objeto
Nesta etapa, forneça um nome para a atividade e especifique a empresa e o objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Consulta do Microsoft Dynamics 365 Business Central v2 e não deve conter barras
/
ou dois pontos:
. -
Empresa: Selecione uma empresa da lista. Clique no ícone de atualização. ou a palavra Atualizar para recarregar a lista de empresas.
-
Selecionar objeto: Esta seção exibe os objetos disponíveis na empresa selecionada.
-
Objeto selecionado: Depois que um objeto é selecionado, ele é listado aqui.
-
Pesquisa: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.
-
Atualizar: Clique no ícone de atualização ou a palavra Atualizar para recarregar objetos do endpoint. Isso pode ser útil se objetos tiverem sido adicionados ao Microsoft Dynamics 365 Business Central. Esta ação atualiza todos os metadados usados para criar a tabela de objetos exibida na configuração.
-
Selecionando um Objeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Microsoft Dynamics 365 Business Central v2:
-
Nome: O nome do objeto do endpoint.
-
Descrição: A descrição do objeto do endpoint.
-
Dica
Se a tabela não for preenchida com os objetos disponíveis, a conexão pode não ser bem-sucedido. Certifique-se de estar conectado reabrindo a conexão e testando as credenciais novamente.
Os objetos do Business Central devem ser publicados como Serviços Web para serem acessados por meio do conector. Para fazer isso, siga as etapas descritas na documentação da Microsoft.
-
-
Salvar e Sair: Se habilitado, clique para salvar a configuração desta etapa e fechar a configuração da atividade.
-
Próximo: Clique para armazenar temporariamente a configuração desta etapa e prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.
Etapa 2: Selecione objetos filho
Nesta etapa, especifique os objetos filhos. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Classes de Objetos: Esta seção é usada para selecionar classes de objetos filhos para consultar. Esta seção é opcional e pode ser ignorada selecionando Próximo.
-
Objetos filho disponíveis: Esta coluna exibe classes de objetos filho para seleção.
-
Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de classes de objetos filhos. A pesquisa não diferencia maiúsculas de minúsculas. Se as classes de objetos já estiverem exibidas na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar as classes de objetos filhos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.
-
Atualizar: Clique no ícone de atualização para recarregar classes de objetos filho do endpoint. Isso pode ser útil se classes de objetos filho tiverem sido adicionadas ao Microsoft Dynamics 365 Business Central.
-
Adicionando um Objeto Filho: Dentro da coluna, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone Adicionar para adicionar classes selecionadas à coluna Objetos Filhos Selecionados.
-
-
Objetos Filhos Selecionados: Esta coluna exibe as classes de objetos filhos selecionadas.
- Removendo um Objeto Filho: Dentro da coluna, clique em qualquer lugar de uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone de remoção. para retornar as classes selecionadas à coluna Objetos Filhos Disponíveis.
-
-
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Próximo: Clique para armazenar temporariamente a configuração desta etapa e prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.
Etapa 3: definir uma sequência de filtro
Nesta etapa, a String de Filtro de uma consultar é definida usando os campos de objeto e as configurações de consultar disponíveis. Cada elemento da interface do usuário desta etapa é descrito abaixo.
Dica
Campos com ícone de variável suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [
no campo ou clicando no ícone da variável para exibir uma lista das variáveis existentes para escolher.
A String de Filtro pode ser configurada nas abas Básico ou Avançado.
Nota
As alterações feitas em uma aba não serão refletidas na outra. A consultar de string de filtro para o modo selecionado quando o conector for fechado será a consultar usada para o conector.
-
Básico: Permite que você crie a String de Filtro com campos guiados:
-
Campos de objeto: Selecione os campos a serem usados na consultar com base na classe de objeto selecionada.
-
Pesquisar: Insira qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos do objeto selecionado. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada pressionamento de tecla.
-
Atualizar: Clique no ícone de atualização ou a palavra Atualizar para recarregar campos do objeto do endpoint OData.
-
Selecionar tudo na classe de objeto: 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 só vez.
-
Selecionar Campos: Marque as caixas de seleção dos campos que deseja incluir na consultar para que sejam adicionados automaticamente à 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: Insira o número máximo de resultados a serem recuperados para cada página na resposta da consultar. Se deixado em branco, cada página conterá 100 resultados.
Nota
Se a paginação do lado do cliente for necessária, use os campos Ignorar e Superior.
-
Incluir Contagem: Selecione para incluir o número de resultados de uma consultar como parte da resposta. Por exemplo, se uma consultar retornar 5 resultados no total, a resposta também incluirá
"_microsoft_dynamics_365_business_central.count": 5
. -
Pesquisa de texto completo: Este campo não é suportado pelo Protocolo OData V4 e é ignorado em tempo de execução. Em vez disso, use cláusulas condicionais (descritas abaixo).
-
Ignorar: Insira o número de resultados a serem ignorados na resposta da consultar. Usado para paginação do lado do cliente.
-
Superior: Insira o número máximo de resultados a serem recebidos na resposta da consultar. Usado para paginação do lado do cliente.
-
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 usada para o condicional.
-
Campo: Use o menu suspenso para selecionar o campo da classe de objeto a ser usado para o condicional.
-
Operador: Use o menu suspenso para selecionar um operador apropriado:
Comparação É igual a Maior que Maior ou igual a Menor que Menor ou igual a -
Valor: Insira o valor desejado para comparar com as seleções suspensas anteriores.
-
Remover: Clique para remover o condicional.
-
Adicionar: Clique para adicionar uma nova condicional à tabela Cláusulas Condicionais e Sequência de Filtros.
-
Remover tudo: Clique para remover todos os condicionais da tabela Cláusulas condicionais e Sequência de caracteres de filtro.
-
-
Sequência de caracteres de filtro: Conforme você preenche os outros campos na aba Básico, a instrução da sequência de caracteres de filtro nesta caixa de texto é preenchida automaticamente com os campos, condições e opções de consultar selecionados.
-
-
Avançado: Oculta os campos guiados e permite que você modifique a Sequência de caracteres do filtro diretamente:
-
Tamanho da página: Insira o número máximo de resultados a serem recuperados para cada página na resposta da consultar. Se deixado em branco, cada página conterá 100 resultados.
Nota
Se a paginação do lado do cliente for necessária, use o
$skip
e$top
opções de consultar no campo Filter String. -
String de filtro: Edite a declaração de string de filtro diretamente.
-
-
Consulta de Teste: Clique para validar a consultar. Se você editar a sequência de caracteres do filtro no modo Avançado, a consultar deverá ser válida e validada por meio deste botão para habilitar o botão Avançar.
Nota
Um erro poderá ocorrer se a instância do Microsoft Dynamics 365 Business Central tiver mais de uma empresa e não tiver uma empresa padrão atribuída. Para resolver isso, você deve atribuir uma empresa padrão para a instância associada ao ID do locatário especificado na conexão.
-
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Próximo: Clique para armazenar temporariamente a configuração desta etapa e prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.
Etapa 4: Revise o esquema de dados
O esquema de resposta gerado a partir do endpoint é exibido. Cada elemento da interface do usuário desta etapa é descrito abaixo.
-
Esquema de dados: Este esquema de dados é herdado por transformações adjacentes e é exibido novamente durante mapeamento de transformação.
O conector do Microsoft Dynamics 365 Business Central v2 usa o Protocolo OData V4. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.
-
Atualizar: Clique no ícone de atualização ou a palavra Atualizar para regenerar esquemas do endpoint do Microsoft Dynamics 365 Business Central. Essa ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.
-
Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.
-
Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.
-
Descartar Alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.
Próximos passos
Após configurar uma atividade Consulta do Microsoft Dynamics 365 Business Central v2, conclua 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 estejam no mesmo fluxo de trabalho ou em workflows diferentes.
As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte menu de ações da atividade em Noções básicas do conector.
As atividades de Consulta do Microsoft Dynamics 365 Business Central v2 podem ser usadas como uma fonte com esses padrões de operação:
- Padrão de Transformação
- Padrão de arquivamento de dois alvos (apenas como primeira fonte)
- Padrão de arquivo HTTP de dois alvos (apenas como primeira fonte)
- Padrão de duas transformações (apenas como primeira fonte)
Para usar a atividade com funções de script, grave os dados em um local temporário e use esse local temporário na função de script.
Quando estiver pronto, implantar e executar a operação e validar o comportamento verificando os logs de operação.