Detalhes de Conexão do Microsoft OneNote

Introdução

Versão do conector

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

Começando

Suporte à versão do Microsoft OneNote

Todas as versões hospedadas do Microsoft OneNote são suportadas por meio do Microsoft Graph API v1.0. Inclui informações acessíveis de blocos de anotações, seções e páginas do OneNote de um usuário em uma conta pessoal ou organizacional.

Estabelecendo uma Conexão

Autenticação no Microsoft OneNote

O Microsoft OneNote usa o padrão de autenticação OAuth. Para autenticar usando OAuth, você precisará criar um aplicativo para obter o OAuthClientId, OAuthClientSecret, e CallbackURL propriedades de conexão.

Azure AD

O Azure AD é um tipo de conexão que utiliza OAuth para autenticação. OAuth requer que o usuário autenticado interaja com o Microsoft OneNote usando um navegador da Internet. O conector facilita isso de várias maneiras, conforme descrito abaixo. Defina seu AuthScheme para AzureAD. Todos os fluxos do Microsoft Entra ID assumem que você fez isso.

Aplicativos de Área de Trabalho

fornece um aplicativo OAuth incorporado que simplifica a autenticação de área de trabalho OAuth. Como alternativa, você pode criar um aplicativo OAuth personalizado. Consulte Criando um aplicativo personalizado do Microsoft Entra ID para obter informações sobre como criar aplicativos customizados e os motivos para fazê-lo.

Para autenticação, a única diferença entre os dois métodos é que você deve definir duas propriedades de conexão adicionais ao usar aplicativos OAuth personalizados.

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• InitiateOAuth: Defina para GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
• OAuthClientId: (somente aplicativos personalizados) Defina isso como o ID do cliente nas configurações do seu aplicativo.
• OAuthClientSecret: (apenas aplicativos personalizados) 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.

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 que persistem nas conexões.

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 Microsoft OneNote 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 Microsoft Entra ID no portal do Azure, você deve especificar quais permissões o aplicativo exigirá. Algumas permissões podem ser marcadas como "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 um login de administrador portal.azure.com e navegue até o aplicativo que você criou em Registros de aplicativos. Em Permissões da API, clique em Grant Consent 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 você precisar conceder permissões de aplicativo para outros locatários fora de sua organização, use o GetAdminConsentURL procedimento armazenado* para gerar o URL de autorização do administrador. Ao contrário do GetOAuthAuthorizationURL, não haverá nenhuma informação importante retornada desse endpoint. Após o aplicativo OAuth ser autorizado com sucesso, ele retorna um Boolean indicando que as permissões foram concedidas.

Depois que o administrador aprovar o aplicativo OAuth, você poderá continuar a autenticação.

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 de oauth do cliente exigem o consentimento do administrador. Isso significa que o aplicativo incorporado com o Jitterbit Connector for Microsoft OneNote 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 personalizado do Microsoft Entra ID para mais detalhes.

Em seu App Cadastro em portal.azure.com, navegue até API Permissions e selecione Microsoft Graph permissions. 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 necessárias para sua integração.

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

1. Authenticating using a Client Secret
   • InitiateOAuth: Defina para GETANDREFRESH. Você pode usar InitiateOAuth para evitar a repetição da troca OAuth e definir manualmente o OAuthAccessToken.
   • AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
   • OAuthGrantType: Defina para CLIENT.
   • 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 para 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 ocorre automaticamente como qualquer outra conexão, exceto que não há 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.

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

Observação: Você deve criar um aplicativo personalizado antes de atribuir uma papel. Consulte Criando um aplicativo personalizado do Microsoft Entra ID Para maiores informações.

Ao autenticar usando uma entidade de serviço do Azure, você deve registrar um aplicativo com um locatário do Azure AD. Siga as etapas abaixo para criar uma nova entidade de serviço que pode ser usada com o controle de acesso baseado em função.

Atribuir uma Papel ao Aplicativo

Para acessar recursos em sua assinatura, você deve atribuir uma papel ao aplicativo.

