Crie uma Entidade Jitterbit¶

Introdução¶

Esta página descreve como criar e editar uma entidade Jitterbit. Uma entidade Jitterbit é usado para criar um Serviço OData. A entidade define um banco de dados ou endpoint SAP, tabelas e campos que fornecerão os dados para um Serviço OData.

Crie uma Entidade Jitterbit¶

1. Abra seu projeto no aplicativo Design Studio. A tela Introdução deve ser semelhante à imagem abaixo:

   

   • O painel do 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é Entidades Jitterbit.

   • Clique com o botão direito em Entidades Jitterbit e selecione Nova Entidade Jitterbit no menu suspenso.

2. Selecionar Nova entidade Jitterbit inicia o Digite tela no Jitterbit Entity Wizard:

   

   • Selecione Tipo de entidade Jitterbit:

     • Banco de dados: Selecione Banco de dados se os dados que você deseja acessar estiverem armazenados em um banco de dados como SQL Server, Oracle, MySQL, etc.
     • SAP: Selecione SAP se os dados que você deseja acessar estiverem armazenados em um sistema SAP.

   • Clique em Avançar na parte inferior da tela para continuar. Ao trabalhar no Jitterbit Entity Wizard, clique em Voltar em qualquer etapa para retornar à etapa anterior para fazer alterações ou clique em Cancelar para sair do assistente sem salvar a entidade.

3. A tela Endpoint no Jitterbit Entity Wizard deve ser exibida conforme mostrado abaixo. Esta tela oferece a opção de selecionar um endpoint existente ou criar um novo endpoint para a entidade. As telas e etapas para criar um novo endpoint são diferentes dependendo da seleção do banco de dados ou do SAP como tipo de entidade. Etapa 3.a. descreve as instruções para configurar um endpoint de banco de dados. Role para baixo até a etapa 3.b. para obter instruções sobre como configurar um endpoint SAP.

   1. Entidade de banco de dados: Se você selecionou banco de dados como o tipo de entidade, o assistente deverá exibir a tela Selecionar origem.

      

      1. Fontes disponíveis: Clique em Selecionar ou Criar novo para exibir a lista de fontes de banco de dados disponíveis em seu projeto.

         1. Selecione uma fonte de banco de dados existente na lista suspensa, se estiver disponível.
         2. Selecione Criar novo se a origem do banco de dados necessária não estiver disponível no projeto.

      2. Selecionar uma fonte de banco de dados existente deverá exibir a mesma tela mostrada abaixo, mas com os campos Parâmetros de Conexão já preenchidos. Nesse caso, clique em Avançar na parte inferior da tela para prosseguir para a tela Objeto no assistente. Role para baixo até a etapa 4 para continuar configurando a entidade.

      3. Selecionar Criar Novo deverá exibir os campos para criar uma nova fonte de banco de dados conforme mostrado na imagem abaixo. Neste caso, siga os passos descritos abaixo da imagem.

         

         • Nome: Insira um nome apropriado para o endpoint no campo Nome. O padrão é Nova Fonte.
         • Tipo: O tipo é selecionado automaticamente como Banco de dados com base na sua seleção na etapa anterior.
         • Parâmetros de conexão: As instruções para configurar uma fonte de banco de dados estão descritos em Fonte do banco de dados. Referências adicionais também estão disponíveis em Fontes e Destinos.
         • Depois que a origem do banco de dados estiver configurada, clique em Avançar na parte inferior da tela para continuar para a tela Objeto no assistente. Role para baixo até a etapa 4 para continuar configurando a entidade.

   2. Entidade SAP: Se você selecionou SAP como o tipo de entidade, o assistente deverá exibir a tela Selecionar o Endpoint SAP.

      

      1. Endpoints SAP disponíveis: Clique em Selecionar ou Criar novo para exibir a lista de endpoints SAP disponíveis em seu projeto.
         1. Selecione um endpoint SAP existente na lista suspensa, se estiver disponível.
         2. Selecione Criar novo se o endpoint SAP necessário não estiver disponível no projeto.
      2. Selecionar uma fonte SAP existente deverá exibir a mesma tela mostrada abaixo com os campos Parâmetros de Conexão já preenchidos. Nesse caso, clique em Avançar na parte inferior da tela para prosseguir para a tela Objeto no assistente. Role para baixo até a etapa 4 para continuar configurando a entidade.

      3. Selecionar Criar novo deverá exibir os campos para criar um novo endpoint SAP, conforme mostrado na imagem abaixo. Neste caso, siga os passos descritos abaixo da imagem.

         

         • Nome: Insira um nome apropriado no campo Nome. O padrão é Novo SAP Endpoint.
         • Parâmetros de conexão: As instruções para configurar um endpoint SAP estão descritos em SAP Connector Endpoint
         • Depois que o endpoint SAP estiver configurado, clique em Avançar na parte inferior da tela para continuar.

4. Depois que a origem do banco de dados ou o endpoint SAP tiver sido configurado, selecionar Próximo deverá exibir a tela Objeto no Jitterbit Entity Wizard. Esta etapa permite selecionar tabelas específicas em seu banco de dados ou endpoint SAP:

   

   • Nome Contém: Insira caracteres no campo Nome Contém para filtrar a consultar. No exemplo, inserimos KNA1 para filtrar tabelas de clientes. Deixe o campo Nome Contém em branco para visualizar todos os objetos ou tabelas disponíveis.
   • Tipo de objeto: Selecione Tipo de objeto na lista suspensa. Neste exemplo, Somente tabelas está selecionado.

   • Clique no botão para exibir a lista de objetos ou tabelas disponíveis:
     

     • Clique no Nome do objeto ou tabela na lista para criar o conjunto de dados necessário. Neste exemplo, é selecionada a tabela KNA1 que contém as informações do cadastro do cliente. Clique em próximo para continuar.

