Ir para o conteúdo

Atividade de Consulta SugarCRM v2

Introdução

Uma atividade de Consulta SugarCRM v2, utilizando sua conexão SugarCRM v2, recupera dados de objetos do SugarCRM e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta SugarCRM v2

Uma instância de uma atividade de Consulta SugarCRM v2 é criada a partir de uma conexão SugarCRM 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 SugarCRM v2 existente pode ser editada a partir destes locais:

Configurar uma atividade de Consulta SugarCRM v2

Siga estas etapas para configurar uma atividade de Consulta SugarCRM v2:

Etapa 1: Insira um nome e selecione um objeto

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 exclusivo para cada atividade de Consulta do SugarCRM v2 e não deve conter barras / ou dois pontos :.

  • Selecionar um objeto: Esta seção exibe os objetos disponíveis no endpoint do SugarCRM v2.

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

    • Selecionando um objeto: Dentro da 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 SugarCRM v2:

      • Nome: O nome do objeto do SugarCRM.

    Dica

    Se a tabela não for preenchida com objetos disponíveis, a conexão do SugarCRM v2 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 deste passo e fechar a configuração da atividade.

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

Etapa 2: Selecionar objetos filhos

Nesta etapa, selecione objetos filhos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

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

    • Objetos filhos disponíveis: Esta seção exibe uma lista de classes de objetos filhos disponíveis no endpoint do SugarCRM.

      • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos filhos. A pesquisa não diferencia maiúsculas de minúsculas. 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 SugarCRM. Isso pode ser útil se objetos foram adicionados ao endpoint do SugarCRM. 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 para selecionar um ou mais objetos filhos. Em seguida, clique no ícone de adicionar para adicionar os objetos filhos à 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 para selecionar um ou mais objetos filhos. Em seguida, clique no ícone de remover para retornar as classes selecionadas à coluna Objetos Filhos Disponíveis.

Etapa 3: 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 Query do SugarCRM v2 utiliza a API REST do SugarCRM na versão selecionada na configuração de conexão. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

    A atividade Query do SugarCRM v2 suporta dois tipos de expressões que permitem aos usuários agrupar ou filtrar os resultados da consulta:

    • Sub-expressões permitem agrupar os resultados da consulta usando grupos AND e OR. Os tipos de sub-expressão aceitos são $and e $or. Para usar uma sub-expressão, forneça seu valor no campo expression da solicitação.

    • Operadores permitem realizar operações e comparações para filtrar os resultados da consulta. Para usar um operador, forneça seu valor no campo operator da solicitação. Os seguintes operadores são suportados:

      Operação Descrição
      $equals Realiza uma correspondência exata nesse campo.
      $not_equals Realiza uma correspondência exata nesse campo.
      $not_equals Corresponde a valores não correspondentes.
      $starts Corresponde a qualquer coisa que comece com o valor.
      $ends Corresponde a qualquer coisa que termine com o valor.
      $contains Corresponde a qualquer coisa que contenha o valor.
      $in Encontra qualquer coisa onde o campo corresponda a um dos valores especificados como um array.
      $not_in Encontra qualquer coisa onde o campo não corresponda a nenhum dos valores especificados como um array.
      $is_null Verifica se o campo é nulo. Esta operação não precisa de um valor especificado.
      $not_null Verifica se o campo não é nulo. Esta operação não precisa de um valor especificado.
      $lt Corresponde quando o campo é menor que o valor.
      $lte Corresponde quando o campo é menor ou igual ao valor.
      $gt Corresponde quando o campo é maior que o valor.
      $gte Corresponde quando o campo é maior ou igual ao valor.

  • Editar: Clique no ícone de edição para entrar no modo de edição do esquema de resposta. O editor permite adicionar, excluir e reorganizar nós e campos, além de alterar seus tipos de dados. Todas as ocorrências de nós e campos são definidas como [0, 1] cardinalidade. As alterações feitas no esquema de dados de resposta devem ser aceitáveis para o endpoint e devem ser feitas somente 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 irá redefini-los para suas estruturas padrão.

  • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para regenerar esquemas a partir do endpoint SugarCRM v2. 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 para esta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

Próximas etapas

Após configurar uma atividade Consulta do SugarCRM 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 Consulta do SugarCRM v2 podem ser usadas como uma fonte com esses padrões de operação:

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.