Detalhes da Conexão do Microsoft OneDrive¶

Introdução¶

Versão do conector

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

Começando¶

Suporte à versão do OneDrive

As contas OneDrive e OneDrive for Business são suportadas por meio da API do Microsoft Graph v1.0.

Estabelecendo uma Conexão¶

Conectando-se ao Microsoft OneDrive¶

Autenticação Usando a Entidade de Serviço do Azure¶

A Entidade de Serviço do Azure é um tipo de conexão que passa por OAuth. Defina seu AuthScheme para AzureServicePrincipal e consulte Usando a Autenticação Principal de Serviço do Azure para obter um guia de autenticação.

Usando Autenticação OAuth¶

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

Credenciais Incorporadas¶

Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado.

Credenciais Personalizadas¶

Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo com Custom Credentials para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado¶

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no OneDrive e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem logon no endpoint OneDrive OAuth para conceder permissões ao conector.

Criando um Aplicativo OAuth Personalizado¶

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Incorporadas¶

Autenticar Usando as Credenciais OAuth Incorporadas¶

Autenticação de Desktop com o Aplicativo OAuth Integrado¶

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário.

Quando você se 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 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.

Credenciais Personalizadas¶

Existem dois tipos de autenticação de aplicativo disponíveis: usando um segredo do cliente e usando um certificado. Você pode usar qualquer um deles dependendo da autenticação de aplicativo configurada.

Autenticação de Área de Trabalho com Seu Aplicativo OAuth¶

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha um Token de Acesso OAuth¶

Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo do tipo de autenticação.

1. Authenticating using a Client Secret
   • 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.
   • CallbackURL: Defina isso para o URL de redirecionamento nas configurações do aplicativo.
   • AuthScheme: Defina isso como "AzureAD" nas configurações do aplicativo.
   • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar a repetição da troca OAuth e definir manualmente o OAuthAccessToken..
2. Authenticating using a Certificate
   • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
   • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
   • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.
   • CallbackURL: Defina isso para o URL de redirecionamento nas configurações do aplicativo.
   • AuthScheme: Defina isso como "AzureAD" nas configurações do 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. Obtém um novo token de acesso quando o antigo 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 OneDrive em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa autenticar em 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 incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais para um Aplicativo OAuth Personalizado¶

Crie um aplicativo OAuth personalizado

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

Na máquina sem periféricos, defina um dos seguintes grupos de propriedades, dependendo do tipo de autenticação:

1. Authenticating using a Client Secret
   • InitiateOAuth: Defina como DESLIGADO.
   • OAuthClientId: Defina isso como o ID do aplicativo nas configurações do aplicativo.
   • OAuthClientSecret: Defina isso como o Segredo do aplicativo nas configurações do aplicativo.
2. Authenticating using a Certificate
   • InitiateOAuth: Defina como DESLIGADO.
   • OAuthClientId: Defina isso como o ID do aplicativo nas configurações do aplicativo.
   • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
   • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.

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 a URL de retorno de chamada. A página da Web indicará que o site não pôde ser acessado.
3. Inspecione o URL da página deste site e encontre o code valor. Ele estará presente na URL no formato code=XXXXXX (terminado com &, que denota o próximo parâmetro da URL ) O valor após o "code=" é o código do verificador.
4. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina um dos seguintes grupos de propriedades de conexão dependendo do tipo de autenticaçã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.
• OAuthVerifier: Defina isso para o código do verificador.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InitiateOAuth: Defina como REFRESH.

Conecte-se aos dados

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

• 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 a um dos seguintes grupos de propriedades, dependendo do tipo de autenticação:

1. Authenticating using a Client Secret
   • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
   • InitiateOAuth: Defina como GETANDREFRESH.
   • 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.
   • CallbackURL: Defina isso para o URL de retorno de chamada nas configurações do aplicativo.
2. Authenticating using a Certificate
   • OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
   • InitiateOAuth: Defina como GETANDREFRESH.
   • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
   • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
   • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.
   • CallbackURL: Defina isso para o URL de retorno de chamada 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: Configure para ATUALIZAR.
• 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 é opcional, pois o conector já está registrado no OneDrive e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem logon no endpoint OneDrive OAuth para conceder permissões ao conector.

Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão em um fluxo de autenticação OAuth específico.

Etapas para Criar um Aplicativo OAuth Personalizado¶

Siga as etapas abaixo para obter os valores OAuth para seu aplicativo, o OAuthClientId e OAuthClientSecret.

