Criar uma Operação de Entidade de API¶

Introdução¶

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

Criando uma Operação de Entidade de API¶

1. Abra seu projeto no aplicativo Design Studio. A tela Introdução 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 API Entity Operation na lista de opções e clique em Continue:

   

3. A janela pop-up Entity Wizard deve ser 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 no projeto está listada abaixo da pasta Jitterbit Entities:

   

   • Create new Jitterbit Entity: Selecione esta opção se uma entidade não estiver disponível no projeto e não estiver listada no Entity Wizard como mostrado acima. O Assistente de Entidade orienta você na criação da entidade, na seleção das tabelas ou objetos e na seleção dos campos. Siga as instruções descritas em Criando uma entidade Jitterbit conforme você continua no Entity Wizard.
   • Use uma Entidade Jitterbit existente no projeto: Você pode criar a entidade antes de criar sua operação seguindo as instruções em Criando uma Entidade Jitterbit. Quaisquer entidades existentes disponíveis em seu projeto estã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 Usar uma entidade Jitterbit existente no projeto.

   • Para este exemplo, a entidade Clientes é selecionada. Clique em Avançar na parte inferior da tela para continuar:

     

4. A tela Transformações exibe:

   

   1. Transformações Pass-Through:

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

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

        

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

        

   2. Preciso de mapeamentos personalizados em:

      • Request 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 Response Transformação e Request Transformação estão selecionadas:

        

      • O botão Avançar é ativado automaticamente. Clique em Avançar.

      • Uma mensagem de aviso é exibida no Entity Wizard: " A transformação personalizada só é compatível com GET Entities (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 campo na aba Transformações. Você pode criar mapeamentos personalizados com script conforme necessário:

        

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

      • Uma vez concluído o mapeamento, clique no Ícone Salvar na barra de ferramentas. Clique em Deploy na barra de ferramentas para implantar todo o projeto no Harmony.

5. Próxima etapa: Consulte Configuração do Serviço OData ao usar a nova entidade e operação de entidade API.