SAP ByDesign Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium SAP ByDesign connector.

SAP ByDesign is a cloud ERP solution offering end-to-end business management for small to mid-sized enterprises.

This topic describes how to authenticate to SAP ByDesign and configure any necessary connection properties in the SAP ByDesign connection connector.

Prerequisites

Provide authentication for your account and service type before you connect.

Authenticate a SAPByDesign Account

Set the following connection properties to connect to SAP ByDesign.

Connect to a Analytical Service

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com.

  • ServiceType: If you want to retrieve the reports of a analytical service, specify ServiceType=AnalyticsService;.

  • ServiceName: The name of the service you want to retrieve data from. Only none or one service must be specified. If you want to specify a list of services, see BrowsableSchemas.

    If you’re not sure what service to specify, you can always query the sys_schemas to list available services.

  • User: Set this to the username of your account.

  • Password: Set this to the password of your account.

Analytical Service Connection String Example:

Url=https://test.sapbydesign.com;ServiceType=AnalyticsService;ServiceName=cc_home_analytics.svc;User=Test;Password=test;

Connect to a Custom Service

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com.

  • ServiceType: If you have a custom service you want to retrieve data from, specify ServiceType=CustomService;.

  • ServiceName: The name of the service you want to retrieve data from. Only none or one service must be specified. If you want to specify a list of services, see BrowsableSchemas. If you’re not sure what service to specify, you can always query the sys_schemas to list available services.

  • User: Set this to the username of your account.

  • Password: Set this to the password of your account.

Custom Service Connection String Example:

Url=https://test.sapbydesign.com;ServiceType=CustomService;ServiceName=khsalesorder;User=Test;Password=test;

Connect to the ODataDataSource API

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com.

  • ServiceType: If you want to query OData Data Source API( odata/analytics/ds) , specify ServiceType=ODataDataSource.

  • ServiceName: The name of the service you want to retrieve data from. Only none or one service must be specified. If you want to specify a list of services, see BrowsableSchemas. If you’re not sure what service to specify, you can always query the sys_schemas to list available services.

  • User: Set this to the username of your account.

  • Password: Set this to the password of your account.

ODataDataSource Connection String Example:

Url=https://test.sapbydesign.com;ServiceType=ODataDataSource;ServiceName=Customer.svc;User=Test;Password=test;

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”.

SAP ByDesign URL Restrictions

The SAP ByDesign connector enforces URL restrictions to avoid exceeding the maximum of allowed URI length, which causes the service to throw “URI Too Long” error"

By default, the length of the columns in the projection is limited to 1000 characters. If the columns selected in the projection surpass this limit, the connector drops the projection specification and retrieves all fields. This may impact performance because of service response delay and increased payload.

In the case of the analytical service (ServiceType=AnalyticsService), the connector throws an error indicating you must reduce the number of columns in the projection. In addition, the server-side filter length is restricted to 1000 characters for the same reasons. If the generated filter length surpasses this limit, the connector drops the additional filters and handles them client-side.

In SAP ByDesign, you can configure or disable these limitations by using the MaxSelectLength and MaxFilterLength hidden connection properties. These properties both default to 1000 characters. If your service does not have these restrictions, set the properties to -1 to disable the length limitations.

Connection Configuration

Each connection property available in the SAP ByDesign connector is explained below.

Connection Name

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

URL

URL to your system host name.

Service Type

Specify the type of the service to get reports from. Used together with the Url and ServiceName connection properties to determine the service from where to retrieve data from.

Possible Values:

  • AnalyticsService: If you want to retrieve reports from analytic service.

  • CustomService: If you want to want to retrieve data from the custom service you have configured in the UI.

  • ODataDataSource: If you want to query the DataSources (OData Data Source API -> odata/analytics/ds ).

User

The SAP ByDesign user account used to authenticate.

Password

The password used to authenticate the user.

Service Name

Specify the SAP ByDesign service name to connect with.

Leave this empty to retrieve all services.

Enable SSL

Option for creating the connection with SSL enabled.

Upload Keystore File

Option to upload keystore file.

Advanced Configurations

This section contains additional configuration parameters.

A boolean indicating navigation properties should be promoted to full views.

This property can be useful for SAP ByDesign, which can return related collections of entities, or navigation properties.

Some SAP ByDesign entities may only be accessed through navigation properties.

Navigation Properties As Views will cause all of the discovered navigation properties to be added as views in the format ParentTable_NavigationProperty.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.

If you have any feedback on Gathr documentation, please email us!

← SAP BusinessObjects BI Incremental Configuration
SAP ByDesign Ingestion Source →