Atividade de Consulta do Epicor Prophet 21

Introdução

Uma atividade de Consulta do Epicor Prophet 21, utilizando sua conexão do Epicor Prophet 21, consulta dados de objetos no Epicor Prophet 21 e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta do Epicor Prophet 21

Uma instância de uma atividade de Consulta do Epicor Prophet 21 é criada a partir de uma conexão do Epicor Prophet 21 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 Epicor Prophet 21 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 Epicor Prophet 21

Siga estas etapas para configurar uma atividade de Consulta do Epicor Prophet 21:

• Etapa 1: Insira um nome e especifique as configurações
  Forneça um nome para a atividade e selecione um objeto.

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

• Etapa 3: Defina uma string de filtro
  Defina condições para uma consulta nos objetos filhos selecionados.

• Etapa 4: Revise os esquemas de dados
  Quaisquer esquemas de solicitação ou resposta são exibidos.

Passo 1: Insira um nome e especifique as configurações

Neste passo, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário deste passo é descrito abaixo.

• Nome: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade Query do Epicor Prophet 21 e não deve conter barras / ou dois pontos :.

• Selecionar Objeto: Esta seção exibe os objetos disponíveis no endpoint do Epicor Prophet 21.

  • 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 do Epicor Prophet 21. Isso pode ser útil se objetos foram adicionados ao Epicor Prophet 21. 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 Epicor Prophet 21:

    • Nome: O nome do objeto do Epicor Prophet 21.

    • Descrição: A descrição do objeto do Epicor Prophet 21.

  Dica

  Se a tabela não for preenchida com objetos disponíveis, a conexão Epicor Prophet 21 pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e testando novamente as credenciais.

• Propriedades HTTP Avançadas: Clique no ícone de adicionar para adicionar uma linha à tabela abaixo e insira um par chave-valor para cada parâmetro de solicitação.

  Para salvar a linha, clique no ícone de enviar na coluna mais à direita.

  Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de editar ou o ícone de excluir .

  Para excluir todas as linhas, clique em Limpar Tudo.

  Nota

  Se pares chave-valor foram especificados na conexão, eles serão usados em combinação com quaisquer pares chave-valor especificados nesta atividade.

  Importante

  Os campos na tabela Propriedades HTTP Avançadas exibem o ícone de variável apenas no modo de edição. Para que os valores de variável desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

  Os campos na tabela Propriedades HTTP Avançadas não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

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

Etapa 2: Selecionar objetos filhos

Neste passo, selecione quaisquer objetos filhos para consultar. Cada elemento da interface do usuário deste passo é descrito abaixo.

• Classes de Objetos: Esta seção exibe as classes de objetos filhos disponíveis e selecionadas para interagir com o endpoint do Epicor Prophet 21.

  • Objetos Filhos Disponíveis: Esta seção exibe uma lista de classes de objetos filhos disponíveis no Epicor Prophet 21.

    • 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 do Epicor Prophet 21. Isso pode ser útil se objetos foram adicionados ao Epicor Prophet 21. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

    • Adicionar um Objeto Filho: Dentro da coluna Objetos Filhos Disponíveis, 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: Após uma classe de objeto filho ser adicionada, ela é listada aqui.

    • Remover um Objeto Filho: Dentro da coluna Objeto Filho Selecionado, 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 deste passo e retornar ao passo anterior.

• Próximo: Clique para armazenar temporariamente a configuração deste passo e continuar para o próximo passo. A configuração não será salva até que você clique no botão Concluído no último passo.

• Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer passo. Uma mensagem pergunta se você deseja confirmar que deseja descartar as alterações.

Passo 3: Definir uma string de filtro

Neste passo, uma String de Filtro da consulta é definida usando os campos de objeto disponíveis e as configurações da consulta. Cada elemento da interface deste passo é descrito abaixo.

A interface utilizada neste passo da configuração de uma atividade de Consulta do Epicor Prophet 21 depende da aba selecionada:

• Básico: Esta opção permite construir a String de Filtro com campos guiados.

• Avançado: Esta opção oculta os campos guiados e permite modificar a String de Filtro diretamente.

Básico

Se a aba Básico estiver selecionada, a interface descrita abaixo é apresentada.

• 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 do endpoint do Epicor Prophet 21.

  • 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 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: Insira um tamanho de página para habilitar a paginação dos resultados. O número de resultados em uma página totalizará 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.

  • Busca de Texto Completo: Insira termos de busca para consultar objetos na classe de objeto selecionada. O endpoint do Epicor Prophet 21 lida com a forma como a busca é interpretada para uma classe de objeto.

  • Pular: Insira um número de resultados a serem pulados na resposta da consulta.

  • Top: Insira 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 dropdown para selecionar a classe de objeto a ser utilizada para a condicional.

    • Campo: Use o dropdown para selecionar o campo da classe de objeto a ser utilizado para a condicional.

    • Operador: Use o dropdown 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 dropdown anterior.

    • Remover: Clique no ícone de deletar para remover a condicional da tabela.

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

    • Remover Todos: Clique para remover todas as condicionais da tabela 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.

    Importante

    Devido a uma limitação na API Middleware do Epicor Prophet 21, se mais de um filtro estiver presente na String de Filtro, a operação falhará em tempo de execução.

• Test Query: Clique para validar a consulta.

• Back: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

• Next: 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 Finished na última etapa.

• Discard Changes: 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.

Advanced

Se a aba Advanced estiver selecionada, a interface descrita abaixo é apresentada.

• Page Size: Insira um tamanho de página para habilitar a paginação de 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.

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

    Importante

    Devido a uma limitação na API do Epicor Prophet 21 Middleware, se mais de um filtro estiver presente na Filter String, a operação falhará em tempo de execução.

• Test Query: 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 Advanced, a consulta deve ser válida e validada através deste botão para habilitar o botão Next.

• Back: 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 4: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta 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.

  A atividade Consulta do Epicor Prophet 21 utiliza esta API Middleware do Epicor Prophet 21:

  • Serviços de Dados (baseado na versão 4 do OData)

  Consulte a documentação da API para obter informações sobre os nós e campos do esquema. A documentação da API pode ser acessada através da sua conta do Middleware Epicor Prophet 21 usando esta URL:

  https://[YOUR_MIDDLEWARE_URL].com/docs/apiref.aspx (substitua [YOUR_MIDDLEWARE_URL] pela URL da sua instância do Middleware Epicor Prophet 21).

• Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do Epicor Prophet 21. 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.

• Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

• Concluído: Clique para salvar a configuração para 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 de Consulta do Epicor Prophet 21, 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 definiçõ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 de Consulta do Epicor Prophet 21 podem ser usadas como fonte com esses padrões de operação:

• Padrão de transformação
• Padrão de arquivo de dois alvos (apenas como a primeira fonte)
• Padrão de arquivo HTTP de dois alvos (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.