1. Abra o Subscriptions pesquisando e selecionando o serviço Assinaturas na barra de pesquisa.
2. Selecione a assinatura específica à qual atribuir o aplicativo.
3. Abra o Access control (IAM) e selecione Add > Add role assignment para abrir o Add role assignment página.
4. Selecione Owner como a papel a ser atribuída ao aplicativo criado do Azure AD.

Conclua a Autenticação

Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo da autenticação de aplicativo configurada (segredo ou certificado do cliente).

Em ambos os métodos

Antes de escolher o segredo do cliente ou autenticação de certificado, siga estas etapas e continue na seção relevante abaixo:

1. AuthScheme: Defina isso como AzureServicePrincipal nas configurações do aplicativo.
2. InitiateOAuth: Defina para GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca OAuth e definir manualmente o OAuthAccessToken.
3. AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
4. OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.

Autenticando usando um segredo do cliente

Continue com o seguinte:

1. OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
2. OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.

Autenticando usando um certificado

Continue com o seguinte:

1. OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
2. OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.

MSI

Se você estiver executando o Microsoft OneNote em uma VM do Azure, poderá aproveitar as credenciais do Managed Service Identity (MSI) para se conectar:

• AuthScheme: Defina para AzureMSI.

As credenciais MSI são obtidas automaticamente para autenticação.

Criando um Aplicativo Personalizado do Microsoft Entra ID

Existem dois tipos de aplicativos personalizados do Microsoft Entra ID: Microsoft Entra ID e Microsoft Entra ID com uma entidade de serviço do Azure. Ambos são baseados em OAuth.

Quando Criar um Aplicativo Personalizado

incorpora credenciais de aplicativos OAuth com marcas que podem ser usadas ao se conectar por meio de um aplicativo de desktop ou de uma máquina sem periféricos.

Você pode optar por usar suas próprias credenciais de aplicativo Microsoft Entra ID quando quiser

• marca de controle da caixa de diálogo de autenticação
• controlar o URI de redirecionamento para o qual o aplicativo redireciona o usuário após a autenticação do usuário
• personalize as permissões que você está solicitando do usuário

Aplicativos Personalizados do Microsoft Entra ID

Você pode usar um aplicativo personalizado do Microsoft Entra ID para autenticar uma conta de serviço ou uma conta de usuário. Você sempre pode criar um aplicativo personalizado do Microsoft Entra ID, mas observe que as conexões de desktop e headless oferecem suporte a OAuth incorporado, o que simplifica o processo de autenticação. Consulte "Estabelecendo uma conexão" para obter informações sobre como usar o aplicativo OAuth integrado.

Criar um Aplicativo Personalizado do Microsoft Entra ID

Siga as etapas abaixo para obter os valores do Microsoft Entra ID 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, então applicationRegistrations, e clique em New registration.
3. Insira um nome de aplicativo e selecione a configuração de locatário desejada. Ao criar um aplicativo personalizado do Microsoft Entra ID 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", deverá 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 Microsoft OneNote. Caso contrário, a tentativa de autenticação falhará com um erro. Se seu aplicativo for apenas para uso privado, "Apenas 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. Defina o URL de redirecionamento para http://localhost:33333, o padrão do conector. Ou especifique uma porta diferente e defina CallbackURL para a URL de resposta exata que você definiu.
5. Clique em Register para registrar o novo aplicativo. Isso abre uma tela de gerenciamento de aplicativos. Anote o valor em Application (client) ID Enquanto o OAuthClientId e a Directory (tenant) ID Enquanto o AzureTenant.
6. Navegue até "Certificados e Segredos" e defina o tipo de autenticação do aplicativo. Existem dois tipos de autenticação disponíveis: segredo do cliente ou certificado. O método de autenticação recomendado é usar um certificado.
   • Opção 1: Carregar um certificado: Em "Certificates & Secrets", selecione Upload certificate e o certificado para carregar de sua máquina local.
   • Opção 2: Criar um novo segredo de aplicativo: Em "Certificados e Segredos", selecione New Client Secret para a aplicação e especificar a sua duração. Depois de salvar o segredo do cliente, o valor da chave é exibido. Copie este valor, pois ele é exibido apenas uma vez. Você precisará dele como OAuthClientSecret.
