Criar uma operação de entidade de API

Introdução

Esta página descreve como criar uma operação de entidade de API. A entidade Jitterbit e a operação API Entity são usadas para criar uma API de serviço OData. Quando a operação API Entity for concluída, a operação será atribuída a uma API de serviço OData.

Criar uma operação de entidade de API

1. Abra seu projeto no aplicativo Design Studio. A tela Getting Started deve exibir:

   

   • O painel no lado esquerdo do Design Studio lista os itens do projeto que você usará para criar sua integração, como Operações, Transformações, Scripts, etc. Role para baixo no painel até Operações.
   • Clique com o botão direito do mouse em Operações e selecione Nova Operação no menu suspenso.

2. A janela pop-up Selecionar tipo exibe a lista de tipos de operação disponíveis no Design Studio. Selecione Operação de entidade de API na lista de opções e clique em Continuar:

   

3. A janela pop-up Entity Wizard deve ser exibida de forma semelhante à imagem mostrada abaixo. Uma Entidade define os dados disponíveis para um serviço OData e consiste em um endpoint, uma seleção de objetos e uma seleção de campos específicos. Qualquer entidade existente disponível dentro do projeto é listada abaixo da pasta Jitterbit Entities:

   

   • Criar nova entidade Jitterbit: Selecione esta opção se uma entidade não estiver disponível no projeto e não estiver listada no Assistente de entidade como mostrado acima. O Assistente de entidade então o guiará pela criação da entidade, selecionando as tabelas ou objetos e selecionando os campos. Siga as instruções descritas em Criar uma entidade Jitterbit à medida que você avança no Assistente de Entidades.
   • Use uma entidade Jitterbit existente no projeto: Você pode criar a entidade antes de criar sua operação seguindo as instruções em Criar uma entidade Jitterbit. Todas as entidades existentes disponíveis no seu projeto são listadas abaixo da pasta Jitterbit Entities na seção superior direita do Entity Wizard, conforme mostrado acima. Clicar em uma entidade existente na lista de entidades disponíveis seleciona automaticamente Use an existing Jitterbit Entity in the project.

   • Para este exemplo, a entidade Customers é selecionada. Clique em Next na parte inferior da tela para continuar:

     

4. A tela Transformações exibe:

   

   1. Transformações de passagem:

      • O Jitterbit cria uma operação de passagem por padrão.
      • Deixe as caixas de seleção Transformação de solicitação e Transformação de resposta em branco se um mapeamento personalizado não for necessário.

      • Neste exemplo, optamos pela transformação de passagem básica e não selecionamos nenhuma caixa de seleção:

        

      • Clique em Concluir na parte inferior da janela. A operação de passagem é criada e exibida na aba Operações do Design Studio:

        

   2. Preciso de mapeamentos personalizados em:

      • Solicitar Transformação: Clique na caixa de seleção se o mapeamento personalizado da solicitação for necessário.
      • Transformação de resposta: Clique na caixa de seleção se o mapeamento personalizado da resposta for necessário.

      • Neste exemplo, as caixas de seleção Transformação de Resposta e Transformação de Solicitação estão selecionadas:

        

      • O botão Next é ativado automaticamente. Clique em Next.

      • Uma mensagem de aviso é exibida no Assistente de Entidade: " A transformação personalizada só é suportada com Entidades GET ( APIs OData )".

      • Clique em Concluir na parte inferior da janela. A operação é criada e exibida no Design Studio com uma solicitação personalizada e uma transformação de resposta personalizada:

        

      • Clique com o botão direito do mouse na transformação Clientes - Solicitação e selecione Editar Clientes - Solicitação para abrir a tela de mapeamento de campos na aba Transformações. Você pode criar mapeamentos personalizados com scripts, conforme necessário:

        

      • Repita esta etapa na transformação Clientes - Resposta para mapear os campos de resposta adequadamente.

      • Após a conclusão do mapeamento, clique em Ícone Salvar na barra de ferramentas. Clique em Implementar ícone na barra de ferramentas para implantar o projeto inteiro no Harmony.

5. Próximo passo: Veja Configuração do serviço OData sobre o uso da nova entidade e da operação de entidade da API.