Detalhes da Conexão do SAP Gateway¶

Introdução¶

Versão do conector

Esta documentação é baseada na versão 21.0.8257 do conector.

Começando¶

Suporte à versão SAP Gateway

O conector aproveita a API do SAP Gateway para habilitar o acesso bidirecional aos serviços SAP que usam o gateway. Isso inclui, entre outros, S/4 HANA, S/4 HANA Cloud, ERP e qualquer outra edição compatível com o SAP Gateway.

Estabelecendo uma Conexão¶

Conectando-se ao SAP Gateway¶

Defina as seguintes propriedades de conexão para acessar as tabelas do SAP Gateway.

• URL: Defina isso para a URL do seu ambiente ou para a URL completa do serviço. Por exemplo, o URL completo pode aparecer como: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. Neste exemplo, a URL do ambiente seria apenas: https://sapes5.sapdevcenter.com.
• Namespace: Defina o namespace de serviço apropriado. No exemplo acima, IWBEP é o namespace. É opcional se o URL completo para o serviço for especificado.
• Service: Defina isso para o serviço do qual você deseja recuperar dados. No exemplo acima, o serviço é GWSAMPLE_BASIC. Não é necessário se o URL completo for especificado.

Autenticação no SAP Gateway¶

O SAP Gateway permite autenticação básica e OAuth 2.0. Você pode usar autenticação básica para se conectar à sua própria conta ou pode usar OAuth para permitir que outros usuários recuperem dados de seu serviço com suas contas.

Autenticar Usando Autenticação Básica¶

Na autenticação básica, você usa suas credenciais de login para se conectar. Defina as seguintes propriedades:

• AuthScheme: Defina como Básico.
• User: Este é o nome de usuário que você usa para fazer login no SAP Gateway.
• Password: Esta é a senha que você usa para fazer login no SAP Gateway.

Autenticar Usando Autenticação OAuth¶

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Definir InitiateOAuth para GETANDREFRESH para evitar repetir a troca OAuth e definir manualmente o OAuthAccessToken.

Quando você se conecta, o conector abre o endpoint SAP Gateway OAuth em seu navegador padrão. Faça login e conceda permissões ao conector. O conector conclui o seguinte processo OAuth:

1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
2. Obtém um novo token de acesso quando o antigo expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Consulte Usando autenticação OAuth para outros fluxos de autenticação OAuth.

Autenticar Usando Chave de API¶

Para se conectar usando um ApiKey, defina o APIKey propriedade e você está pronto para se conectar.

Para adquirir um APIKey, abra o Portal do Desenvolvedor e selecione o Produto ou Serviço para o qual você publicou a API. Em seguida, clique em Assinar > Criar uma nova aplicação. Após preencher as informações necessárias e criar o aplicativo, a Chave do aplicativo será exibida. Você pode copiar este valor no APIKey propriedade de conexão.

Você pode definir o AuthScheme para Token para impor o esquema de autenticação baseada em token.

Usando Autenticação OAuth¶

OAuth requer que o usuário autenticado interaja com o SAP Gateway usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Personalizadas¶

Você pode registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.
NOTE : A senha que você escolhe ao criar um usuário de serviço, conforme explicado em Criando um aplicativo OAuth personalizado, deve ser fornecido via OAuthClientSecret propriedade.

Quando Criar um Aplicativo OAuth Personalizado¶

Você precisa criar um aplicativo OAuth personalizado para se conectar ao SAP Gateway.

Criando um Aplicativo OAuth Personalizado¶

Consulte Criando um aplicativo OAuth personalizado para obter informações sobre como criar um aplicativo personalizado.

Credenciais Personalizadas¶

Quando Usar um Aplicativo OAuth Personalizado¶

A criação de um aplicativo OAuth personalizado é necessária em todos os casos ao se conectar via OAuth.

Autenticação de Desktop com um Aplicativo OAuth Personalizado¶

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado Para maiores informações.

Obtenha e Atualize o Token de Acesso OAuth¶

Depois de definir o seguinte, você está pronto para se conectar:

• OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• Scope: Defina isso para as permissões que você especificou durante Creating a Custom OAuth App.
• CallbackURL: Defina isso para o URI de redirecionamento definido quando você registrou seu aplicativo.
• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

1. Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
2. Atualiza o token de acesso quando ele expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça¶

Usando OAuth em uma Máquina Sem Cabeça¶

Para criar fontes de dados do SAP Gateway em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa autenticar de outra máquina. A autenticação é um processo de duas etapas.

1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais para um Aplicativo OAuth Personalizado¶

Crie um aplicativo OAuth personalizado

A criação de um aplicativo OAuth personalizado é necessária no fluxo OAuth headless.

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Defina as seguintes propriedades na máquina sem periféricos:

• InitiateOAuth: Defina como DESLIGADO.
• OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
• Scope: Defina isso para as permissões que você especificou durante Creating a Custom OAuth App.

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

1. Chame o GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• Scope: Defina isso para as permissões que você especificou durante Creating a Custom OAuth App.
• OAuthVerifier: Defina isso para o código do verificador.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InitiateOAuth: Configure para ATUALIZAR.

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• Scope: Defina isso para as permissões que você especificou durante Creating a Custom OAuth App.
• OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
• InitiateOAuth: Configure para ATUALIZAR.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

• OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
• InitiateOAuth: Defina como GETANDREFRESH.
• OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• Scope: Defina isso para as permissões que você especificou durante Creating a Custom OAuth App.
• CallbackURL: Defina isso para o URI de redirecionamento que você especificou nas configurações do aplicativo.

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

• InitiateOAuth: Defina como REFRESH.
• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• Scope: Defina isso para as permissões que você especificou durante Creating a Custom OAuth App.
• OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

Criando um Aplicativo OAuth Personalizado¶

Quando Criar um Aplicativo OAuth Personalizado¶

A criação de um aplicativo OAuth personalizado é necessária em todos os casos.

Para criar um aplicativo OAuth personalizado, siga as etapas neste artigo, Registro de cliente OAuth 2.0

Observação: O URL de redirecionamento precisa ser definido como https://oauth.cdata.com/oauth/ no fluxo do APP AuthMode.

Anotações Importantes¶

Procedimentos Armazenados¶

• Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
• Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.

Arquivos de Configuração e Seus Caminhos¶

• Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.

Características Avançadas¶

Esta seção detalha uma seleção de recursos avançados do conector SAP Gateway.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário¶

O Jitterbit Connector for SAP Gateway permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

• Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
• declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração¶

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

• Cada elemento raiz define o nome de uma exibição.
• Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário¶

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário¶

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL¶

Personalizando a Configuração SSL¶

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados¶

O Jitterbit Connector para SAP Gateway modela entidades SAP Gateway em tabelas relacionais, exibições e procedimentos armazenados. As definições de tabela são obtidas dinamicamente do serviço OData ao qual você se conecta. Quaisquer alterações nos metadados, como colunas adicionadas ou removidas ou alterações no tipo de dados, podem ser carregadas pela reconexão.

Mesas

O conector modela os conjuntos de entidades graváveis e singletons descritos no documento de metadados do serviço como Tabelas.

Visualizações

Algumas entidades OData só podem ser acessadas por meio de Propriedades de navegação. Por padrão, o conector modela as propriedades de navegação como exibições separadas. Consulte Visualizações para obter mais informações sobre como consultar propriedades de navegação.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para a fonte de dados. Eles podem ser usados para pesquisar, atualizar e modificar informações na fonte de dados.

Tabelas¶

O conector expõe tabelas para cada conjunto de entidades e singleton definido no documento de serviço OData. As entidades nessas tabelas podem ser inseridas, atualizadas ou excluídas usando as instruções SQL padrão insert, update ou delete.

Executando Inserções Profundas com SQL¶

O conector oferece suporte a inserções profundas de OData, nas quais você cria simultaneamente uma entidade base e a vincula a entidades relacionadas, especificando as propriedades de navegação. Para especificar Propriedades de navegação para uma entidade, você cria uma tabela temporária para a propriedade de navegação e faz referência à tabela temporária na inserção para a tabela base. Faça referência à tabela temporária na coluna de propriedades de navegação apropriada na tabela base. Cada coluna de propriedade de navegação é prefixada com a palavra "Linked".

Observe que você deve definir as tabelas temporárias e inserir na entidade base dentro da mesma conexão.

