IBM Support

How to Validate Planning Analytics ODBC Data Connector (ODBCIS) Connection via API

Troubleshooting


Problem

The steps in this document assist you in validating your connections to a running Planning Analytics ODBC Data Connector (ODBCIS) service, using the API

Diagnosing The Problem

Retrieving Planning Analytics ODBC Data Connector Data Sources via API
  • Using your tooling of choice, create a GET request to the Planning Analytics ODBC Data Connector URL
    • http(s)://server.domain.com:port/api/v1/DataSources
  • With the GET request, ensure you pass the appropriate Authorization header
    • The format of the header is 'Authorization: Basic dXNlcjE6cGFzc3dvcmQx'
    • Where dXNlcjE6cGFzc3dvcmQx is the base64 encoded value of your username/password
  • Execute the GET request, if successful, the datasources will be returned in JSON format: 
    • { "@odata.context": "$metadata#DataSources","value": [{"Name": "TestSQLODBC","Description": "SQL Server"}] }
       

Common Errors Connecting to Planning Analytics ODBC Data Connector
  • Timeouts / Unable to Connect
    • Ensure the port specified is correct
      • Check the config.internal.json file, odbcis-gateway serverPort parameter
    • Ensure that the port is allowed through the firewall
    • Ensure the IP connecting to the service is allowed through the firewall
  • Certificate Errors
    • Ensure the certificates specified are from a trusted Certificate Authority
    • See: https://www.ibm.com/docs/en/planning-analytics/2.0.0?topic=upaodc-using-custom-tls-certificates-in-planning-analytics-odbc-data-connector
  • 401 / Authentication Failed
    • Ensure the username and password provided is accurate, and that the base64 encoded value is correct
    • The username and password should reflect a username and password in the Clients section of config.odbcis.json

       

Resolving The Problem

CURL Example:
  • curl --location 'https://1.2.3.4:5555/api/v1/DataSources' --header 'Authorization: Basic dXNlcjE6cGFzc3dvcmQx'
POSTMAN Example:
  • image-20230926120146-1

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSD29G","label":"IBM Planning Analytics"},"ARM Category":[{"code":"a8m50000000KzIzAAK","label":"Planning Analytics-\u003EPlanning Analytics Workspace"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
16 April 2024

UID

ibm17039407

Page Feedback