5. A tela Campos e Filtro no Jitterbit Entity Wizard deve ser exibida semelhante à imagem mostrada abaixo. Nesta etapa serão selecionados campos específicos para definir o conjunto de dados.

   

   • Localizar: Insira nomes de campo parciais ou completos no campo Localizar para exibir a lista de campos disponíveis em uma categoria específica. Deixe o campo Localizar em branco para exibir todos os campos disponíveis no objeto ou tabela selecionado anteriormente.
     • Clique na caixa de seleção associada para selecionar cada campo a ser incluído no conjunto de dados.
     • Você pode inserir vários nomes de campos no campo Localizar e selecionar vários campos de cada lista resultante. Neste exemplo, as palavras Cidade, Postal, Endereço, Nome, País e Cliente foram inseridas no campo Localizar e vários campos foram selecionados em cada lista.
   • Sempre mostrar campos selecionados: Clique nesta caixa de seleção para continuar a exibir todos os campos selecionados anteriormente enquanto você percorre várias listas de campos.
   • Selecionar tudo: Clique no botão Selecionar tudo para selecionar e incluir todos os campos contidos na tabela no conjunto de dados.
   • Desmarcar tudo: Clique no botão Desmarcar tudo para remover todos os campos contidos na tabela do conjunto de dados.
   • Filtro Base (Opcional): Você também pode inserir um filtro base específico para seu banco de dados ou sistema SAP na coluna direita da tela para filtrar seus dados.
   • Depois que todos os campos obrigatórios forem selecionados, clique em Avançar para continuar.

6. A tela Entidade JDML no Jitterbit Entity Wizard deve ser semelhante à imagem mostrada abaixo. Nesta etapa o nome da entidade é definido e o campo de ID primário é definido:

   

   • Jitterbit criou uma nova Entidade com base nas seleções anteriores.

   • Nome da Entidade: Insira o nome que você gostaria de usar no campo Nome da Entidade. Neste exemplo, a entidade é denominada Clientes.

     Nota

     O Nome da Entidade deve ser uma única palavra. Os consumidores que acessarem a API também poderão ver o nome.

   • ID: Clique na caixa de seleção associada para selecionar um campo como o campo ID primário e para ser a chave exclusiva que identifica a entidade ou o novo objeto. Neste exemplo, o campo Customer_1 é selecionado como chave exclusiva.

     Nota

     • Uma mensagem de erro pop-up é exibida se um campo de ID não estiver selecionado: "Não há nenhum campo de ID definido. Deseja continuar?" Clique em Continuar para fechar o popup e finalizar a entidade sem o ID definido ou clique em Cancelar para retornar à tela do assistente.
     • Se a entidade for concluída sem um campo de ID definido, um Status: Aviso será exibido no canto superior direito da tela Entidades do Jitterbit. A mensagem pop-up é: "Problemas de validação. Não há campo de ID definido."
     • Se os dados retornados incluírem registros duplicados com o mesmo valor de ID primário ou registros sem valores de ID primário, esses dados poderão ser ignorados em tempo de execução.

   • Clique em Concluir para continuar.

7. A aba Entidades Jitterbit é semelhante a esta imagem:

   

8. Próxima etapa: Para obter mais informações sobre como configurar um Serviço OData, consulte Configuração do Serviço OData.

Editar uma Entidade Jitterbit¶

1. Abra o projeto que contém a entidade em Design Studio.
2. Role para baixo no painel de itens do projeto no lado esquerdo do Design Studio para Entidades Jitterbit.
3. Clique com o botão direito no nome da entidade que deseja editar. Selecione Abrir no menu suspenso.

4. A aba Jitterbit Entities é semelhante a esta imagem:

   

5. Para alterar o ID primário, clique na caixa de seleção associada ao ID primário atual para primeiro desmarcar a caixa de seleção e remover o ID primário existente do conjunto de dados. Clique na caixa de seleção associada ao novo ID primário para definir o novo campo de ID no conjunto de dados.

6. Clique em Salvar ícone na barra de ferramentas no canto superior direito da aba Jitterbit Entities.

7. Para adicionar ou remover campos do conjunto de dados, clique no botão botão. A janela pop-up Selecionar campos é aberta:

   

   • Localizar: Insira nomes de campo parciais ou completos no campo Localizar para exibir a lista de campos disponíveis em uma categoria específica. Deixe o campo Localizar em branco para exibir todos os campos disponíveis no objeto ou tabela previamente selecionado.

     • Clique na caixa de seleção associada para selecionar cada campo a ser incluído no conjunto de dados.
     • Você pode inserir vários nomes de campos no campo Localizar e selecionar vários campos de cada lista resultante.

   • Caixa de seleção Sempre mostrar campos selecionados: Clique nesta caixa de seleção para continuar a exibir todos os campos selecionados anteriormente enquanto você percorre várias listas de campos.

   • Selecionar tudo: Clique no botão Selecionar tudo para selecionar e incluir todos os campos contidos na tabela no conjunto de dados.
   • Desmarcar tudo: Clique no botão Desmarcar tudo para remover todos os campos contidos na tabela do conjunto de dados.
   • Depois que todos os campos obrigatórios forem selecionados, clique em OK para fechar o pop-up.
   • Clique em Salvar ícone na barra de ferramentas no canto superior direito da aba Jitterbit Entities para salvar as alterações.