Exemplo: Deep Inserts no SAP Gateway¶

Por exemplo, considere o serviço GWSAMPLE_BASIC. Em GWSAMPLE_BASIC, existe uma tabela SalesOrder. Ao criar um SalesOrder, você deve especificar um novo SalesOrderLineItem e um BusinessPartner existente. Para fazer isso, você pode especificar as seguintes propriedades de navegação.

Criando Tabelas Temporárias¶

Insira as entidades relacionadas em tabelas temporárias que correspondem a cada propriedade de navegação. Você pode especificar a chave primária de uma entidade existente ou inserir uma nova entidade.

• SalesOrderLineItems: As instruções a seguir adicionam dois SalesOrderLineItems ao SalesOrder:

  INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P001', 15)
  
  INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P002', 10)
  

• BusinessPartners: A seguinte declaração especifica o BusinessPartner existente:

  INSERT INTO BusinessPartners#TEMP (BusinessPartnerID)
  VALUES ('BP001')
  

Observação: BusinessPartner também pode ser especificado por meio da propriedade CustomerID diretamente no SalesOrder. Este exemplo não está usando essa coluna devido à possibilidade de que uma chave estrangeira adequada nem sempre esteja disponível.

O Jitterbit Connector for SAP Gateway assumirá que o BusinessPartner já existe e vinculará apenas às referências existentes, pois apenas as chaves primárias foram especificadas. Quando mais do que apenas a chave primária é definida, como o exemplo para SalesOrderLines, o Jitterbit Connector for SAP Gateway tentará criar novas entradas - acionando a inserção profunda.

Inserindo a Entidade¶

Na instrução INSERT da entidade base, faça referência às tabelas temporárias nas colunas LinkedToLineItems e LinkedToBusinessPartner:

INSERT INTO SalesOrders (Note, LinkedToLineItems, LinkedToBusinessPartner)
VALUES ('New sales order', 'SalesOrderLineItems#TEMP', 'BusinessPartners#TEMP')

Exemplo de Código¶

Abaixo está o código completo para criar o novo ExternalUser:

Connection conn = DriverManager.getConnection(connectionStr);
Statement stat = conn.createStatement();
stat.executeUpdate("INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P001', 15)");

stat.executeUpdate("INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P002', 10)");

stat.executeUpdate("INSERT INTO BusinessPartners#TEMP (BusinessPartnerID) VALUES ('BP001')");

stat.executeUpdate("INSERT INTO SalesOrders (Note, LinkedToLineItems, LinkedToBusinessPartner) VALUES ('New sales order', 'SalesOrderLineItems#TEMP', 'BusinessPartners#TEMP')");

stat.close();

Visualizações¶

Propriedades de Navegação de Modelagem¶

Por padrão, o conector modela Propriedades de navegação como exibições separadas. As exibições são nomeadas no formato ParentTable_NavigationProperty.

Consultar Propriedades de Navegação¶

Para obter um exemplo de como trabalhar com uma propriedade de navegação como exibição, considere o serviço GWSAMPLE_BASIC. A entidade SalesOrder tem a propriedade de navegação ToLineItems. O Jitterbit Connector for SAP Gateway exibirá uma exibição chamada SalesOrders_ToLineItems. A recuperação de dados de SalesOrders_ToLineItems exibirá os objetos SalesOrderLineItems associados a um determinado SalesOrder. A exibição SalesOrders_ToLineItems tem uma chave primária composta pelo ID da entidade pai e pelo ID da entidade relacionada.

Observe que o serviço de amostra GWSAMPLE_BASIC também contém chaves estrangeiras diretamente em cada entidade, como um SalesOrderID diretamente na tabela SalesOrderLineItems. Nesse caso, o mesmo efeito pode ser obtido simplesmente recuperando os dados da tabela SalesOrderLineItems diretamente. No entanto, não é um requisito no OData ter essas chaves estrangeiras, nem é uma garantia de que cada propriedade de navegação será exposta individualmente como sua própria tabela. Como não há como saber de antemão o que pode estar exposto em seu próprio endpoint, o Jitterbit Connector for SAP Gateway exibirá a visualização e a tabela. Em geral, é melhor usar tabelas quando disponíveis e exibições somente quando necessário (ou seja: nenhuma tabela é exibida ou nenhuma chave estrangeira pode ser usada para identificar relacionamentos).