1. Faça login em https://portal.azure.com.
2. No painel de navegação à esquerda, selecione Azure Active Directory, em seguida, Registros de aplicativos e clique no botão Novo registro.
3. Insira um nome de aplicativo e defina o botão de opção para a configuração de locatário desejada. Ao criar um aplicativo OAuth personalizado no Azure Active Directory, você pode definir se o aplicativo é único ou multilocatário. Se você selecionar a opção padrão "Somente contas neste diretório organizacional", precisará definir o AzureTenant propriedade de conexão para a ID do locatário do Azure AD ao estabelecer uma conexão com o conector Jitterbit para OneDrive. Caso contrário, a tentativa de autenticação falhará com um erro. Se seu aplicativo for apenas para uso privado, "Somente contas neste diretório da organização" deve ser suficiente. Caso contrário, se você quiser distribuir seu aplicativo, escolha uma das opções multilocatário.
4. Em seguida, defina o URL de redirecionamento para algo como http://localhost:33333, o padrão do conector. Ou defina uma porta diferente de sua escolha e defina CallbackURL para o URL de resposta exato que você definiu.
5. Defina o tipo de autenticação do aplicativo na seção Certificados e segredos. Existem dois tipos de autenticação disponíveis: usando um segredo do cliente e usando um certificado. O método de autenticação recomendado é por meio de um certificado, mas você também pode criar um segredo de aplicativo.
   • Option 1 - Upload a certificate: Na seção Certificados e Segredos, selecione Carregar certificado e selecione o certificado para carregar de sua máquina local.
   • Option 2 - Create a new application secret: Na seção Certificates & Secrets, selecione New Client Secret para o aplicativo e selecione sua duração. Depois de salvar o segredo do cliente, o valor da chave é exibido. Copie este valor, pois ele é exibido apenas uma vez e é usado como OAuthClientSecret.
6. Selecione Permissões de API e clique em Adicionar. Se você planeja que seu aplicativo se conecte sem um contexto de usuário, selecione as Permissões do aplicativo (OAuthGrantType = CLIENTE). Caso contrário, ao selecionar permissões, use as permissões delegadas.
7. Selecione a API do Microsoft Graph e adicione as permissões delegadas Files.ReadWrite.All ou Files.Read.All. Clique no botão 'Conceder consentimento do administrador' para que as novas permissões entrem em vigor.
8. Salve suas alterações.
9. Se você optou por usar permissões que exigem consentimento do administrador (como as Permissões do aplicativo), você pode concedê-las do locatário atual na página Permissões da API. Caso contrário, siga as etapas em Consentimento do administrador.

Consentimento do Administrador¶

O consentimento do administrador refere-se a quando o administrador de um locatário do Azure Active Directory concede permissões a um aplicativo que exige que um administrador consinta com o caso de uso. O aplicativo incorporado no conector Jitterbit para OneDrive não contém permissões que exijam o consentimento do administrador. Portanto, essas informações se aplicam apenas a aplicativos personalizados.

Permissões de Consentimento do Administrador¶

Ao criar um novo aplicativo OAuth no Portal do Azure, você deve especificar quais permissões o aplicativo exigirá. Algumas permissões podem ser marcadas informando "Consentimento do administrador necessário". Por exemplo, todas as permissões de grupos exigem consentimento do administrador. Se seu aplicativo exigir consentimento do administrador, há algumas maneiras de fazer isso.

A maneira mais fácil de conceder consentimento de administrador é apenas fazer com que um administrador faça logon em portal.azure.com e navegue até o aplicativo que você criou em Registros de aplicativos. Em Permissões da API, haverá um botão para Conceder consentimento. Você pode consentir aqui para que seu aplicativo tenha permissões no locatário sob o qual foi criado.

Se sua organização tiver vários locatários ou o aplicativo precisar receber permissões para outros locatários fora de sua organização, o GetAdminConsentURL pode ser usado para gerar o URL de autorização do administrador. Ao contrário do GetOAuthAuthorizationURL, não haverá informações importantes retornadas desse endpoint. Se conceder acesso, ele simplesmente retornará um booleano indicando que as permissões foram concedidas.

Depois que um administrador concede o consentimento, a autenticação pode ser realizada normalmente.

Credenciais do Cliente¶

As credenciais do cliente referem-se a um fluxo no OAuth em que não ocorre nenhuma autenticação direta do usuário. Em vez disso, as credenciais são criadas apenas para o próprio aplicativo. Todas as tarefas executadas pelo aplicativo são realizadas sem um contexto de usuário padrão. Isso torna o fluxo de autenticação um pouco diferente do padrão.

Fluxo OAuth do Cliente¶

