Configurar o Salesforce Connect para Consumir uma API de Serviço OData¶
Introdução¶
Esta página descreve como instalar e configurar o Salesforce Connect (anteriormente Salesforce Lightning Connect) para consumir com segurança uma API de Serviço OData e exibir os dados em tempo real. O exemplo mostrado exporá e exibirá dados de uma fonte SAP usando o protocolo OData 2.0.
Pré-requisitos
- Sua organização Salesforce deve ser provisionada para acessar os módulos Salesforce Connect, incluindo fontes de dados externas e objetos externos.
- Criar um novo projeto no Design Studio.
- Criar uma entidade Jitterbit em Design Studio.
- Criar uma operação de entidade API no Design Studio.
- Configuração do Serviço OData em API Manager.
Criando uma Fonte de Dados Externa e um Objeto Externo no Salesforce¶
-
Faça login em sua organização do Salesforce. No painel do lado esquerdo da página, role para baixo até Build, selecione Develop e selecione External Data Sources. Você precisará acessar esses recursos para configurar o Salesforce Connect. Se você não tiver acesso a esses recursos, entre em contato com seu representante da Salesforce:
-
Clique no botão Nova fonte de dados externa:
-
Os campos obrigatórios exibem uma barra vertical vermelha à esquerda do campo.
-
Fonte de dados externa: Insira o Nome da API do Serviço OData no campo Fonte de dados externa.
-
Nome: Pressione a tecla Tab. O campo Nome é preenchido automaticamente com o nome da API do Serviço OData. A Fonte de dados externa e o Nome da API podem ser iguais.
-
Tipo: Clique no campo Tipo e selecione Salesforce Connect: OData 2.0 na lista suspensa.
Nota
Harmony atualmente suporta apenas OData 2.0.
-
URL: Insira ou cole o URL completo de sua API de Serviço OData no campo URL. (No Minhas APIs página em API Manager, passe o mouse sobre o ficha da API e clique no link Copiar URL.)
Nota
Certifique-se de que o URL comece com HTTPS (e não HTTP). Se você estiver usando um URL HTTP, os dados não serão protegidos quando solicitados e enviados de volta ao Salesforce.
-
Objetos externos graváveis:
- Marque esta caixa se quiser permitir que o Salesforce POST, PUT, DELETE ou MERGE dados no SAP ou fonte de banco de dados usando a API de Serviço OData. Nesse caso, várias operações serão atribuídas à API às quais são atribuídos um ou mais desses métodos.
- Deixe esta caixa desmarcada para acesso somente leitura. Nesse caso, o método de operação na API do Serviço OData deve ser definido como GET.
-
Identity Type: Clique neste campo e selecione Named Principal na lista suspensa se você tiver perfis atribuídos à API e se quiser usar um nome central para todos os seus Usuários do Salesforce.
-
Protocolo de autenticação: Clique neste campo e selecione o Protocolo de autenticação apropriado na lista suspensa com base no perfil de segurança atribuído à API.
- Campos adicionais são exibidos dependendo do protocolo selecionado.
- No exemplo mostrado acima, Autenticação de senha foi selecionada e os campos Nome de usuário e Senha foram exibidos. Insira o Nome de usuário e a Senha apropriados.
-
Clique em Salvar.
-
-
Role para baixo até a seção Autenticação. Clique no botão Validar e sincronizar:
-
A página Validate External Data Source é exibida:
- Clique na caixa de seleção apropriada para selecionar o Nome da tabela. Neste exemplo, Clientes foi selecionado.
- Clique no botão Sincronizar para verificar a URL, validar se o formato é aceitável e criar automaticamente um novo Objeto externo no Salesforce.
-
Role para baixo até a seção Autenticação:
- A seção Objetos Externos exibe o novo Objeto Externo que você criou.
- Os objetos externos do Salesforce são semelhantes a outros objetos personalizados, exceto que os dados não são armazenados no Salesforce. Os dados são recuperados em tempo real da fonte de dados. O objeto externo oferece suporte a APIs e outras personalizações. Ao usar um objeto externo, lembre-se de sempre fornecer um filtro para refinar os dados.
- Consulte a documentação do Salesforce Definir objetos externos para obter informações adicionais sobre objetos externos do Salesforce.
Criando uma Nova Guia Personalizada no Salesforce¶
-
No painel do lado esquerdo da página, role para baixo até Criar, selecione Criar e selecione Guias:
-
Role para baixo até a seção Guias de objetos personalizados e clique em Novo para criar uma nova aba no Salesforce:
-
Nova guia Objeto personalizado, Etapa 1 de 3:
- Objeto: Clique no campo Objeto e selecione o novo objeto externo que você criou na lista suspensa. Neste exemplo, Clientes foi selecionado.
- Tab Style: Clique no campo Tab Style para exibir um pop-up contendo opções de estilo. Selecione um estilo de aba no pop-up.
- Descrição: Insira uma breve descrição do objeto externo.
- Clique em Avançar.
-
Nova guia Objeto personalizado, Etapa 2 de 3:
- Personalize a visibilidade da guia com perfis conforme desejado. Neste exemplo, Tab Visibility está definido como Default On para todos os perfis.
- Clique em Avançar.
-
Nova guia de objeto personalizado, Etapa 3 de 3:
- Selecione os Aplicativos personalizados para os quais a nova aba personalizada estará disponível clicando nas caixas de seleção associadas. Todos os aplicativos estão incluídos no exemplo acima.
- Clique em Salvar.
-
Clique em Home na barra de ferramentas superior:
- Se sua nova aba não for exibida automaticamente, clique no sinal de mais no lado direito da barra de ferramentas para listar todas as guias.
- Clique na nova aba que você criou (neste exemplo Clientes).
- Clique em Create New View
- Personalize a Visualização conforme desejado. Insira um Nome para a exibição.
- Clique em Salvar.
-
No exemplo mostrado na imagem abaixo, a exibição Clientes nos EUA é definida para exibir todos os clientes em que País = EUA:
- Os dados são recuperados em tempo real e não estão sendo armazenados no Salesforce.
- Você pode detalhar para obter mais detalhes ou alterar os filtros conforme necessário.
- Harmony API Manager continuará atendendo às solicitações em tempo real e trabalhando em conjunto com o Salesforce Connect para fornecer acesso aos dados.
Recursos Adicionais do Salesforce Connect¶
Esses recursos da documentação do Salesforce podem ser úteis: