Atividade de Consulta do Microsoft Dynamics 365 Business Central v2

Introdução

Uma atividade 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 destina-se a ser usado como origem 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 Query.

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 em Reutilização de componentes.

Uma atividade de Consulta existente do Microsoft Dynamics 365 Business Central v2 pode ser editada nestes locais:

• A quadro de design (consulte menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (consulte menu de ações do componente em 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 objeto
  Forneça um nome para a atividade e especifique a empresa e o objeto.

• Etapa 2: Selecione objetos filhos
  Especifique os objetos filhos.

• Etapa 3: Defina uma sequência de filtros
  O Query Builder é usado para definir condições em uma consultar usando os campos do objeto e aplicar paginação a uma consultar.

• Etapa 4: Revise o esquema de dados
  Quaisquer 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 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.

  • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A busca 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 Refresh 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 construir a tabela de objetos exibidos na configuração.

  • Selecionando um objeto: Na tabela, clique em qualquer lugar de 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 objetos disponíveis, a conexão pode não ser bem-sucedido. Certifique-se de que você esteja conectado reabrindo a conexão e testando novamente as credenciais.

  Os objetos do Business Central devem ser publicados como Web Services 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 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 nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Selecione Objetos Filho

Nesta etapa, especifique os objetos filho. 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 Filhos Disponíveis: Esta coluna exibe classes de objetos filhos para seleção.

    • Pesquisa: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de classes de objetos filhos. A busca 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 classes de objetos filho 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 filhos 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 Selected Child Objects:

      

  • Objetos Filhos Selecionados: Esta coluna exibe classes de objetos filhos selecionadas.

    • Removendo 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 remover para retornar as classes selecionadas para a 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 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 nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Defina uma Sequência de Filtros

Nesta etapa, a Filter String de uma consulta é definida para uma consultar usando campos de objeto e configurações de consultar disponíveis. Cada elemento da interface do usuário desta etapa é descrito abaixo.

A Filter String pode ser configurada nas abas Basic ou Advanced.

• Básico: Permite criar a Filter String com campos guiados:

  

  • Campos de Objeto: Selecione os campos a serem utilizados 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 busca 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 Refresh 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 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 Skip e Top.

  • 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 é compatível com o Protocolo OData V4 e é ignorado em tempo de execução. Em vez disso, use cláusulas condicionais (descritas abaixo).

  • Pular: Insira o número de resultados a serem ignorados na resposta da consultar. Usado para paginação do lado do cliente.

  • Principal: 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 esses 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 a condicional.

    • Campo: Use o menu suspenso para selecionar o campo da classe de objeto a ser usado para a condicional.

    • Operador: Use o menu suspenso para selecionar um operador apropriado:

      Comparação
      É igual a
      Maior que
      Maior que 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 a condicional.

    • Adicionar: Clique para adicionar uma nova condicional à tabela Cláusulas condicionais e String de filtro.

    • Remover tudo: Clique para remover todas as condicionais da tabela Cláusulas condicionais e String de filtro.

  • String de filtro: À medida que você preenche os outros campos na aba Básico, a instrução de string 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 modificar Filter String 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.

  • Filter String: Edite a instrução da string de filtro diretamente.

• Consulta de Teste: Clique para validar a consultar. Se você editar a string do filtro no modo Avançado, a consultar deverá ser válida e validada por meio deste botão para ativar o botão Próximo.

• 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 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que 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 o 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. Esta 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 solicita que você confirme que deseja descartar as alterações.

Próximos Passos

Depois de configurar uma atividade Consulta do Microsoft Dynamics 365 Business Central v2, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas de operação. Você também pode definir as configurações de 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 de atividades em Noções básicas do conector.

As atividades de Consulta do Microsoft Dynamics 365 Business Central v2 podem ser usadas como origem com estes padrões de operação:

• Padrão de transformação
• Padrão de arquivo 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 a 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 execute a operação e validar o comportamento verificando os logs de operação.