Propriedades de Navegação¶

Em OData, uma propriedade de navegação é uma propriedade em uma entidade que é uma única entidade ou uma lista de entidades.

Uma propriedade de navegação de entidade única significa um relacionamento um-para-um. Por exemplo, considere o endpoint SAP Gateway GWSAMPLE_BASIC. O ProductSet contém uma propriedade de navegação ToSupplier, que faz referência a uma única entidade BusinessPartner.

Uma propriedade de navegação do conjunto de entidades significa um relacionamento um-para-muitos. Por exemplo, considere o endpoint SAP Gateway GWSAMPLE_BASIC. O ProductSet contém uma propriedade de navegação ToSalesOrderLineItems, que faz referência a muitos objetos SalesOrderLineItem.

Trabalhando com Propriedades de Navegação Relacionalmente¶

Propriedades de navegação em entidades relacionadas ao link OData. Da mesma forma, em um banco de dados relacional, uma chave estrangeira serve para vincular tabelas. Por exemplo, o registro SalesOrderLineItem contém a coluna ProductID, que identifica exclusivamente qual produto o SalesOrderLineItem está usando.

Selecione¶

Ele pode ser usado para recuperar entidades associadas. Consulte Visualizações para obter mais informações sobre como consultar propriedades de navegação.

Inserir¶

O conector oferece suporte a inserções profundas de OData. Veja Tabelas para obter mais informações sobre como especificar propriedades de navegação ao criar uma entidade.

Procedimentos Armazenados¶

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Jitterbit Connector para SAP Gateway Stored Procedures¶

GetOAuthAccessToken¶

Obtém o token de acesso OAuth do SAPGateway.

Entrada¶

Colunas do Conjunto de Resultados¶

GetOAuthAuthorizationURL¶

Obtém o URL de autorização do SAPGateway. Acesse a URL retornada na saída em um navegador da Web. Isso solicita o token de acesso que pode ser usado como parte da string de conexão para SAPGateway.

Entrada¶

Colunas do Conjunto de Resultados¶

RefreshOAuthAccessToken¶

Atualiza o token de acesso OAuth usado para autenticação com SAPGateway.

Entrada¶

Colunas do Conjunto de Resultados¶

Tabelas do Sistema¶

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema¶

As tabelas a seguir retornam metadados de banco de dados para SAP Gateway:

• sys_catalogs: Lista os bancos de dados disponíveis.
• sys_schemas: Lista os esquemas disponíveis.
• sys_tables: Lista as tabelas e exibições disponíveis.
• sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
• sys_procedures: Descreve os procedimentos armazenados disponíveis.
• sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
• sys_keycolumns: Descreve as chaves primárias e estrangeiras.
• sys_indexes: Descreve os índices disponíveis.

Tabelas de Fonte de Dados¶

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

• sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
• sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações¶

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

• sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs¶

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs

Colunas¶

Sys_schemas¶

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas

Colunas¶

Sys_tables¶

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables

Colunas¶

Sys_tablecolumns¶

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela SampleTable_1:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1' 

Colunas¶

Sys_procedures¶

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures

Colunas¶

Sys_procedureparameters¶

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado SampleProcedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Colunas¶

Sys_keycolumns¶

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela SampleTable_1:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'

Colunas¶

Sys_foreignkeys¶

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Colunas¶

Sys_indexes¶

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Colunas¶

Sys_connection_props¶

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:sapgateway:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''

Colunas¶

Sys_sqlinfo¶

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento de Consultas Colaborativas¶

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os Recursos SELECT da Fonte de Dados¶

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas¶

Sys_identity¶

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity

Colunas¶

Propriedades de Configurações Avançadas¶

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

Autenticação

OAuth

SSL

Esquema

Diversos

Autenticação¶

Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.

AuthScheme¶

O tipo de autenticação a ser usado ao conectar-se ao SAP Gateway.

Valores Possíveis¶

Auto, OAuth, Basic, Token

Tipo de Dados¶

string

Valor Padrão¶

"Auto"

Observações¶

