Odata

Overview

OData is the connector type for OData service sources. In the repository seed data it is stored as OData with ConnectorTypeID = 12, the description OData service, OLE DB behavior disabled, and the Azure source type OData.

Function

Use the OData connector type when a connector should read source metadata from an OData service endpoint.

When OData is selected in the Connector detail page, AnalyticsCreator hides the connection-string and Template controls and shows the Url, Authentication, and Test connection controls. The authentication modes are None, Windows, and Basic. Login and Password fields are shown only when Basic authentication is selected.

Testing an OData connector appends $metadata to the service URL and sends an HTTP request to the metadata endpoint. Windows authentication uses the current network credentials. Basic authentication sends the configured login and password. Saving stores the OData URL, authentication mode, login, and encrypted password, then refreshes the navigation tree.

Access

OData connector type configuration is opened through the common connector editor. The connector type itself is selected in the Connector type field.

How to access

Navigation tree

Data warehouse -> Connectors -> Add connector, or Data warehouse -> Connectors -> CONNECTOR -> Edit connector

Toolbar

Sources -> New connector -> Add, or Sources -> List -> Connectors

Diagram

Not direct. Edit an OData connector from the Connectors list or connector node.

Visual element

Connector detail page, Connectors list, and Connectors navigation-tree node.

Screen overview

The Connector detail page contains the following visible fields and actions when the OData connector type is selected.

ID Property Description
1You can use #ENCRYPTED_STRING# alias instead of plain-text passwords. You can add encrypted string using Options->Encrypted stringsHelp text shown at the top of the Connector page. For OData, the password is encrypted when it is saved.
2Connector nameConnector name. Saving requires a non-empty value.
3Connector typeSelect OData.
4Azure source typeStores the Azure source type associated with the connector. The seeded OData connector type uses OData.
5Do not store connection string in CFG.SSIS__ConfigurationsStores the common connector flag. The OData connector itself stores URL and authentication fields instead of a connection string.
6UrlOData service URL. Test connection appends $metadata to this URL before sending the request.
7AuthenticationAuthentication mode. Available values are None, Windows, and Basic. New OData connectors default to None.
8LoginLogin field shown when Basic authentication is selected.
9PasswordPassword field shown when Basic authentication is selected. The password is encrypted before it is stored.
10Test connectionRequests the OData metadata endpoint. Windows authentication uses current network credentials; Basic authentication sends the configured login and password.
11SaveSaves the connector, stores the OData URL, authentication mode, login, and encrypted password, refreshes the navigation tree, and reloads the saved connector page.
12CancelReturns to the previous page. If there are unsaved changes, AnalyticsCreator asks whether to save or cancel the navigation.

List behavior

  • The Connectors list filters by connector name, connector type id, connection string, locale, code page, or format.
  • The list grid shows ConnectorName, ConnectorType, and ConnectionString.
  • Double-clicking a connector opens it in the Connector detail page.
  • New opens a new Connector detail page. Delete removes the selected connector after confirmation.

Connector actions

  • The Connectors branch provides Refresh, List connectors, Add connector, Import connector from file, and Import connector from cloud.
  • A selected connector provides Set diagram filter, Add to diagram filter, Edit connector, Delete connector, DWH Wizard, Refresh used sources, Refresh all sources, Export connector to file, and Export connector to cloud.
  • The OData connector type is displayed with the web-service connector icon when connector nodes are rendered.

Related topics