Atividade de Consulta do Microsoft Dynamics 365 Business Central v2

Introdução

Uma atividade de Consulta do Microsoft Dynamics 365 Business Central v2, utilizando sua conexão do Microsoft Dynamics 365 Business Central v2, recupera registros de uma entidade no Microsoft Dynamics 365 Business Central e é destinada a ser usada 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 de 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 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 de Consulta do Microsoft Dynamics 365 Business Central v2 existente 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 Consulta do Microsoft Dynamics 365 Business Central v2

Siga estas etapas para configurar uma atividade de Consulta do Microsoft Dynamics 365 Business Central v2:

• Passo 1: Insira um nome e selecione uma empresa e objeto
  Forneça um nome para a atividade e especifique a empresa e o objeto.

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

• Passo 3: Defina uma string de filtro
  O Construtor de Consultas é usado para definir condições em uma consulta usando os campos do objeto e aplicar paginação a uma consulta.

• Passo 4: Revise o esquema de dados
  Quaisquer esquemas de resposta gerados a partir do endpoint são exibidos.

Passo 1: Insira um nome e selecione uma empresa e objeto

Neste passo, forneça um nome para a atividade e especifique a empresa e o objeto. Cada elemento da interface do usuário deste passo é 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 atualizar ou na palavra Atualizar para recarregar a lista de empresas.

• Selecionar Objeto: Esta seção exibe os objetos disponíveis na empresa selecionada.

  • Objeto Selecionado: Após um objeto ser selecionado, ele é listado aqui.

  • Pesquisar: 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 são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos 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 objetos do endpoint. Isso pode ser útil se objetos foram adicionados ao Microsoft Dynamics 365 Business Central. Esta ação atualiza todos os metadados usados para construir 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 objetos disponíveis, a conexão pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e testando novamente as credenciais.

  Os objetos do Business Central devem ser publicados como Serviços Web para serem acessados via o conector. Para fazer isso, siga os passos descritos na documentação da Microsoft.

• Salvar & 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: Selecionar objetos filhos

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 consulta. Esta seção é opcional e pode ser pulada selecionando Próximo.

  • Objetos Filhos Disponíveis: Esta coluna exibe as classes de objetos filhos 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 são filtrados em tempo real a cada tecla pressionada. Para recarregar as classes de objetos filhos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualizar para recarregar as classes de objetos filhos do endpoint. Isso pode ser útil se classes de objetos filhos foram adicionadas ao Microsoft Dynamics 365 Business Central.

    • Adicionar 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 de adicionar para adicionar as classes selecionadas à coluna Objetos Filhos Selecionados.

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

    • Remover 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 de remover para retornar as classes selecionadas à coluna Objetos Filhos Disponíveis.

• 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 pede que você confirme que deseja descartar as alterações.

Etapa 3: Definir uma string de filtro

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

A String de Filtro pode ser configurada nas abas Básica ou Avançada.

• Básica: Permite construir a String de Filtro com campos guiados:

  

  • Campos de Objeto: Selecione os campos a serem usados na consulta com base na classe de objeto selecionada.

    • Pesquisar: Digite qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos para o objeto 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 objeto a partir do endpoint OData.

    • Selecionar Todos 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: Selecione as caixas de seleção dos campos que deseja incluir na consulta 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: Digite o número máximo de resultados a serem recuperados para cada página na resposta da consulta. 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 consulta como parte da resposta. Por exemplo, se uma consulta 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).

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

  • Top: Insira o número máximo de resultados a serem recebidos na resposta da consulta. 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 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
      Maior Que
      Maior Que ou Igual
      Menor Que
      Menor Que ou Igual

    • Valor: Insira o valor desejado para comparar com as seleções do menu suspenso anteriores.

    • Remover: Clique para remover a condicional.

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

    • Remover Tudo: Clique para remover todas as condicionais da tabela de Cláusulas Condicionais e da 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 selecionados, condições e opções de consulta.

• Avançado: Oculta os campos guiados e permite modificar a String de Filtro diretamente:

  

  • Tamanho da Página: Insira o número máximo de resultados a serem recuperados para cada página na resposta da consulta. Se deixado em branco, cada página conterá 100 resultados.

    Nota

    Se a paginação do lado do cliente for necessária, use as opções de consulta $skip e $top no campo String de Filtro.

  • String de Filtro: Edite a declaração da string de filtro diretamente.

• Testar Consulta: Clique para validar a consulta. 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.

  Nota

  Um erro pode 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 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 pede que você confirme que deseja descartar as alterações.

Etapa 4: Revisar 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 Microsoft Dynamics 365 Business Central v2 utiliza 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 atualizar ou na palavra Atualizar para regenerar esquemas a partir 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 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.

Próximas etapas

Após configurar uma atividade de Consulta do Microsoft Dynamics 365 Business Central v2, 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.

Atividades de Consulta do Microsoft Dynamics 365 Business Central v2 podem ser usadas como fonte com esses padrões de operação:

• Padrão de transformação
• Padrão de arquivo com dois destinos (apenas como a primeira fonte)
• Padrão de arquivo HTTP com dois destinos (apenas como a primeira fonte)
• Padrão de duas transformações (apenas como a primeira fonte)

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.