Todas as permissões relacionadas ao fluxo oauth do cliente exigem o consentimento do administrador. Isso significa que o aplicativo incorporado com o Jitterbit Connector for OneDrive não pode ser usado no fluxo de autenticação do cliente. Você deve criar seu próprio aplicativo OAuth para usar as credenciais do cliente. Consulte Criando um aplicativo OAuth personalizado para mais detalhes.

Em seu registro de aplicativo em portal.azure.com, navegue até API Permissions e selecione as permissões do Microsoft Graph. Existem dois conjuntos distintos de permissões - Permissões delegadas e de aplicativos. As permissões usadas durante a autenticação da credencial do cliente estão em Permissões do aplicativo. Selecione as permissões aplicáveis necessárias para sua integração.

Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo do tipo de autenticação.

1. Authenticating using a Client Secret
   • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
   • AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
   • OAuthGrantType: Defina como CLIENTE.
   • 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.
2. Authenticating using a Certificate
   • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
   • AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
   • OAuthGrantType: Defina como CLIENTE.
   • OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
   • OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
   • OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.

A autenticação com as credenciais do cliente ocorrerá automaticamente como qualquer outra conexão, exceto que não haverá nenhuma janela aberta solicitando ao usuário. Como não há contexto do usuário, não há necessidade de um pop-up do navegador. As conexões ocorrerão e serão tratadas internamente.

Usando a Autenticação Principal de Serviço do Azure¶

A autenticação como Entidade de Serviço do Azure é tratada por meio do fluxo de Credenciais do Cliente OAuth e não envolve autenticação direta do usuário. Em vez disso, as credenciais são criadas apenas para o próprio aplicativo. Todas as tarefas executadas pelo aplicativo são feitas sem um contexto de usuário padrão, mas com base nas funções atribuídas. O acesso do aplicativo aos recursos é controlado por meio das permissões das funções atribuídas.

Credenciais Personalizadas¶

Você precisará registrar um aplicativo OAuth para obter os valores de propriedade OAuth antes da conexão com a fonte de dados do OneDrive. Você pode verificar as Credenciais personalizadas guia sobre como definir as propriedades OAuth.

Criando um Aplicativo OAuth Personalizado¶

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Criando um Aplicativo OAuth Personalizado¶

A criação de um aplicativo OAuth personalizado e uma entidade de serviço que pode acessar os recursos necessários é necessária ao autenticar usando uma entidade de serviço do Azure.

Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão para a autenticação da Entidade de Serviço do Azure.

Etapas para Criar um Aplicativo OAuth Personalizado¶

Siga as etapas abaixo para obter os valores OAuth para seu aplicativo.

1. Faça login em <https://portal.azure.com>.
2. No painel de navegação à esquerda, selecione Azure Active Directory, em seguida, Registros de aplicativos e clique no botão Novo registro.
3. Insira um nome de aplicativo e defina o botão de opção para "Qualquer diretório do Azure AD - multilocatário". Em seguida, defina o URL de redirecionamento para algo como http://localhost:33333, o padrão do conector.
4. Copie o valor do ID do aplicativo (cliente) exibido na seção Visão geral após criar o aplicativo, pois esse valor é usado como OAuthClientId
5. Defina o tipo de autenticação do aplicativo na seção Certificados e segredos. Existem dois tipos de autenticação disponíveis: usando um segredo do cliente e usando um certificado. O método de autenticação recomendado é por meio de um certificado, mas você também pode criar um segredo de aplicativo.
   • Option 1 - Upload a certificate: Na seção Certificados e Segredos, selecione Carregar certificado e selecione o certificado para carregar de sua máquina local.
   • Option 2 - Create a new application secret: Na seção Certificates & Secrets, selecione New Client Secret para o aplicativo e selecione sua duração. Depois de salvar o segredo do cliente, o valor da chave é exibido. Copie este valor, pois ele é exibido apenas uma vez e é usado como OAuthClientSecret.
6. Na aba Autenticação, certifique-se de marcar a opção: Tokens de acesso (usados para fluxos implícitos).
7. Abra a página Assinaturas pesquisando e selecionando o serviço Assinaturas na barra de pesquisa.
8. Selecione a assinatura específica à qual atribuir o aplicativo, abra a seção Controle de acesso (IAM) e clique no botão Adicionar atribuição de papel.
9. Selecione Proprietário como a papel a ser atribuída ao aplicativo OAuth criado.

Credenciais Personalizadas¶

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Autenticação com Seu Aplicativo OAuth¶

Atualmente, apenas o uso de um segredo do cliente tem suporte para autenticação.

Obtenha um Token de Acesso OAuth¶

Você está pronto para se conectar depois de definir as seguintes propriedades de conexão:

