Basic Tab
This section documents how to provide authentication for your account and service type and then 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".