Read first:
../conectores.md(state map) andfichas.md(index of fichas).
What it is#
Reads an entity from an OData v4 or v2 service (SAP Gateway, Dynamics, Business Central, SharePoint) with server-side pagination and $top/$skip, and loads into the Bronze layer.
Supported ingestion modes:
- Nós buscamos — Nós buscamos os dados na sua fonte.
What it's for#
Bring data from Generic OData into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural language question wizard.
When to use / when not to use#
Use when you need to consolidate this source into the datalake on a scheduled basis, with isolation per workspace.
Remember that the first run with a real credential is followed by our team before the connector is fully released.
Plan and permissions#
- Plan: core product (connectors are part of all plans; the limit is the number of sources of the plan).
- Access: requires an active workspace — with the subscription overdue, suspended or canceled, the run is blocked.
- Shutdown: the ingestion run can be temporarily turned off (maintenance or incident). When that happens, the screen indicates the feature is unavailable at the moment.
Prerequisites#
- A Generic OData account with access to the data you want to ingest.
- Provide the service root (the URL that ends before the entity name) and the entity set to read, as shown in $metadata. If the service requires login, use username and password (Basic authentication) — the password is encrypted (AES-256-GCM). SAP Gateway and older Dynamics NAV services are OData v2; Business Central, Dynamics 365 and SharePoint are v4.
Credentials#
Authentication method: Username and password (or key and secret) using Basic authentication.
Sensitive fields. They are encrypted (AES-256-GCM) and are never stored in the config of the connection, in the pipeline definition, in exports or in the DAG. By default the encrypted value is stored in the database; moving this connection's credential to an external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.
- Password (
senha)
Secrets are never re-displayed and are redacted in any error/log (raw token, URL-encoded and in JSON).
Form fields#
| Field | Label | Type | Required | Notes |
|---|---|---|---|---|
urlServico | Service URL | text | yes | Service root, without the entity. Ex.: https://erp.empresa.com/sap/opu/odata/sap/ZVENDAS_SRV |
entidade | Entity (entity set) | text | yes | Name of the collection to read, as listed in $metadata (one Bronze table per source). |
versao | OData Version | selection | no | default: v4; options: v4 / v2 |
usuario | Username | text | no | Basic authentication. Leave empty for open services. |
senha 🔒 | Password | password/secret | no | secret (encrypted; external vault optional) |
Step by step#
- In the menu Dados → Conexões, use Nova conexão.
- Choose OData genérico from the catalog.
- Fill the form fields (see the table above).
- Use Testar conexão. The result is shown separated by Network (server reach), Authentication (username and password) and Read (list tables) — each with OK, Failed, Not applicable or Not tested.
- Use Salvar conexão. Saving DOES NOT start any ingestion.
- On the connection card, use Montar extração (or go to Orquestração → Pipelines and use Conectar fonte). The pipeline points to the saved connection — the credential is not copied.
- In review, Publicar (agenda desligada) creates version 1 without running anything. After that, Ativar agenda and Executar agora are separate actions.
Example — connection test#
Example configuration (all values are fictitious; secrets appear masked):
# Exemplo sintético (valores fictícios — não são credenciais reais)
urlServico = <urlServico>
entidade = <entidade>
versao = v4
usuario = <usuario>
senha = •••••• (cifrado — nunca exibido)Expected result#
The Testar conexão returns the list of discovered tables/resources. After the first load, the rows appear in the Bronze layer of your workspace, ready for the pipeline.
Limits and costs#
- Pagination: hard cap per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
- SaaS load: default
batchSize5,000,maxRows200,000 per resource. - Estimated volume: ~0.2 GB/month (catalog estimate, not a measurement).
- Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).
Security#
- Scope per workspace: each client reads and writes only to their own datalake (
<prefixo>_bronze/_silver/_gold); there is never leakage between workspaces. - Encrypted secrets: sensitive material is encrypted with AES-256-GCM before being written. The external credential vault is optional and connected per connection; without it, the encrypted value remains in the database. Changing the value here DOES NOT revoke the credential at the origin.
- Redaction: all errors/logs go through secret redaction (raw, URL-encoded and in JSON).
- Production does not fake: a path that would fall into a mock triggers the production guard (explicit failure instead of simulating success).
Common errors#
- Credential refused (401/403) — the provider did not accept the credential: expired, revoked or lacking the necessary permission. Reconnect the source (the source and history are preserved; do not recreate the source).
- Rate limit (429) — the provider asked to wait. The extraction respects
Retry-Afterand retries; if it repeats, wait and reduce the schedule frequency. - Resource not found — check the resource identifier (account, object, report) and the granted permissions.
- Stuck pagination cursor — the extraction stops when the API cursor does not advance (anti-loop guard). If it happens in successive runs, open a support ticket informing the connector and the resource.
- Empty record path — the response arrived without records in the expected place. Check the selected resource and filters (period, account, status) before assuming there is no data.
Troubleshooting#
- Use Testar conexão to isolate credential/network issues before scheduling.
- Monitor runs in the connector observability (error rate, p50/p95, freshness).
- A schema change at the source is signaled by schema drift (new column = info; removed/changed type column = attention).
Related#
../conectores.md— connector catalog by state../ingestao-incremental-backfill.md— full, incremental by watermark, backfill and checkpoint../pipeline-medalhao.md— Bronze/Silver/Gold layers and quality../agendamento-retry-dlq.md— scheduling, retry/backoff and DLQ../custo-limites-seguranca.md— cost, caps and security per workspace
Last review: 2026-10-04. Ficha generated automatically from the product's connector catalog.