Ir para o conteúdo

Atividade de Leitura do Jitterbit App Builder no Jitterbit Studio

Introdução

Uma atividade Leitura do Jitterbit App Builder, usando sua conexão do Jitterbit App Builder, recupera um ou mais itens de um objeto na aplicação Jitterbit App Builder e se destina a ser usada como uma fonte para fornecer dados em uma operação.

Se a fonte de dados da aplicação usar autorização baseada em funções, o usuário do App Builder que a conexão autentica deve ter a permissão de função Leitura no objeto selecionado.

Criar uma atividade de Leitura do Jitterbit App Builder

Uma instância de uma atividade Leitura do Jitterbit App Builder é criada a partir de uma conexão do Jitterbit App Builder usando seu tipo de atividade Leitura.

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, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade Leitura do Jitterbit App Builder existente pode ser editada a partir destes locais:

Configurar uma atividade de Leitura do Jitterbit App Builder

Siga estas etapas para configurar uma atividade Leitura do Jitterbit App Builder:

Etapa 1: Digite um nome e selecione um objeto

Nesta etapa, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface de usuário desta etapa é descrito abaixo.

  • Menu Endpoint: Se tiver vários endpoints do mesmo tipo de conector configurados, um menu na parte superior da tela exibe o nome do endpoint atual. Clique no menu para alternar para um endpoint diferente. Para mais informações, consulte Alterar o endpoint atribuído em Telas de configuração.

    • Editar endpoint: Aparece quando você passa o mouse sobre o nome do endpoint atual. Clique para editar a configuração de conexão do endpoint selecionado.
  • Nome: Digite um nome para identificar a atividade. O nome deve ser único para cada atividade Leitura do Jitterbit App Builder e não deve conter barras / ou dois-pontos :.

  • Selecione um Objeto: Esta seção exibe os objetos disponíveis na aplicação Jitterbit App Builder, obtidos do seu documento OpenAPI publicado. Um objeto nomeado após um recurso e um evento (por exemplo, Department(Approve)) representa um evento personalizado exposto através da API REST da aplicação. Para invocar um evento, use uma atividade Criar em vez disso.

    • Objeto Selecionado: Após um objeto ser selecionado, ele é listado aqui.
  • Pesquisa: Digite o nome de um objeto na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estão sendo exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada digitação.

  • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar os objetos do documento OpenAPI da aplicação. Isso pode ser útil se objetos foram adicionados à aplicação.

  • Selecionar um objeto: Na tabela, clique em qualquer lugar de uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. O Nome de cada objeto é obtido do documento OpenAPI da aplicação.

Dica

Se a tabela não for preenchida com os objetos disponíveis, a conexão do Jitterbit App Builder pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

  • 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 2: Selecionar uma operação

Nesta etapa, selecione uma operação para o objeto selecionado na etapa anterior. Cada elemento da interface do usuário desta etapa é descrito abaixo.

  • Selecionar uma operação: Esta seção exibe as operações disponíveis para o objeto selecionado. Para uma atividade de Leitura, duas operações estão disponíveis: uma que recupera um único item por identificador (por exemplo, "Obter um item '\'."), e uma que recupera a coleção completa de itens do objeto (por exemplo, "Obter a coleção '\'.").

    • Clique em qualquer lugar de uma linha para selecionar uma operação. Apenas uma operação pode ser selecionada.
  • Configurações opcionais: Clique para expandir configurações opcionais adicionais:

    • Continuar em caso de erro: Selecione para continuar processando os itens restantes em um lote quando um item falhar. Por padrão, esta opção não está selecionada, e a operação para no primeiro item que falha e relata a mensagem de erro do fornecedor. Quando esta opção está selecionada, cada item com falha é marcado como falho com a mensagem de erro do fornecedor, e os outros itens retornam seus resultados normais. Cada item na resposta inclui um campo isSuccess, um campo status (retornado como uma string vazia) e, para um item com falha, os campos errors.cause e errors.detailedMessage que descrevem a falha.
  • 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: Revisar os esquemas de dados

    Todos os esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

    • Esquemas de dados: Estes esquemas de dados são herdados pelas transformações adjacentes e são exibidos novamente durante o mapeamento de transformação. Os esquemas, nomeados readRequest e readResponse, são gerados automaticamente a partir do documento OpenAPI da aplicação.

      Apenas a operação de coleção retorna mais de um item, e retorna uma página de itens por chamada. O conector não recupera páginas adicionais automaticamente. Os campos $limit, $offset e $count aparecem nos esquemas junto com $filter e $sort, e você os mapeia como qualquer outro campo. Para recuperar todos os itens em uma coleção grande, chame a atividade em um loop: aumente $offset por $limit após cada chamada e pare quando uma chamada retornar menos itens que $limit ou quando $count mostrar que nenhum item permanece.

    • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para regenerar esquemas a partir do documento OpenAPI da aplicação. Esta ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

    • Editar: Clique no ícone de edição acima de cada esquema de dados para acessar o editor desse esquema. O editor permite adicionar, excluir e reorganizar nós e campos, além de alterar seus tipos de dados. Todos os nós e campos recém-adicionados são definidos com cardinalidade [0, 1] cardinalidade. As alterações feitas nos esquemas de dados devem ser compatíveis com o documento OpenAPI da aplicação e devem ser realizadas apenas após consultar a documentação de API da própria aplicação. Após editar esquemas, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema sofreu edições manuais. Atualizar os esquemas os redefinirá para suas estruturas padrão.

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

    Próximas etapas

    Após configurar uma atividade Read do Jitterbit App Builder, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Também é possível configurar as definições da operação, que incluem a capacidade de encadear operações que estão no mesmo fluxo de trabalho ou em fluxos diferentes.

    As ações de menu de uma atividade são acessíveis no painel do projeto e na tela de design. Para detalhes, consulte Menu de ações da atividade em Noções básicas do conector.

    As atividades Read do Jitterbit App Builder podem ser usadas como uma fonte com estes padrões de operação:

    Para usar a atividade com funções de script, escreva os dados em um local temporário e 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 de operação.