• Auto: permite que o driver decida automaticamente com base nas outras propriedades de conexão que você definiu.
• OAuth: Defina para executar a autenticação OAuth.
• Básico: Defina para usar a autenticação de usuário/senha BÁSICA.
• Token: Defina para autenticar usando uma APIKey.

URL¶

Defina isso para a URL do seu ambiente SAP Gateway ou para a URL completa do serviço OData.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Defina isso para a URL do seu ambiente SAP Gateway ou para a URL completa do serviço OData.

Namespace¶

Especifique o namespace de serviço do qual você deseja recuperar dados. Isso é necessário se o serviço não for especificado na URL.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Especifique o namespace do qual você deseja recuperar dados. Por exemplo, no serviço OData externo, http://services.odata.org/Northwind/Northwind.svc/, 'Northwind' é o namespace do serviço. Isso é necessário se o serviço não for especificado na URL.

Serviço¶

Especifique o serviço do qual você deseja recuperar dados. Isso é necessário se o serviço não for especificado na URL.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Especifique o serviço do qual você deseja recuperar dados. Isso é necessário se o serviço não for especificado na URL.

Do Utilizador¶

A conta de usuário do SAP Gateway usada para autenticação.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Juntamente com Senha, este campo é usado para autenticação no servidor SAP Gateway.

Senha¶

A senha usada para autenticar o usuário.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

O usuário e Password são usados juntos para autenticar com o servidor.

Chave API¶

Defina isso como a chave do aplicativo que você criou. Se você definir isso, o usuário e a senha não serão usados para autenticação.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Defina isso como a chave do aplicativo que você criou. Se você definir isso, o usuário e a senha não serão usados para autenticação.

OAuth¶

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

InitiateOAuth¶

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis¶

OFF, GETANDREFRESH, REFRESH

Tipo de Dados¶

string

Valor Padrão¶

"OFF"

Observações¶

As seguintes opções estão disponíveis:

1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId¶

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret¶

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken¶

O token de acesso para conexão usando OAuth.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

URL de Retorno¶

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno de chamada especificado nas configurações do aplicativo.

Escopo¶

Os escopos de permissão em valores separados por espaço. Isso é necessário ao autenticar por meio do fluxo OAuth2.0.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Os escopos de permissão que você configurou ao criar o usuário do serviço para o cliente OAuth 2.0, em valores separados por espaço. Isso é necessário ao autenticar por meio do fluxo OAuth2.0.

OAuthVerifier¶

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça¶

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken¶

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn¶

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp¶

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

SSL¶

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

SSLServerCert¶

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema¶

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Localização¶

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados¶

string

Valor Padrão¶

"%APPDATA%\\\SAPGateway Data Provider\\Schema"

Observações¶

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\SAPGateway Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Esquemas Navegáveis¶

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas¶

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações¶

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

UseDisplayNames¶

Booleano determinando se deve ou não usar rótulos SAP.

Tipo de Dados¶

bool

Valor Padrão¶

false

Observações¶

Booleano determinando se deve ou não usar rótulos SAP.

Se definido como verdadeiro, os rótulos que você configurou em sua conta para as propriedades OData servirão como nomes de coluna. Caso contrário, o nome da propriedade será o nome da coluna.

Diversos¶

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Formato de Dados¶

O formato de dados para recuperar dados. Selecione XML ou JSON.

Valores Possíveis¶

XML, JSON

Tipo de Dados¶

string

Valor Padrão¶

"XML"

Observações¶

O formato de dados para recuperar dados. Os valores possíveis são JSON e XML. Se não for especificado, o XML será definido por padrão.

MaxRows¶

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados¶

int

Valor Padrão¶

-1

Observações¶

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro¶

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Casos de uso de driver normal e funcionalidade não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação¶

Tamanho da Página¶

O número máximo de resultados a serem retornados por página do SAP Gateway.

Tipo de Dados¶

int

Valor Padrão¶

5000

Observações¶

O Pagesize a propriedade afeta o número máximo de resultados a serem retornados por página do SAP Gateway. Definir um valor mais alto pode resultar em melhor desempenho ao custo de memória adicional alocada por página consumida.

Pseudocolunas¶

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo Esgotado¶

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados¶

int

Valor Padrão¶

60

Observações¶

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.