“Configuration” tab

In the “Configuration” tab, you can specify the SQL query statement and specify the columns of the result list.

Specify the SQL query

In order to specify the SQL query statement, proceed as follows:

  1. Go to the “Configuration” tab.
  2. Enter a SQL statement in the input field “Query”.
  3. Possibly enter a report filter.
The screenshot shows an example of a SQL query that retrieves product numbers, product names, statusses and creation dates. Hereby, the query only captures products where at least one of the four status traffic lights does not have the status “Green” (2).
  1. Click on the SAVE button to save your settings. If the process was successful, a corresponding message will appear. The SQL query is now defined.
Note
Reports are based on SQL queries. Hence, setting up a report requires SQL skills.

Specify columns for the report output

In the “Columns” card, you can specify the columns of the report output according to the table columns retrieved by the SQL statement. Here, every entry in the table stands for a table column that was retrieved by the SQL query. If, as shown above, the SQL query retrieves product numbers, product names statuses and creation dates, you need to specify the corresponding columns for the output of the report result.

In order to assemble the columns which are required for the output of a report, proceed as follows:

  1. Create a new column entry:
    1. Click on the CREATE button in the footer of the “Columns” card to call up the corresponding dialog box.
    2. Select a renderer from the menu.
    3. Click on the SAVE button. Afterwards the dialog box closes and a new entry appears in the table.
  1. Enter the column names for the different languages:
    1. Double-click in a corresponding table cell.
    2. Enter the column name for the respective language and leave the table cell.
    3. Repeat the procedure for the other languages.
  1. Add further column entries for any of the required columns as described above.
As an example, the screenshot shows the columns that are required for the SQL statement that is shown further above.
  1. Click on the SAVE button to save your settings. If the process was successful, a corresponding message will appear. The report is now set up and configured to the point that it can be run.
Note
Make sure that the sequence of the renderers is the same as the sequence of the table columns in the SQL statement.
INFO
If you want to move a table entry to another position in the sequence of entries, click on the button in the respective table row, hold the mouse button down, drag the table entry to the desired position and release the mouse button. And if you want to delete an entry, move the mouse cursor over the entry and click on the button.

Specify parameters (optional)

Parameters can be used to limit the result of a report via additional query values. If you define corresponding parameters, you can enter or select the desired query values via a dialog box during a manual report execution. But you can also define standard query values, e. g. for the automated execution of reports via correspondingly defined jobs.

In order to define parameters, proceed as follows:

  1. Create a new table entry:
    1. Click on the CREATE button in the footer of the “Parameters” card to call up the corresponding dialog box.
    2. Select a parameter type from the menu.
    3. Click on the SAVE button. Afterwards the dialog box closes and a new entry appears in the table of the “Parameters” card.
  1. Specify if the parameter is optional or mandatory. To do so, double-click in the table cell of the “Optional” column, select the appropriate option from the menu and leave the table cell.
  2. Specify a default parameter value. To do so, double-click in the table cell of the “Default value” column, select the appropriate option from the menu and leave the table cell.
  3. Enter the parameter names for the different languages:
    1. Double-click in a corresponding table cell.
    2. Enter the parameter name for the respective language and leave the table cell.
    3. Repeat the procedure for the other languages.
  1. Possibly specify further parameters as described above.
The screenshot shows exemplary parameters that enable the user to select a category of the primary taxonomy when the report is run manually. Furthermore, it is determined that query is carried out on the level of the currently selected language.
  1. Click on the SAVE button to save your settings. If the process was successful, a corresponding message will appear.
INFO
If you want to move a table entry to another position in the sequence of entries, click on the button in the respective table row, hold the mouse button down, drag the table entry to the desired position and release the mouse button. And if you want to delete an entry, move the mouse cursor over the entry and click on the button.

FAQ

Why do the columns need to be arranged in a particular order?

Make sure that the sequence of the renderers is the same as the sequence of the table columns in the SQL statement.

What are parameters used for in a report?

Parameters can be used to limit the result of a report via additional query values. If you define corresponding parameters, you can enter or select the desired query values via a dialog box during a manual report execution. But you can also define standard query values, e. g. for the automated execution of reports via correspondingly defined jobs.