Skip to main content

Configure the First Function

The following, we describe the first steps in order to get data into an application, in this example we focus on Microsoft Excel. Therefore, we need a Source System where the data is located and a Function which defines the kind of retrival. In this example, the Function should enable you to download the German gross domestic product (GDP) from the Bundesbank database, which is publicly available.

Create a System Line and a System​

First of all, we have to define the source of the data. In VDP this is done by a System Line and a System. Both components can be created and configured in the VDP Portal in the left sidebar menu under 'System Lines'.

warning

A new System Line requires an installed and running Agent. So make sure that you have already created one.

The menu will provide a list of all already configured System Lines. In order to create a new one, click on the button 'New System Line' on the top left. The following window will appear:

Create System Line

As shown in the screenshot, you have to enter the following information:

  • Type of System Line: Web
  • Short Name: TestWebSystemLine, or feel free to enter another name

Depending on the type of the System Line, additional options may be available. For the selected Web type, for example, you can enable or disable authentication.

After saving, you can proceed directly to creating a System. Click the 'New System' button to create one. The following window will appear:

Create a new System

Enter the following information:

  • Short Name: TestWebSystem
  • Location: Here you have to select the Location and the Agent you have created before.

If 'Web' is selected as the System Line type, a PROXY and TRUSTED_CERT_HASH can be configured; however, both are optional.

warning

If a warning indicates 'no Agent available' no Agent is instantiated and has to be configured first.

Every system line requires a default system. The initially created one is automatically the default. Now the System Line 'TestWebSystemLine' will appear in the System Line overview, including the System 'TestWebSystem'.

Create a new Function​

Based on the System Line, the first Function can be created. In VDP, a Function is defined as a so-called Virtual Dataset which are grouped in Workspaces. Thus, a function can be created within the menu 'Virtual Datasets'. Select 'MyCompany' as the workspace, as this is the one making the function available to everyone. In the opened window, click on the '+' sign for 'Create a new Virtual Dataset'. A new window will appear where you need to select the function as a Virtual Dataset.

Create first Function

In the following, additional windows will guide you through the process. First, the System Line has to be specified. In the given example this is the previous configured 'TestWebSystemline'. Just select it an continue to the configuration of the Query Handler. There, define the Function as follows:

  • Select Query Handler: CSV
  • COLUMN_DELIMITER: ';'
  • COLUMN_INDEX: 0;1
  • COLUMN_NAME: DATE;VALUE
  • ROWS_TO_SKIP: 5
  • URL: Bundesbank Website

Continue with the configuration of the authentication. This Function connects to the Deutsche Bundesbank as a publicly accessible data source. The Bundesbank provides the relevant data via public endpoints that do not require authentication (e.g., no API key, OAuth token, or client certificate).

Finally, the Function has to be defined by a 'Short Name' and assigned to a Category. As this is the first Function to be configured, no Category should be available. Thus after entering 'Bundesbank' as 'Short Name', click on 'Create a New Category'.

A new window pops up where you have to enter the following:

  • Short Name: WEB
  • Color: Select an arbitrary color or one which is in line with department or company

create Category

The new Category is available after clicking on 'Create'. Now the Function can be assigned to the new Category 'WEB'. With this, all required information is provided and the Function can be created by clicking on 'Create Virtual Dataset'.

Now a new window pops up, structuring all entered information:

Try in Test Bench

Test a new Function​

The function can be tested in the 'Test Bench'. A test execution of the function is triggered by clicking the 'Execute' button. If all configuration settings are correct and an agent is available, the results will look similar to the following:

Results shown in the Test Bench

The results in the screenshot show two columns, 'DATE' and 'VALUE', as well as that the query took approximately 7715.00 milliseconds to execute. With this, a first example function has been successfully configured.