Skip to main content

System and System Line Configuration

This section provides all information which is relevant for the configuration of a System Line and a System of kind "Web (any kind of web source)". It can be created and administrated in the Portal's menu System Lines.

There are different types of web sources: As of now it is possible to load CSV-Files, connect to JSON, XML or Odata.

Configuration of a Web System Line​

Usually, a System Line for a Web System might be less relevant than compared to testing environments of databases. However, it could be used to distinguish between testing and productive REST APIs for example. The configuration is equivalent to the other kinds of System Line configurations and requires the following information:

  • Kind: Web (any kind of web source)

  • Authentication: Disabled or Enabled; Disabled allows no further specification of any authentication, in case authentication is enabled, the authentication can be specified in more detail on System level.

  • Short Name: As usual a descriptive and identifying name

Configuration of a Web System​

The configuration for a specific web system depends on the type. E.g. for a JSON Rest Api, a special API-Key in the header might be required for authentication, whereas a simple CSV-File can be loaded without authentication. In general the following System data has to be provided:

System data

  • Short Name: A descriptive and identifying name

  • Location: Assign the System to a Location (has to be created and enabled before)

  • Authentication: Here several opportunities are available, it also depends it enabled on System Line level

    • Delegated: The authentication is specified on the individual Function
    • Configure on System: All Functions based on this System are using the defined authentication procedure. The following are available:
      • Azure AD OAuth2: Use Azure ActiveDirectory OAuth2 SSO for all Virtual Datasets of this system.
      • Shared Basic Auth (User and Password): Define a user and a password which is used for all Functions of this System.
      • Per User Basic Auth (User and Password): A user and a password on Function level.
      • API-Key via Header: Specific authentication information provided in the header.

After providing the system data information and saving additional information might be required:

Authentication Configuration

  • Authentication:
    • In case of Azure AD OAuth2: Specify the AzureAD Scope(s) that should be requested as semicolon-separated list.
    • In case of Shared Basic Auth (User and Password): Define the User Name and the Password which should be used
    • In case of API-Key via Header: Provide the API-Key Header Name and the API-Key Value
note

Per User Basic Auth (User and Password) is not avaliable yet, but will be released in a future version.

Technical parameters

  • Proxy: Provide a proxy which should be used.

Finally, do not forget to check the "Enabled" box and save it to make the System available.