7. Selecione API Permissions > Add > Delegated permissions.
8. Selecione a API do Microsoft Graph e as seguintes permissões delegadas permitirão o acesso a todas as funcionalidades do driver:
   • Leia e escreva todos os Cadernos, Seções, Grupos de Seções e Páginas.
   • Leia todos os usuários.
   • Leia todos os grupos.
9. Salve suas alterações.
10. Se você optou por usar permissões que requerem 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".

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.

Crie um Aplicativo Microsoft Entra ID e uma Entidade de Serviço do Azure

Ao autenticar usando uma entidade de serviço do Azure, você deve registrar um aplicativo com um locatário do Azure AD.

Atribuir uma Papel ao Aplicativo

Para acessar recursos em sua assinatura, você deve atribuir uma papel ao aplicativo.

1. Abra o Subscriptions pesquisando e selecionando o serviço Assinaturas na barra de pesquisa.
2. Selecione a assinatura específica à qual atribuir o aplicativo.
3. Abra o Access control (IAM) e selecione Add > Add role assignment para abrir o Add role assignment página.
4. Selecione Owner como a papel a ser atribuída ao aplicativo criado do Azure AD.

Conclua a Autenticação

Você está pronto para se conectar após definir um dos grupos de propriedades de conexão abaixo, dependendo da autenticação de aplicativo configurada (segredo ou certificado do cliente).

Em ambos os métodos

Antes de escolher o segredo do cliente ou autenticação de certificado, siga estas etapas e continue na seção relevante abaixo:

1. AuthScheme: Defina isso como AzureServicePrincipal nas configurações do aplicativo.
2. InitiateOAuth: Defina para GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca OAuth e definir manualmente o OAuthAccessToken.
3. AzureTenant: Defina isso para o inquilino ao qual você deseja se conectar.
4. OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.

Autenticando usando um segredo do cliente

Continue com o seguinte:

1. OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
2. OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.

Autenticando usando um certificado

Continue com o seguinte:

1. OAuthJWTCert: Defina isso para o armazenamento de certificados JWT.
2. OAuthJWTCertType: Defina isso para o tipo de armazenamento de certificado especificado por OAuthJWTCert.

Tarefas Administrativas

O Conector Jitterbit para Microsoft OneNote pode ser usado para executar tarefas administrativas. Isso pode ser feito especificando a coluna UserId para executar operações CUD.

A Coluna UserId

Muitas tabelas expõem uma coluna UserId especial. Isso é projetado para ser usado por um administrador para modificar registros na conta de outro usuário. Se você não for um administrador ou não desejar esse comportamento, não especifique o UserId ao executar uma operação INSERT/UPDATE/DELETE. Por exemplo, executar o seguinte irá inserir um notebook para outro usuário:

INSERT INTO Notebooks (displayName, UserId) VALUES ('Test Notebook', '12345')

A solicitação acima terá o efeito geral de tentar adicionar um notebook no recurso em /users/12345/notebooks. Quando UserId não for especificado, os recursos afetados serão modificados em /users/me/notebooks. Em geral, se você não for um administrador, poderá apenas afetar ou visualizar registros em /users/me, portanto, não é recomendável definir UserId quando você não for um administrador.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector do Microsoft OneNote.

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.

Processamento de consulta

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

Consulte Processamento de consultas Para maiores informações.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for Microsoft OneNote 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 visualização.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Notebooks 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"

Definindo Exibições Usando Instruções DDL

O conector também é capaz de criar e alterar o esquema por meio de instruções DDL, como CREATE LOCAL VIEW, ALTER LOCAL VIEW e DROP LOCAL VIEW.

Criar uma Visualização

Para criar uma nova visualização usando instruções DDL, forneça o nome da visualização e a consultar da seguinte forma:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

Se não existir nenhum arquivo JSON, o código acima criará um. A exibição é então criada no arquivo de configuração JSON e agora pode ser descoberta. O local do arquivo JSON é especificado pelo UserDefinedViews propriedade de conexão.

Alterar uma Visualização

Para alterar uma exibição existente, forneça o nome de uma exibição existente ao lado da nova consultar que você gostaria de usar:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

A visualização é então atualizada no arquivo de configuração JSON.

Solte uma Visualização

