Data Source Designer¶
The Data Source Designer is the tool used to create Data Sources which can be used with the Lobby Elements. The tool is divided into three parts, Properties, Data Source Browser and Preview Data. Also it's possible to Import/Export Data Source Definitions and find Usage of Data Source using the Data Source Designer.
There are different option to open the Data Source Designer tool.
- From the navigator entry 'Lobby Datasource Designer' (Solution Manager -> Configuration -> Lobby -> Lobby Datasource Designer)
- By clicking on the zoom icon next to the 'Datasource' field in the element designer
SQL Data Source Properties¶
When using an SQL data source the following properties are defined:
- Data
- Columns
Definition¶
This section includes following configuration settings:
| Property | Description |
|---|---|
| Name | The name of the Data Source |
| View | The Database view used to create the Data Source |
| Condition | The condition to be used for the 'WHERE' section in the query. Here it is possible to use Page Parameters defined in the Page Properties Configuration dialog. E.g. Company = $COMPANY$. Remember to append the $ sign. |
| Group By | The column to be used to group the data |
| Order By | The column to be used to order the data |
¶
Figure: Example Definition
Columns¶
This section is used to manage which columns to use from the view. You can add columns, remove columns and re-arrange the order of the columns.
Figure: Columns Section
There are two options to add a column.
- Click Add button and a new row will be created where you can manually type Column, Description and select Type.
- Click View Columns button which opens the column chooser dialog. All available columns in the view are displayed in the left side of the dialog, select a column and click on the swap button in the middle to add it.
¶
Figure:Column Chooser
Information¶
In this section you can see/modify the author of the data source, define key words to make it easier to find the data source in the Data Source Designer and write a text with additional information about the page etc. The following is available:
| Property | Description |
|---|---|
| Author | Author of the Data Source |
| Keywords | Keywords which can be used when searching for the Data Source |
| Descriptive Text | Description about the Data Source |
| Last Modified | Last Modified Date and Time of the Data Source |
| Copied From | If the Data Source is a copy of another Data Source, this field shows the name of the Original Data Source |
| Protected | Check box to Protect/Unprotect configuration. When the Configuration is protected by the author, the configuration properties are disabled to discourage modification. There will be a banner message shown in the top area of the Data Source Designer in this case, and it's possible to enable the configurations back using the Edit Anyway button in the Banner. |
Figure: Information Section
Preview¶
Verify that the created Data Source is working properly in the Preview section. Use the Preview button to run the Database query and check whether the required set of data is received. There can be some database queries which includes Parameters, by clicking on the 'Parameters' button it's possible to change the values of the parameters from 'Page Parameters' dialog and preview the data.
Data Source Browser¶
All the existing SQL Data Sources are listed in the Data Source Browser. Click on a Data Source in the Data Source Browser to select a Data Source and load it to the Data Source Designer. Also it's possible to search for a Data Source.
Usage of Data Source¶
You can find out Elements which use the selected Data Source by clicking 'Used In' button in the tool bar.
Figure:Tool Bar
Import/Export Data Source definitions¶
Data Source definitions can be exported into an XML file using the "Export" button available in the Data Source Designer. Also a Data Source definition can be imported from an external file using the "Import" button.
Figure: Import/Export Buttons