• Authenticating using a Client Secret
  • AuthScheme: Defina isso como "AzureServicePrincipal" nas configurações do aplicativo.
  • InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
  • AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
  • 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.

Acesso a Dados de Ajuste Fino¶

Acesso a Dados de Ajuste Fino¶

• DirectoryRetrievalDepth: quantas pastas você deseja obter resultados para tabelas de pastas, arquivos, recursos compartilhados e permissões.
• DriveId: O ID do Drive que você deseja usar ao obter dados para as tabelas Arquivos, Pastas, SharedResources e Permissões.
• ListGroupDrives: Indica se você gostaria de listar as unidades do seu grupo ou não ao consultar a tabela Unidades. Útil se você estiver usando uma conta do OneDrive for Business.

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 OneDrive.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visualizaçõ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 OneDrive 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 visualizaçã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 Files 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 bem 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 conector modela a API do OneDrive como tabelas relacionais. Quaisquer alterações nos dados remotos são refletidas imediatamente em suas consultas; as definições da tabela são recuperadas dinamicamente. Quando você se conecta, o conector se conecta ao OneDrive e obtém a lista de tabelas e os metadados das tabelas chamando os serviços Web apropriados.

Características principais

• O conector modela entidades do OneDrive como arquivos e pastas como exibições relacionais, permitindo que você escreva SQL para consultar dados do OneDrive.
• Procedimentos armazenados* permitem executar operações no OneDrive, incluindo recuperar o token de acesso e mantê-lo atualizado no OAuth 2.0.
• A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta do OneDrive são refletidas imediatamente ao usar o conector.

Visualizações

Visualizações mostra as definições de um site OneDrive de amostra. O modelo de dados real será obtido dinamicamente com base em suas credenciais de usuário e site.

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 o OneDrive. Eles podem ser usados para pesquisar, atualizar e modificar informações no OneDrive.

Processamento de consulta colaborativa

O conector descarrega o máximo possível do processamento da instrução SELECT no OneDrive e, em seguida, processa o restante da consultar na memória (do lado do cliente).

Isso é feito através do SupportEnhancedSQL propriedade, que é habilitada por padrão. Você pode desativá-lo para desativar a execução do lado do cliente. Isso retornará as informações não filtradas, portanto, os resultados podem estar incorretos.

Visualizações¶

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Exibições do OneDrive¶

Unidades¶

A exibição Unidades do OneDrive, que lista todas as unidades às quais o usuário tem acesso.

Informações Específicas da Tabela¶

Devido às limitações da API, todos os operadores nesta exibição são executados no lado do cliente.

Colunas¶

Arquivos¶

A tabela OneDrive Arquivos na qual você pode exibir todos os arquivos em uma unidade.

Informações Específicas da Tabela¶

A projeção é feita do lado do servidor. Além disso, as consultas que incluem o ID da chave primária e IN são executadas no lado do servidor, por exemplo:

SELECT Id, Name, audio_album, audio_title FROM Files WHERE ID IN ('B1E6BJ084A9133KB1!101', 'APF9D2K6WFA524Y') 

A listagem de arquivos é feita recursivamente através do DirectoryRetrievalDepth propriedade. O valor padrão desta propriedade é 5, o que significa que ela obterá dados apenas para os primeiros 6 níveis do 'Drive' que você escolheu (porque o primeiro nível está localizado em DirectoryRetrievalDepth=0).

Você pode especificar o valor -1 para obter todos os arquivos no 'Drive', independentemente da profundidade em que estão localizados.

Embora os arquivos possam ser listados nesta exibição, o conteúdo dos arquivos pode ser trabalhado usando procedimentos armazenados* como:

• CopiarRecurso - Copie um arquivo/pasta de um diretório em sua unidade para outro.
• ExcluirRecurso - Exclua um arquivo/pasta de sua unidade.
• ⇬ Fazer download do arquivo - Baixe um arquivo existente de sua unidade.
• MoverRecurso - Mova um arquivo/pasta de um diretório em sua unidade para outro.
• Subir arquivo - Carregue um novo arquivo ou atualize o conteúdo de um arquivo existente.

Colunas¶

Pastas¶

A tabela Pastas do OneDrive, que mostra todas as pastas em uma unidade.

Informações Específicas da Tabela¶

Nota: Consulte CriarPasta para criar uma pasta.

A projeção é feita do lado do servidor. Além disso, as consultas que incluem o ID da chave primária e IN são executadas no lado do servidor, por exemplo:

SELECT Id, Name, Size, Description FROM Folders WHERE ID IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9') 