Para descartar uma exibição existente, forneça o nome de um esquema existente ao lado da nova consultar que você gostaria de usar.

DROP LOCAL VIEW [MyViewName]

Isso remove a visualização do arquivo de configuração JSON. Não pode mais ser consultado.

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

Visão geral

Esta seção mostra os objetos de API disponíveis e fornece mais informações sobre como executar SQL para APIs do Microsoft OneNote.

Características principais

• O conector modela entidades do Microsoft OneNote como usuários e grupos como exibições relacionais, entidades como blocos de anotações, seções, grupos de seções e páginas como tabelas relacionais, permitindo que você escreva SQL para consultar dados do Microsoft OneNote.
• Procedimentos armazenados* permitem executar operações no Microsoft OneNote, 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 Microsoft OneNote são refletidas imediatamente ao usar o conector.

Visualizações

Visualizações descreve as exibições disponíveis. As exibições são definidas estaticamente para modelar usuários e grupos.

Mesas

Tabelas descreve as tabelas disponíveis. As tabelas são definidas estaticamente para modelar Notebooks, SectionGroups, Sections e Pages.

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

Tabelas

O conector modela os dados no Microsoft OneNote em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas do Microsoft OneNote é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para Tabelas do Microsoft OneNote

Cadernos

Recupera todos os Notebooks para o usuário autenticado.

Informações Específicas da Tabela

Selecione

A maioria dos filtros é manipulada no lado do servidor, mas os campos específicos de Id, UserId e GroupId alterarão o endpoint que usamos para recuperar os dados. Eles devem ser especificados com uma condição '=' ou IN. Por exemplo:

SELECT * FROM Notebooks WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Notebooks WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-56e2fc02-f3dd-4f82-fvgf-dfsdf4807935')
SELECT * FROM Notebooks WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Notebooks WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'

Inserir

A coluna necessária para executar uma operação de inserção na tabela Notebooks é DisplayName. Se a operação INSERT for feita em nome de um grupo ou usuário, UserId ou GroupId também devem ser especificados. Os exemplos a seguir ilustram uma operação Insert em Notebooks:

