Establishing a Connection
This section documents how to provide authentication for your account type and then connect.
Authenticate a SAP ByDesign Account
Set the following connection properties to connect to SAP ByDesign.
- Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
- User: Set this to the username of your account.
- Password: Set this to the password of your account.
- CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property.
Add a new custom ODATA service
- In the SAP ByDesign work center view, click on "Application and User Management".
- Select "OData Services".
- In the dropdown list, select "Custom OData Services".
- Now you should see a list of your current custom services. To add a new one click on "New".
Customizing the SSL Configuration
By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.
Connecting Through a Firewall or Proxy
HTTP Proxies
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Other Proxies
Set the following properties:
- To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
- To tunnel the connection, set FirewallType to TUNNEL.
- To authenticate, specify FirewallUser and FirewallPassword.
- To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.
Troubleshooting the Connection
To show provider activity from query execution to network traffic, use Logfile and Verbosity. The examples of common connection errors below show how to use these properties to get more context. Contact the support team for help tracing the source of an error or circumventing a performance issue.
- Authentication errors: Typically, recording a Logfile at Verbosity 4 is necessary to get full details on an authentication error.
- Queries time out: A server that takes too long to respond will exceed the provider's client-side timeout. Often, setting the Timeout property to a higher value will avoid a connection error. Another option is to disable the timeout by setting the property to 0. Setting Verbosity to 2 will show where the time is being spent.
- The certificate presented by the server cannot be validated: This error indicates that the provider cannot validate the server's certificate through the chain of trust. If you are using a self-signed certificate, there is only one certificate in the chain.
To resolve this error, you must verify yourself that the certificate can be trusted and specify to the provider that you trust the certificate. One way you can specify that you trust a certificate is to add the certificate to the trusted system store; another is to set SSLServerCert.
Navigation Properties As Views
Navigation properties are properties on an entity that is itself either a single related entity or list of related entities. By default, these are exposed as views, although they may be hidden by setting NavigationPropertiesAsViews to false. This property will only have an effect when working with a CustomService as there are no navigation properties when dealing with an AnalyticsService.