Creating a New Data Source

You can create a new data source using a wizard. This topic provides step-by-step instructions on how to provide basic information, select the type and service of the data source, define the connection details, map the data structure, and test and save the data source. The wizard assists you in creating data source links, which can be used to provide additional information when viewing visualizations and making associations.

You use the wizard to create data source links. You can then use the external data to provide additional information when viewing visualizations in the Viewer, and you can also use it to make associations.

The wizard assists you through the following steps:

Step	Description
Basic Information	Provide a name for the data source, a description, and the way in which it’s used. The Type field options are as follows Object: Populates data in a Properties panel. Returns a single JSON object. Each object is displayed. List: Populates data in a Properties panel. An example use case is in the Manage Templates app. Grouping: Populates data in charts. This option provides external information in the Manage Templates app. Hierarchy: Populates data for use with Associations. This data enables you to create an association hierarchy. The Service Type field options are as follows Integrated Service: Select this option to choose an integrated service. SAP Netweaver Gateway: Select this option to choose the service to connect to from a NetWeaver gateway system. Other: Select this option for all other cases. Note Once you choose the next step of the wizard, it is no longer possible to change your selections for data type or service type.
SAP Netweaver Gateway	Note This wizard step is only required if you’ve chosen to connect via SAP Netweaver Gateway. You have the option to use an existing connection or create a new connection. Use Existing Connection: Choose this option if there’s already a data source that connects to the gateway system, and you want to reuse the existing credentials. Select the connection to use from the Existing Connections field. Create New Connection: Choose this option to create a new data connection. Your administrator sets up a cloud connection to the on-premise system and provides you with the connection details. To create a new connection, you provide: Name System Port Client Proxy Type: Indicates whether the URL is an internet link or a link to an on-premise system. An on-premise link requires SAP Business Technology Platform Cloud Connector. Location ID: Used by SAP Business Technology Platform Cloud Connector to pass login information. Note This field must be populated when connecting to an on-premise system but isn’t required for an internet proxy type. Catalog Service Authentication: Choose authentication applicable to the URL that you wish to use. There are four authentication methods: Basic (username and password) Principal Propagation OAuth2 Client Credentials No Authentication. OAuth2 Password Grant Recommendation Where possible, we recommend that you use Principal Propagation. When you have defined your connection details, click Test Connection. If the test was successful, then choose the next step in the wizard.
Service Details	Note This wizard step is only required if you’ve chosen to connect via SAP Netweaver Gateway. Search for and select a service from the list. The Entity Set Container options are available if the selected service contains any OData entity sets. Select the Entity Set option if it’s an entity set that contains the information you need to return from your data source, and choose the required entity set. Function Import: Enabled if the OData service exposes function imports. Select this option if it’s a function import that returns the information you need to return from your data source. Association Sets: Enabled if the OData service exposed any association sets. Select this option if data from the association set is what is required in the data source. When you have defined your data, click Test . If the test was successful, then click Save to save the service details. Choose the next step in the wizard.
Connection	This step of the wizard involves mapping your data source to the data structure required for the type of usage you’ve selected. The data connection requirements vary, depending on the selected data type and service type. For `SAP Netweaver Gateway` service types, enter the location ID and authentication method, and check the values which default. For `Integrated Service` service types: Service: Select an integrated service from the dropdown list. Note The authentication method is automatically dervied from the service. End Point: Copy the required end point from the SAP API Business Hub. For `Other` service types: URL: The link to the external data source. The URL provided must return JSON data. It can be a REST service or an OData endpoint. Recommendation If you’re using an OData URL, ensure that you include the parameter $format=json to ensure the correct format is returned. Note For connections to SAP S/4HANA systems, SAP Business Technology Platform Cloud Connector is required to connect Cloud Foundry to on-premise. An administrator needs to set up SAP Business Technology Platform Cloud Connector and replace part of the URL using a token value. Proxy Type: Indicates whether the URL is an internet link or a link to an on-premise system. An on-premise link requires SAP Business Technology Platform Cloud Connector. Location ID: Displays only if on-premise connection is required. Authentication: Choose authentication applicable to the URL that you wish to use. There are four authentication methods: Basic (username and password) Principal Propagation OAuth2 Client Credentials No Authentication. OAuth2 Password Grant Recommendation Where possible, we recommend that you use Principal Propagation. In all cases, you are required to Select an HTTP method For `PUT` and `POST` methods, an additional code field displays. Specify a connection timeout period Enter JSON transformation rules in the JSON Transformation field. This is an optional step. The text field helps you to specify JSON transformation rules so that you can modify or restructure data in the JSON format in the respone body section. You can modify JSON payload from data source to match expected structure in a format which can be used by the Business Data service. Note You can only use JSONata syntax in the JSON Transformation field. Add one or more custom headers and their values, if the new data connection requires any HTTP header. Once you’ve entered the connection information, click Test to check the connection. The system returns a raw response to acknowledge that a connection can be made, or to highlight an error. The raw response contains the response from the backend server, and does not contain any mapping or alterations. The raw response contains: The HTTP status code The HTTP reason The response body If the response body is JSON, the syntax is highlighted in the response. For any other text types, the reponse is show as plain text. Once you’ve tested the connection, click Save to save the connection to the backend.
Mapping	This step of the wizard is where you transform the returned dataset into the data structure required for the type of usage you’ve selected. The mapping required varies, depending on the type of data source. Click (Value Help) to choose the result attributes and properties for your required mapping. Note A grouping data source, then you must use at least two properties with their names An object data source is expected to return a single JSON object A hierarchy data source is expected to return a list of JSON objects with at least three well-defined properties . Once you’ve entered your data mapping, click Test to test the data. Once you’ve tested the data mapping, click Save to save the data source. The data source is now listed with all data sources.