INSERT INTO Notebooks (DisplayName) VALUES ('Getting started')
INSERT INTO Notebooks (DisplayName, UserId) VALUES ('Getting started','9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Notebooks (DisplayName, GroupId) VALUES ('Getting started','044d385d-6ca8-4d81-800d-223124b651db')

Colunas

Grupos de Seções

Recupera todos os SectionGroups nos notebooks para o usuário autenticado.

Informações Específicas da Tabela

Selecione

A maioria dos filtros são manipulados no lado do servidor, mas os campos específicos de Id, UserId, GroupId e ParentNotebookId mudarão o endpoint que usamos para recuperar os dados. Eles devem ser especificados com uma condição '=' ou IN. Por exemplo:

SELECT * FROM SectionGroups WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE ParentNotebookId = '1-2342423-1234-3424-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM SectionGroups WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'

Inserir

As colunas necessárias para executar uma operação de inserção na tabela SectionGroups são DisplayName e ParentNotebookId. Se a operação INSERT for feita em nome de um grupo ou usuário, UserId ou GroupId também devem ser especificados. Os exemplos a seguir ilustram uma operação Insert em SectionGroups:

INSERT INTO SectionGroups (DisplayName, ParentNotebookId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')

Colunas

Seções

Recupera todas as seções em notebooks para o usuário autenticado.

Informações Específicas da Tabela

Selecione

A maioria dos filtros são manipulados no lado do servidor, mas os campos específicos de Id, UserId, GroupId, ParentNotebookId e ParentSectionGroupId mudarão o endpoint que usamos para recuperar os dados. Eles devem ser especificados com uma condição '=' ou IN. Por exemplo:

SELECT * FROM Sections WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentNotebookId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentSectionGroupId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentSectionGroupId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Sections WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'

Inserir

As colunas necessárias para executar uma operação de inserção na tabela de seções são DisplayName e ParentNotebookId. Se a operação INSERT for feita em nome de um grupo ou usuário, UserId ou GroupId também devem ser especificados. Os exemplos a seguir ilustram uma operação de inserção em seções:

INSERT INTO Sections (DisplayName, ParentNotebookId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO Sections (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Sections (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')

Colunas

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na maneira 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.

Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.

Conector Jitterbit para Exibições do Microsoft OneNote

Grupos

Recupera todos os grupos do Azure Active Directory (Azure AD), que podem ser grupos do Office 365 ou grupos de segurança.

Informações Específicas da Tabela

Os grupos requerem permissões de administrador. Para trabalhar com eles, você deve criar seu próprio aplicativo OAuth personalizado e definir o apropriadoOAuthClientId e OAuthClientSecret. Neste aplicativo, você deve configurá-lo para solicitar a permissão Group.Read.All. Isso pode ser feito em https://apps.dev.microsoft.com, ou no painel Registros de aplicativos em http://portal.azure.com. Consulte Criando um aplicativo personalizado do Microsoft Entra ID para obter mais detalhes sobre como criar um aplicativo personalizado.

Para autorizar permissões de Grupos, um administrador deve conceder as permissões de Grupos para sua organização como um todo. Isso pode ser feito por meio do endpoint de autorização do administrador. Basta que o administrador navegue até a seguinte página da Web e conceda permissões. Em seguida, execute a autorização OAuth normalmente.

https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333

Selecione

A maioria dos filtros são manipulados no lado do servidor, mas o campo específico de ID mudará o endpoint que usamos para recuperar os dados. Deve ser especificado com uma condição '=' ou IN. Por exemplo:

SELECT * FROM Groups WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Groups WHERE ID IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')

Colunas

Páginas

Recupera todas as páginas em notebooks para o usuário autenticado.

Informações Específicas da Tabela

Selecione

A maioria dos filtros são manipulados no lado do servidor, mas os campos específicos de Id, ParentSectionId, UserId ou GroupId alterarão o endpoint que usamos para recuperar os dados. Eles devem ser especificados com uma condição '=' ou IN. Por exemplo:

SELECT * FROM Pages WHERE Id = '1-e8992fa8e5254df387d062d04e75a6e7!6-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE Id IN ('1193-dsdda-9392-4706514c636b', '1193-dsdda-9392-sdfasdw33324')
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND GroupId = '1772bb5a-f8e9-405d-a90b-eac11b0b9b9a'
SELECT * FROM Pages WHERE GroupId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1'
SELECT * FROM Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'

Colunas

Usuários

Recupera todas as contas de usuário do Azure AD dentro das permissões autenticadas.

Informações Específicas da Tabela

Os usuários requerem permissões de Administrador. Para trabalhar com eles, você deve criar seu próprio aplicativo OAuth personalizado e definir o apropriadoOAuthClientId e OAuthClientSecret. Neste aplicativo, você deve configurá-lo para solicitar a permissão User.Read.All. Isso pode ser feito em https://apps.dev.microsoft.com, ou no painel Registros de aplicativos em http://portal.azure.com. Consulte Criando um aplicativo personalizado do Microsoft Entra ID para obter mais detalhes sobre como criar um aplicativo personalizado.

Para autorizar permissões de usuário, um administrador deve conceder permissões de usuários para sua organização como um todo. Isso pode ser feito por meio do endpoint de autorização do administrador. Basta que o administrador navegue até a seguinte página da Web e conceda permissões. Em seguida, execute a autorização OAuth normalmente.

https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333

Selecione

A maioria dos filtros são manipulados no lado do servidor, mas o campo específico de ID mudará o endpoint que usamos para recuperar os dados. Deve ser especificado com uma condição '=' ou IN. Por exemplo:

SELECT * FROM Users WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Users WHERE ID IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')

Colunas

Procedimentos Armazenados

Procedimentos armazenados* são interfaces semelhantes a funções que estendem a funcionalidade do conector além das simples operações SELECT/INSERT com o Microsoft OneNote.

Procedimentos armazenados* aceitam uma lista de parâmetros, executam a função pretendida e, em seguida, retornam, se aplicável, quaisquer dados de resposta relevantes do Microsoft OneNote, juntamente com uma indicação se o procedimento foi bem-sucedido ou falhou.

Conector Jitterbit para Procedimentos Armazenados do Microsoft OneNote

CopyNotebook

Copia um notebook para a pasta Notebooks na biblioteca de documentos de destino. A pasta é criada se não existir.

Entrada

Colunas do Conjunto de Resultados

Copiar Página

Copia uma página para uma seção específica.

Entrada

Colunas do Conjunto de Resultados

CopySection

Copia uma seção para um bloco de anotações ou grupo de seções específico.

Entrada

Colunas do Conjunto de Resultados

Criar Página

Cria uma nova página para a seção especificada

Procedimentos Armazenados* Informações Específicas

O Microsoft OneNote permite que várias colunas sejam usadas na consultar Exec. Essas colunas geralmente podem ser usadas com apenas = comparação. SectionId e um dos parâmetros Content ou File são necessários para executar este procedimento.
Nota: No caso de OAuthGrantType=CLIENT, um de userId ou groupId deve ser especificado. Por exemplo:

EXECUTE CreatePage SectionId = '1-8a84fed0-5381-47f3-89bc-cd16f7a4f06d', File = 'C:\Users\Dell\Desktop\content.html'

Entrada

Colunas do Conjunto de Resultados

BaixarDocumento

Para baixar o arquivo ou objeto de recurso de imagem

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

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

GetPages

O conteúdo HTML da página específica

Entrada

Colunas do Conjunto de Resultados

RefreshOAuthAccessToken

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

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 o Microsoft OneNote:

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

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

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

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

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

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_primarykeys

Descreve as chaves primárias. A consultar a seguir recupera as chaves primárias de todas as tabelas e exibições:

SELECT * FROM sys_primarykeys

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

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

Mapeamento de Tipo de Dados

Mapeamentos de Tipo de Dados

O conector mapeia os tipos da fonte de dados para o tipo de dados correspondente disponível no esquema. A tabela abaixo documenta esses mapeamentos.

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

Autenticação do Azure

OAuth

JWT 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 Microsoft OneNote.

Valores Possíveis

AzureAD, AzureMSI, AzureServicePrincipal

Tipo de Dados

string

Valor Padrão

"AzureAD"

Observações

• Microsoft Entra ID: defina isso para executar a autenticação OAuth do Azure Active Directory.
• AzureMSI: defina isso para obter automaticamente credenciais de identidade de serviço gerenciado ao executar em uma VM do Azure.
• AzureServicePrincipal: defina isso para autenticar como uma Entidade de Serviço do Azure.

Autenticação do Azure

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

AzureTenant

O locatário do Microsoft Online sendo usado para acessar dados. Se não for especificado, seu locatário padrão será usado.

Tipo de Dados

string

Valor Padrão

""

Observações

O locatário do Microsoft Online sendo usado para acessar dados. Por exemplo, contoso.onmicrosoft.com. Como alternativa, especifique a ID do locatário. Esse valor é a ID do diretório no Portal do Azure > Azure Active Directory > Propriedades.

Normalmente, não é necessário especificar o inquilino. Isso pode ser determinado automaticamente pela Microsoft ao usar o OAuthGrantType definido como CODE (padrão). No entanto, pode falhar caso o usuário pertença a vários locatários. Por exemplo, se um administrador do domínio A convidar um usuário do domínio B para ser um usuário convidado. O usuário agora pertencerá a ambos os locatários. É uma boa prática especificar o inquilino, embora em geral as coisas funcionem normalmente sem precisar especificá-lo.

O AzureTenant é necessário ao definir OAuthGrantType ao CLIENTE. Ao usar credenciais de cliente, não há contexto de usuário. As credenciais são obtidas do contexto do próprio aplicativo. Embora a Microsoft ainda permita que as credenciais do cliente sejam obtidas sem especificar qual locatário, ela tem uma probabilidade muito menor de escolher o locatário específico com o qual deseja trabalhar. Por este motivo, exigimos AzureTenant a ser declarado explicitamente para todas as conexões de credenciais do cliente para garantir que você obtenha credenciais aplicáveis ao domínio ao qual pretende se conectar.

Ambiente Azure

O ambiente do Azure a ser usado ao estabelecer uma conexão.

Valores Possíveis

GLOBAL, CHINA, USGOVT, USGOVTDOD

Tipo de Dados

string

Valor Padrão

"GLOBAL"

Observações

Na maioria dos casos, deixar o ambiente definido como global funcionará. No entanto, se sua conta do Azure tiver sido adicionada a um ambiente diferente, o AzureEnvironment pode ser usado para especificar qual ambiente. Os valores disponíveis são GLOBAL, CHINA, USGOVT, USGOVTDOD.

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 para o qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno de chamada 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 especificado nas configurações do aplicativo.

OAuthGrantType

O tipo de concessão para o fluxo OAuth.

Valores Possíveis

CODE, CLIENT

Tipo de Dados

string

Valor Padrão

"CLIENT"

Observações

As seguintes opções estão disponíveis: CÓDIGO, CLIENTE

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 para 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á.

JWT OAuth

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

OAuthJWTCert

A loja de certificados JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

O nome do armazenamento de certificados para o certificado do cliente.

O OAuthJWTCertType campo especifica o tipo de armazenamento de certificado especificado por OAuthJWTCert. Se o armazenamento estiver protegido por senha, especifique a senha em OAuthJWTCertPassword.

OAuthJWTCert é usado em conjunto com o OAuthJWTCertSubject para especificar os certificados do cliente. Se OAuthJWTCert tem um valor e OAuthJWTCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte OAuthJWTCertSubject para obter detalhes.

As designações de armazenamentos de certificados dependem da plataforma.

A seguir estão as designações dos armazenamentos de certificados de Usuário e Máquina mais comuns no Windows:

Em Java, o armazenamento de certificados normalmente é um arquivo contendo certificados e chaves privadas opcionais.

Quando o tipo de armazenamento de certificado for PFXFile, essa propriedade deverá ser configurada para o nome do arquivo. Quando o tipo é PFXBlob, a propriedade deve ser configurada para o conteúdo binário de um arquivo PFX (ou seja, armazenamento de certificados PKCS12).

OAuthJWTCertType

O tipo de armazenamento de chaves que contém o certificado JWT.

Valores Possíveis

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Dados

string

Valor Padrão

"USER"

Observações

Esta propriedade pode assumir um dos seguintes valores:

OAuthJWTCertPassword

A senha para o certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

Se o armazenamento de certificados for de um tipo que requer uma senha, essa propriedade será usada para especificar essa senha para abrir o armazenamento de certificados.

OAuthJWTCertSubject

O assunto do certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

"\*"

Observações

Ao carregar um certificado, o assunto é usado para localizar o certificado na loja.

Se uma correspondência exata não for encontrada, a loja é pesquisada em busca de assuntos que contenham o valor da propriedade.

Se uma correspondência ainda não for encontrada, a propriedade será definida como uma string vazia e nenhum certificado será selecionado.

O valor especial "*" seleciona o primeiro certificado no armazenamento de certificados.

O assunto do certificado é uma lista separada por vírgulas de campos e valores de nomes distintos. Por exemplo, "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Os campos comuns e seus significados são exibidos abaixo.

Se um valor de campo contiver uma vírgula, ela deverá ser colocada entre aspas.

OAuthJWTIssuer

O emissor do Java Web Token.

Tipo de Dados

string

Valor Padrão

""

Observações

O emissor do Java Web Token. Normalmente, é o ID do cliente ou o endereço E-mail do aplicativo OAuth.

OAuthJWTSubject

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

Tipo de Dados

string

Valor Padrão

""

Observações

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado. Normalmente, o nome da conta do usuário ou endereço de e-mail.

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%\\\OneNote 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%\\OneNote 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 muitas 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 muitas 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.

Diversos

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

GroupId

Especifique este GroupId para acessar os documentos do OneNote para este grupo.

Tipo de Dados

string

Valor Padrão

""

Observações

Especifique este GroupId para acessar os documentos do OneNote para este grupo.

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

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.

UserDefinedViews

Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.

Tipo de Dados

string

Valor Padrão

""

Observações

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 visualização.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Notebooks 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"

ID do Usuário

Especifique este UserId para acessar os documentos do OneNote para este usuário.

Tipo de Dados

string

Valor Padrão

""

Observações

Especifique este UserId para acessar os documentos do OneNote para este usuário.