Use this app to manage data from back-end systems is retrieved into Visualization applications.
This app lets you do the following:
Create a new data source
View all the configured data sources
The Data Source application opens with a list of configured data sources.
The list displays all data sources that are configured for you in the system. From here, you can edit existing data sources and add new ones.
The Used For field indicates the way in which this data source is used.
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.
You can use the Name field to enter a name for the data source.
The Description field provides a full free-text description of the data source.
Select this option to choose the service to connect to from a NetWeaver gateway system. For other sources, uncheck this option.
The Create button opens the wizard and allows you to provide information to create a new data source.
You can use the button to rename your data source. The Rename window opens, allowing you to enter a new name.
You can use the button to make a copy of your data source. The Duplicate window opens, allowing you to enter a new name for the copy.
You use the button to remove your data source from the list. The Delete Confirmation window opens, allowing you to confirm deletion.
You use the button to open the data source for editing. This button opens the wizard and allows you to modify your parameters.
The Type field allows you to select the way in which this data source is used.
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 URL field contains the link to the external data source. The URL that you provide must return JSON data. It can be a REST service or an OData endpoint.
If you’re using an OData URL, ensure that you include the parameter $format=json to ensure that the correct format is returned.
For connections to s4 systems, SAP Cloud Platform Cloud Connector is required to connect Cloud Foundry to on-premise. An administrator needs to set up SAP Cloud Platform Cloud Connector and replace part of the URL using a token value.
The Proxy Type indicates whether the specified URL is an internet link or a link to an on-premise system. An on-premise link requires SAP Cloud Platform Cloud Connector, so you need to enter a Location ID. Typically you would choose on-premise unless your administrator advises otherwise.
The Location ID is required if you’re connecting to an on-premise system. The credentials that you enter here are used by SAP Cloud Platform Cloud Connector.
Your administrator advises you if anything needs to be entered here.
The Catalog Service is the path from the base service to the gateway catalog endpoint. Use the default unless your administrator indicates otherwise.
Basic (username and password)
Principal Propagation
OAuth2 Client Credentials
No Authentication.
Where possible, we recommend that you use Principal Propagation.
The User field is required if you’re using basic authentication. You must supply the username with which to connect.
The Password field is required if you’re using basic authentication. You must supply the password with which to connect.
Once you’ve entered the connection information, you use the Test Connection button to verify that the connection can be made. The system either acknowledges that a connection can be made, or reports an error.
The connection to the back-end system can require additional properties. If your administrator requires you to add additional properties, do it here.
You can enter URL test parameters. These entries are valid parameters that can be used to test the connection.
This part 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.
Use to open the Select Properties window.
Select your required properties from the file, and then use the dropdowns to assign specific properties to node attributes. For example, if you selected ParentMaterial as a property from the file, you could then assign it to the node attribute Parent ID.
You must have three assigned hierarchy attributes, but you can add more if necessary.
Choose Use Existing Connection if there is 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 combo box.
Choose Create New Connection to create a new data connection. Your administrator sets up a cloud connection to the on-premise system and provides the connection details.
A unique name for the connection. The connection name is displayed if you want to reuse the connection.
The cloud connector proxy URL.
The cloud connector proxy port.
The on premise system client code.
Available Services displays the list of services that are available in the catalog. Click on a service to use it. Use the search field to filter the list of available services.
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.
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 datasource.
A list of the available entity sets in the selected service. Choose the required entity set.
Check whether the datasource is to address a particular entity.
Include Parameters, if checked, indicates that the “to” end is to address a particular entity instead of the entire entity set.
Supplied by user: The consumer of the datasource provides a value for the key field at run time. This option makes the datasource itself reusable for different key field values.
Static Value: The value of the key field is hard-coded to the value specified in the adjacent input field for all attempts to use the datasource fetch data. The user of the datasource doesn’t have the flexibility to provide a value for the key field at run time.
Function Imports displays a list of the available function imports in the selected service. Select one from the list.
Supplied by User: The consumer of the datasource provides a value for the function import parameter at run time. This option makes the datasource itself reusable for different key parameter values.
Static Value: The value of the parameter is hard-coded to value specified in the adjacent input field for all attempts to use the datasource fetch data. The user of the datasource doesn’t have the flexibility to provide a value for the key field at run time.
Association Set is a list of the available association sets in the selected service. Select one from the list.
An association represents a relationship between two entities. The relationship has a 'From' end and a 'to end. An association set is a collection of association instances. An association set has two ends,(From and To), and each is represented by an Entity Set. Including parameters to filter the two ends entities is optioonal.
Supplied by User: The consumer of the datasource provides a value for the key field at run time. This option makes the datasource itself reusable for different key field values.
Static Value: The value of the key field is hard-coded to a value specified in the adjacent input field for all attempts to use the datasource fetch data. The user of the datasource doesn't have the flexibility to provide a value for the key field at run time
Supplied by User: The consumer of the datasource provides a value for the key field at run time. This option makes the datasource itself reusable for different key field values.
Static Value: The value of the key field is hard-coded to a value specified in the adjacent input field for all attempts to use the datasource fetch data. The user of the datasource doesn't have the flexibility to provide a value for the key field at run time.
The Location ID is required if you’re connecting to an on-premise system. The credentials that you enter here are used by SAP Cloud Platform Cloud Connector.
Your administrator advises you if anything needs to be entered here.
Basic (username and password)
Principal Propagation
OAuth2 Client Credentials
No Authentication.
Where possible, we recommend that you use Principal Propagation.
The User field is required if you’re using basic authentication. You must supply the username with which to connect.
The Password field is required if you’re using basic authentication. You must supply the password with which to connect.
If using OAuth2 Client Credentials, supply the client ID.
If using OAuth2 Client Credentials, you must supply the client secret.
If you’re using OAuth2 Client Credentials, you must supply the client token service URL.
You must provide any additional information name value pairs that are required by the server to establish a connection (ex. sap-client).
Press Save Connection to save the connection information that you’ve entered.
Press Save and Test Connection to save your entries and test the connection. The connection is saved regardless of the test outcome.
Filter and Projection settings on connection response. These are your mapping properties.
Data Preview shows a preview of the filtered and mapped results from the connection response.
You use the Synchronize button to force a refresh of the mapping result.
The Connection Parameters list contains parameters and their values used to test the connection.
The Mapping Parameters list contains parameters and their values used to test the mapping.
In this field, you enter a JSON Path string that is executed against the service response and identifies a JSON result.
Object: The JSON Path identifies a result that is a single JSON object
Others: The JSON Path identifies a result that is an array
Select the properties from the filter response and map them to the data source result.
Group By determines the JSON string that identifies a property by which to group the results. Optionally, you can have the grouping property passed in as a parameter to the datasource by using the special parameter syntax __paramName__. At runtime, the __paramName__ is substituted in the expression and then used to perform the grouping.
The Preview table shows a result preview of the mappings configuration.
You can use Cancel at any time to discard current progress in data source creation.
The Message Strip indicates the kind of attribute [object/array] that needs to be selected for the type of datasource being created.
Parameters and their values used to test the connection.
The window shows a tree representation of the connection test response. Expand the tree hierarchy to view the results and choose the required JSON object that represents the relevant business data.
The list of available properties from the selected JSON mapping. Select the properties from the list to map to the data source result.
Attribute of the filter result object. Check if the attribute needs to be present in the projected result.
Depending upon the type of datasource, some of the property mappings can’t be renamed or deleted.
Hierarchy: name, id, parent
List: name, group, value
Group: name, id
The Non-Single Attribute Mapping button is used to create a new attribute mapping.
Name of the attribute in the projected result
Deletes this attribute mapping.