A listagem de pastas é feita recursivamente através do DirectoryRetrievalDepth propriedade. O valor padrão desta propriedade é 5, o que significa que ela obterá dados apenas para os primeiros 6 níveis do 'Drive' que você escolheu (porque o primeiro nível está localizado em DirectoryRetrievalDepth=0).

Você pode especificar o valor -1 para obter todas as pastas no 'Drive', independentemente da profundidade em que estão localizadas.

Embora as pastas possam ser listadas nesta exibição, o conteúdo das pastas pode ser trabalhado usando procedimentos armazenados* como:

• CopiarRecurso - Copie um arquivo/pasta de um diretório em sua unidade para outro.
• ExcluirRecurso - Exclua um arquivo/pasta de sua unidade.
• MoverRecurso - Mova um arquivo/pasta de um diretório em sua unidade para outro.

Colunas¶

Permissões¶

A tabela Permissões do OneDrive, que mostra todas as permissões concedidas a um recurso da unidade.

Informações Específicas da Tabela¶

Devido às limitações da API, todos os operadores nesta exibição são executados no lado do cliente.

Colunas¶

Recursos Compartilhados¶

A tabela SharedResources do OneDrive, que mostra todos os recursos compartilhados em uma unidade.

Informações Específicas da Tabela¶

A projeção é feita do lado do servidor. Além disso, as consultas que incluem o ID da chave primária e IN são executadas no lado do servidor, por exemplo:

SELECT Id, Name, Size, Shared_Scope FROM SharedResources WHERE ID IN ('B1E6BJ084A9133KB1!122', 'APF9D2K6WFAAPX9') 

A listagem de SharedResources é feita recursivamente por meio do DirectoryRetrievalDepth propriedade. O valor padrão desta propriedade é 5, o que significa que ela obterá dados apenas para os primeiros 6 níveis do 'Drive' que você escolheu (porque o primeiro nível está localizado em DirectoryRetrievalDepth=0).

Você pode especificar o valor -1 para obter todos os recursos compartilhados no 'Drive', independentemente da profundidade em que estão localizados.

Colunas¶

Usuários¶

A tabela Usuários do OneDrive na qual um usuário administrador pode exibir os detalhes dos usuários.

Informações dos Usuários¶

A projeção é feita do lado do servidor. A consultar de seleção básica é suportada, por exemplo:

SELECT * FROM Users

Usando esta visualização, um usuário administrador pode listar todos os detalhes de outros usuários.

Colunas¶

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.

Conector Jitterbit para Procedimentos Armazenados do OneDrive¶

CopyResource¶

Copie um recurso de um diretório em sua unidade para outro.

Entrada¶

Colunas do Conjunto de Resultados¶

Criar Pasta¶

Crie uma nova pasta em sua unidade.

Entrada¶

Colunas do Conjunto de Resultados¶

CriarAssinatura¶

Assina um aplicativo de escuta para receber notificações quando os dados são alterados.

Entrada¶

Colunas do Conjunto de Resultados¶

DeleteResource¶

Exclua um recurso de sua unidade.

Entrada¶

Colunas do Conjunto de Resultados¶

Excluir Assinatura¶

Assina um aplicativo de escuta para receber notificações quando os dados são alterados.

Entrada¶

Colunas do Conjunto de Resultados¶

⇬ Fazer Download do Arquivo¶

Baixe um arquivo existente de sua unidade.

Entrada¶

Colunas do Conjunto de Resultados¶

GetAdminConsentURL¶

Obtém a URL de consentimento do administrador que deve ser aberta separadamente por um administrador de um determinado domínio para conceder acesso ao seu aplicativo. Necessário apenas ao usar credenciais OAuth personalizadas.

Entrada¶

Colunas do Conjunto de Resultados¶

GetOAuthAccessToken¶

Obtém um token de autenticação do OneDrive.

Entrada¶

Colunas do Conjunto de Resultados¶

GetOAuthAuthorizationURL¶

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o token de autenticação deste URL.

Entrada¶

Colunas do Conjunto de Resultados¶

Modificar Assinatura¶

Assina um aplicativo de escuta para receber notificações quando os dados são alterados.

Entrada¶

Colunas do Conjunto de Resultados¶

MoveResource¶

Mova um recurso de um diretório em sua unidade para outro.

Entrada¶

Colunas do Conjunto de Resultados¶

RefreshOAuthAccessToken¶

Atualiza o token de acesso OAuth usado para autenticação com vários serviços do Office 365.

Entrada¶

Colunas do Conjunto de Resultados¶

Subir Arquivo¶

Carregue um novo arquivo ou atualize o conteúdo de um arquivo existente.

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 OneDrive:

• 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 Arquivos:

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

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 DownloadResource:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadResource' 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 Arquivos:

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

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:onedrive: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.