Reporting Server > Using the Adapter for OData > Configuring the Adapter for OData

Configuring the Adapter for OData

How to:

Reference:

Configuring the adapter consists of specifying connection and authentication information for each of the connections you want to establish. The Adapter for OData is in the XML Based group.

Procedure: How to Configure an Adapter

  1. From the Web Console sidebar, click Connect to Data.

    or

    From the Data Management Console, expand the Adapters folder.

    In the DMC, the Adapters folder opens. In the Web Console, the Adapters page opens showing your configured adapters.

  2. In the Web Console, click the New Datasource button on the menu bar and find the adapter on the page or, in the DMC, expand the Available folder if it is not already expanded.
    On the Web Console, you can select a category of adapter from the drop-down list or use the search option (magnifying glass) to search for specific characters.
  3. In the DMC, expand the appropriate group folder and the specific adapter folder. The group folder is described in the connection attributes reference.
  4. Right-click the adapter name and/or version and select Configure.

    The Add Adapter to Configuration pane opens.

  5. Enter values for the parameters required by the adapter, as described in the chapter for the specific adapter you want to configure.
  6. Click Configure. The configured adapter is added to the Adapters list in the DMC resources tree or the Configured list in the Web Console.
    In the Web Console, the adapter remains on the Available Adapters list with an asterisk to indicate that at least one connection has been configured. You can configure additional connections from either the Configured or Available list by right-clicking the adapter and clicking Add Connection.

Reference: Connection Attributes for OData

Enter or select values for the following connection parameters to add a connection to the Adapter for Slack.

Connection Name

Is the logical name used to identify this particular set of connection attributes. The default is CON01.

Base URL

Is the URL to the OData service, for example, https://services.odata.org/V4/Northwind/Northwind.svc/%20%20.

Security

There are four methods by which a user can be authenticated when connecting to an OData Service provider:

  • Trusted. Uses a KERBEROS protocol that may or may not require a Service Principal Name.
  • Explicit. The user ID and password are explicitly specified for each connection and passed to the OData Service, at connection time, for authentication.
  • OAuth. Open Authorization grants limited access to user accounts on an HTTP service.
  • None. No security. User ID and password are not required.
KERBEROS SPN

Is the Service Principal Name used by the client to uniquely identify an instance of a service, for example, mydaemon/foo:4761. This field appears when Trusted security is selected.

Token URL

Is the URL used for obtaining an Access Token to OData. This field appears when OAuth security is selected.

Additional Authentication Parameters

This field appears when OAuth security with the Authorization Code Grant Type is selected. Enter any additional parameters required for authentication.

Additional Token Parameters

This field appears when OAuth security with the Authorization Code Grant Type is selected. Enter any additional parameters required for token retrieval.

User

Is the primary authorization ID by which you are known to the OData Service. This field appears when Explicit security or OAuth security with the Password Grant Type is selected.

Password

Is the password associated with the primary authorization ID. This field appears when Explicit security or OAuth security with the Password Grant Type is selected.

OAuth Grant Type

Can be one of the following OAuth authentication types:

  • Authorization code.
  • Password.
  • Client Credentials.

This field appears when OAuth security is selected.

Client ID

Is the client ID defined in the OData application. This field appears when OAuth security is selected.

Client Secret

Is the Client Secret defined in the OData application. This field appears when OAuth security is selected.

Access Token

Is the value that identifies the user on whose behalf your OData application is acting. This field appears when OAuth security with the Authorization Code Grant Type is selected. Click Get Access Token to obtain this token.

In order for Get Access Token to complete successfully, the host name used to bring up the Reporting Server Web Console must match the host name set up for the Redirect URI in the OData application.

Refresh Token

Is the Refresh Token returned from the OAuth Token request. This field appears when OAuth security with the Authorization Code Grant Type is selected. The token is used for obtaining a new Access Token at the time a report is run accessing the OData Service for a specific application.

Select profile

Is the profile (server, group, user) in which to store these connection attributes. The default is the server profile, edasprof.prf.

Advanced Connection Options

Add Custom Headers

Check to open a text box in which you can enter Custom Header information required by the OData Service.

Select within Expand

When checked, select within expand OData syntax is not supported.

Advanced HTTP Connection Options

PROXY Server IP Address

Is the IP address of the proxy server.

PROXY Port

Is the port number on which the proxy server listens. The default port number is 80.

PROXY HTTPS Relative Path

When checked, the REST request will send the relative path rather than the absolute path when a proxy server is configured.

SSL Certificate

Is the location of a locally-stored user-provided server x.509 certificates file for SSL authentication. For trusted authentication, the trusted certificate file (trustedcertfile) points to a file of CA certificates in PEM format, as illustrated in the following syntax: 

-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
SSL Mutual Authentication

When checked, Mutual Authentication is enabled.

SSL Certificate Type

Select one of the following certificate types:

  • Trusted. A trusted certificate file can contain several CA certificates. You can add text before, between, and after any certificate which is typically done to provide descriptions of each certificate.
  • Non-trusted. Adds the parameters Key file, Pass phrase, and Label to the configuration pane. Provide an initial path browse value to the SSL Certificate field before browsing. For example:
    C:\, /abc/abc/...
SSL Certificate Key File

Is the private key used for creating the client X.509 certificate in PEM format. This option is used together with a certificate for a non-trusted connection. Provide an initial value to the SSL certificate key file field before browsing. For example: 

C:\, /abc/abc/...
SSL Certificate Pass Phrase

Is the password used to unlock the key file. The value is needed only if the key file is encrypted.

SSL Certificate Label

Identifies a certificate in the file, if the file contains more than one certificate. If the label contains spaces, the label must be enclosed in double-quotes. For example: 

"xxx yyy"

 WebFOCUS

Feedback