# The &knoda; user's tutorial

## The example database "exampledb"

The following chapters describe the example database that will be the basis for all &hk_classes; tutorials and manuals.

The database is a literature database; it should store the author's names and the titles of their literary works. The data I have actually used in this example database are the names of three famous 18th century German authors and some of their plays.

database name: exampledb

The database contains two tables

- authors

- literature

which are in a one-to-many relationship, which means that a author could have written one or more texts.

### The "authors" table

### structure of the "authors" table

Fieldname | Type | Description
author_id | auto increment | unique identification number for each author
name | text 255 | the name of the author
birthyear | text 6 | year of his birth
deathyear | text 6 | year of his death

### the data in the "authors" table

author_id | name | birthyear | deathyear
1 | Goethe, Johann Wolfgang von | 1749 | 1832
2 | Schiller, Friedrich von | 1759 | 1805
3 | Lessing, Gotthold Ephraim | 1729 | 1781

### The "literature" table

### structure of the "literature" table

Fieldname | Type | Description
literature_id | auto increment | unique identification number for each book or poem
author | integer | the author id
title | memo | the title of the book

### the data in the "literature" table

literature_id | author | title
1 | 1 | Götz von Berlichingen
2 | 1 | Faust
3 | 1 | Iphigenie auf Tauris
4 | 2 | Don Carlos
5 | 2 | Die Räuber
6 | 2 | Wallenstein
7 | 3 | Nathan der Weise
8 | 3 | Minna von Barnhelm

## Starting &knoda;

The binary (program) is called 'knoda' and will be installed in your KDE-BINDIR directory. When you launch &knoda; you will be presented with the dialog shown on knodamain. The "Connect" button connects you to the selected SQL-database driver (either MySQL, PostgreSQL, SQLite or ODBC).

To use the ODBC driver you first have to setup an ODBC datasource. See UnixODBC.org for details.

### The knoda window

If you always use the same database driver you can either preselect it in the options menu (see generaloptions) or preselect it with the command line option -d.

A simple

    horst@notebook:~ > knoda -d mysql

will connect &knoda; to the MySQL driver and bypass the above dialog.

Once connected to the driver, the password dialog will appear. Here you have to enter your username, password and the host where your SQL-database server is running.

### The password dialog

## The main window - creating a new database

Once you have successfully logged in, the main window will be displayed, listing all your existing databases on the server in the combobox in the top toolbar. The list view on the left side shows your already existing tables, queries, forms and reports of the currently selected database. The name of the selected database will be shown on top of the listview and in the combobox.

### The main window

In our case, we want to create a new database. Double-click the current database name in the list view or select it in the listview. After confirming the new name by pressing the 'OK' button, the new database is inserted into the list of the combobox, from where you can select it.

If you want to create a new object (a database, table, query, form or report ) in &knoda;, you have three possibilities

- Double click the object you want to create in the listview. Example: To create a new table double-click on the word "Tables"

- Select the object you want to create in the listview, then select 'New' in the 'Actions' menu

- Select the object you want to create in the listview, then click on the very left button of the main tool bar

## Tables - creating a new table

To create a new table, double-click "Tables" in the list view.

We will now create the "authors" table. A tabledesign dialog will be displayed. As we define fields (columns), they will be listed in the box on the left hand side. It should be empty at this point. To create a column, press the "New Field" button. You will then be presented with default values in "Fieldname", "Fieldtype", "Size", "Primary Index" and "NOT NULL" fields. You should change the default values to describe the column you want to create.

Now define the columns for the "authors" table, using the values shown in the tabledesign window in f3

To alter a definition of a column, select it in the left hand side list box and alter the values displayed in the upper right fields.

### The tabledesign window

Always define a unique / primary index in each table, otherwise you will experience some ugly side-effects when updating your data! The most convenient way to create a unique primary index is to use the "Auto Increment" field.

The following fieldtypes are valid:

- text: fixed length (usually defined in SQL as CHAR(size))

- auto_inc: if the databasedriver supports this fieldtype then it will get a unique number automatically whenever a new row is be added. This is typically a readonly column

- small integer: an integer in the range -32768 to 32767

- integer: an integer with the maximum range the database server can handle

- small float: a small (single-precision) floating point field. Allowable values in MySQL are '-3.402823466E+38' to '-1.175494351E-38', '0', and '1.175494351E-38' to '3.402823466E+38'.

- float: a normal-size (double-precision) floating point field with the maximum range the database server can handle. Allowable values in MySQL are '-1.7976931348623157E+308' to '-2.2250738585072014E-308', '0', and '2.2250738585072014E-308' to '1.7976931348623157E+308'.

- date: a date field to store days, months and years

- datetime: a date and time field to store days, months, years, hours, minutes and seconds.

- timestamp: a date and time field to store days, months, years, hours, minutes and seconds. On some SQL servers the value will be automatically set and is read-only

- time: a time field to store hours, minutes and seconds.

- binary: a binary field to store data of more or less any size.

- memo: a text field to store data of more or less any size.

- bool: a field that is either 'true' or 'false'

There are two buttons in the upper left hand corner known as the "View Mode" buttons. The left hand button is the "Design" button, which should already be pressed, and the right hand one is the "Table Data" button. When you have completed your data-input, press the right button ("Table Data" button) at the top of the window.

All high level widgets like tables, queries and forms operate in two modes, a design mode and a view mode. At the top of each window is a horizontal toolbar with at least two buttons. The left button selects the design mode and the right button the view mode.

After pressing the "Table Data" button, you will be asked if you want to alter the table. Confirm this question with the 'OK' button. The next dialog will prompt you for the name of the new table to which you enter "authors" and confirm by pressing the 'OK' button.

After that an empty grid is shown where you can interactively enter the data for each row. Start to enter the data in the row with the arrow. After the input of the first row, the last row will begin with a "*" and is empty. This is a new row where you can enter new data.

### The tabledata window

Enter the values for the first three rows as shown in the example. You will note that the vaules for the Auto Increment field "author_id" will be automatically generated.

The bottom left hand corner of the table data window contains seven buttons and a field. These are the row selector buttons. The arrow buttons allow you to navigate between rows. The extreme left button (the '-' button) deletes the selected row. The button with the check mark on the right stores the changes made and you can add a new row by using the '+' button on the extreme right.

Now you can create the second table, "literature", on your own. Enter the first eight rows manually. As you can see, it is difficult to ensure that the manually input value in the field "author" of the "literature" table has an equivalent value in "authors" table.

The next figure shows how your "literature" table should look.

### The "literature" table

You can print the table contents with the print button.

## Queries

One of the reasons of having a database full of data is that you would like to extract that data using various criteria. There are 2 ways to create queries: Either you create it with a graphical user interface - called 'Query by example' - or you write your SQL code into an editor.

For all kinds of queries please keep the following in mind: If your column names contains non-ascii characters (e.g. German umlauts), or you need to delimit text, you have to use the following standard delimiters (independent from your SQL-server)

- textdelimiter: ' (quote)

- identifiers: " (doublequote)

This way identifier names will be case-sensitive and much more important SQL-server independent. It is recommended to always use these delimiters.

#### Using query delimiters

    SELECT "my table"."my field" FROM "my table" WHERE "my field" > 'my search text'

### Query by example

First add the datasources with the help of the 'Add datasource'-button (the one with the small yellow '+'). The relation between the datasources can be created via drag&drop. Now you can add the columns that should be displayed in the result set. Conditions can be added in the rows starting with "Criteria". All conditions in the same row will be 'AND'-combined, different rows will be 'OR'-combined.

Now we want to add a calculated field. We want to display the age of the authors (the difference between the year of his birth and the year of his death). Leave the 'Table'-cell empty and add '"deathyear"-"birthyear"' in the "Fieldname"-cell. To have a better header for the result set, you can add 'age' into the 'Alias'-cell.

#### Query by example window

Relations between two datasources can be created with 'drag and drop'. Click on the field of interest of the first table and while holding down the mouse button move the cursor to the field of interest in the second table and release the mouse button. A dialog will appear that let you set all equivalent column names. To edit a relation double-click the relation line (best is to click it on the arrow).

### SQL statements

Create a new query as you did for the QBE-query. You can now change to the SQL window by clicking on the already selected "use QBE"-button.

#### Toggle button to switch between QBE and SQL window

Now you can enter the following SQL-statement into the empty window that is displayed:

    select name,title from authors, literature where author_id=author

and press the "View mode" button on the upper left corner.

The result looks similar to the table you created before, but with only two columns. The difference here is that query results are always read-only.

To save your query click the 'x' in the upper right corner or the 'door-symbol' on the query-window toolbar. A dialog is opened giving you the opportunity to give your query a meaningful name, such as "name-and-title". Confirm your input by pressing the 'OK' button.

Do not use TRUE or FALSE in your query statements. Use %TRUE% and %FALSE% instead. Some SQL database servers do not support the use of boolean fields, so the &hk_classes; have to simulate boolean fields. A valid SQL statement would be:

    select * from mytable where myboolfield=%TRUE%

## Forms

Now let's create a new form. We will design the form to allow us the ability to browse the authors and display the titles of their literature.

Double-click "Forms" in the list view. The formdesign dialog window will then be displayed. This window has a vertical toolbar on the left hand side. The "Property editor" dialog is then also displayed.

### The formdesign window

### The toolbar

The toolbar is used to select objects for placing on the form. Possible objects are:

- label: a label displays (static) text on the form

- lineeditfield: shows the actual row data of a specific column of a datasource

- gridfield: shows all data of a datasource in a grid

- memofield: like a lineeditfield, but allows you to handle multiline data

- booleanfield: a datafield that has two states: true and false

- combobox: like a lineeditfield combined with a listbox to select from predefined values

- button: starts an action when clicked

- image: shows an image, either data-aware or stored within the form

- date: lets the user select the date within a calendar style widget

- row selector: lets you browse the rows of a datasource

To place an object on the form, select the relevant button from the toolbar and then click on the position in the form where you want the object to be displayed.

In our example we want to display the author's name, so we do this by using the lineeditfield object. This object on its own will look meaningless to the user. So we will create a label with some meaningful text and put it in front of the lineeditfield. To align these two objects horizontally, click on the first one, while pressing and holding down the Control key and click on the second object. This will select both objects. Now click the right mouse button and select "Align".

#### The formdesign window

The next task is to change the properties of the objects.

### The property editor

We will first change the properties of the label. Click on the Label object in the Form window and click on the "Data" tab in the Property Editor window if it is not already selected. Enter the text "Author" into the entry field to the right of "Label". This text will be displayed on the form.

Now we need to provide a link from the lineeditfield object to a datasource in your database from where the data will be extracted and displayed. Click on the lineditfield and then click on the "Data" tab in the Property Editor window. Click on the button marked "..." to the right of the Datasource field and select the datasource "based on table authors" (at the top of the displayed formdatasource dialog). The other fields are not of interest at this time. Click the "Add" button. Now you have linked the form field to a column in your database.

#### The form datasource dialog(1)

You can also use a graphical interface for defining the datasources. Click

Select the newly created datasource in the datasource field (the value should be "authors(0)") and the column "name" in the column field in the Property Editor window.

#### The property editor

Now let's try to browse your data in the database. Click on the "view mode" button on the form window. You can now see the name of the first author in our list, namely Goethe. Currently you can edit this field but you can't browse the author's catalogue of literature. There is a rowselector at the bottom of the form, but it is currently inactive. To activate this button we change the data properties of the form. Change back to design mode (click "design mode" button). To show the form's properties instead of the properties of an object on the form we need to make the form the active object. To do this, click on an open space on the form, avoiding all the objects on the form. The property editor now shows the properties of the form itself. Change the datasource field to "authors (0)" and revert back to "view mode". Now you can browse the whole datasource.

The next step in our objective is to display all the literature that the selected author, Goethe (or any other author), has written. To do this switch to design mode and place a gridfield object on the form. In order to make use of the selected gridfield you have to create a new datasource based on the "literature" table. --- But after clicking on the "..." button in the Property Editor window, stop! --- We only want to see the books of the selected author so there is more work to do before you push the "add" button.

The "literature" table depends on the "authors" table, i.e. any author in the "literature" table must exist in the "authors" table. So we select the already defined datasource "authors" in the "depending on" field (ignore the number in the brackets, it is a unique number for each datasource in a form). We have to tell the system how the datasources are connected, i.e. which columns are linked to each other. In the master datasource ( authors(0) ) it is the field "author_id" and in the actual datasource table (literature) it is the field "author". Select both fields and press the button with the two arrows. The linked columns names are now displayed in the listbox on the right. Finally, click the "Add" button.

#### The form datasource dialog(2)

Let's have a brief look at the remaining fields in the formdatasource dialog. The sorting field allows you to sort the datasource. It has the same syntax as the "ORDER BY" syntax of SQL-statements. If you want, for example, to display the literature in ascending alphabetical order just add the field name "title" into the "sorting" field. If you want a descending order add "title DESC".

If the "is readonly?" field is checked, no values of this datasource can be changed in the form. A datasource that is already readonly (e.g. all queries) will remain readonly, even if this field is not checked.

The filter field allows you to display rows of the datasource if certain conditions are met. It has the same syntax as the "WHERE" syntax of SQL-statements.

Finally, let's create a button on our form. We will define it as a "Close" button so we can close the current form when clicked. First of all we have to store the form. This can be done in two ways, either press the save button (the one with the disk) on the horizontal toolbar or click the right mouse button in "design mode" and select "Save form". When saved, create a button and change the label to "&Close". If you have selected the button object, the Property Editor will be displaying the "Action" tab. Select the action "Close form" and select the name of the form to close in the object field. Now let's test it.

### Defining grid columns

In formgrid1 you can see the result of our creation. Nice, but the columns in the grid show data we don't really need to see, such as the column "author". The "title" column is also too narrow and therefore, in certain circumstances, will not show the full title of the piece of literature.

#### The defined form

In this chapter you will learn how to modify the grid.

To define the visible columns, stay in the form's viewmode and press the right mouse button somewhere on the grid. Select "Define columns" from the pop-up menu. The "Column Select" dialog window is displayed. Select the "author" field in the right box and press the "left arrow" button between the two boxes. This will move the "author" field to the "Invisible Columns" box. Now press the "OK" button to confirm this action. As you can now see the "author" column has vanished.

#### The column selection dialog

Defining the gridcolumns is the only design job permitted in viewmode. You can only see the data and the columns in this mode. This operation is not possible in the form's "designmode". To save your changes, change back to "designmode" and save the form manually as we did previously ("Save" button or right mouse button -> store form).

Adjusting the width of the column is simpler. Move the mouse cursor to the end of the "title" column in the grid's header row. When you are at the right position the mouse cursor will change. Press the left mouse button and hold it. Now move the mouse. The column will get narrower or wider depending on the direction that you move the mouse.

To store your changes, swich to "designmode" and save the form manually (right mouse button -> store form).

#### The form with changed gridcolumns

Another feature in "viewmode" mode is the ability to alter the order of the columns. Click in the header of the column you want to move while pressing the <CTRL>-Button, press the left mouse button and hold it down whilst dragging the column to its new position, then release the button.

### Defining comboboxes

In this chapter we will take a closer look at the combobox object. For this exercise we create a new form in which we can write reviews for the plays, books etc. held in our database. Create the form using the field definitions as shown in the following table.

First we need to define a new table called "review", which will be the basis for our new form.

### table structure of the table "review"

Fieldname | Type | Description
review_id | auto increment | unique identification number for each review
author_id | integer | author identification number
literature_id | integer | literature identification number
reviewtext | memo | the review text

Now we create a new form called "reviewform1" based on the "review" table. Add two comboboxes (you will find the detailed descriptions of the properties of the comboboxes in the following text), two labels, two buttons and a memofield to the form as shown below. Connect the memofield with the column "reviewtext" and improve the buttons.

#### The form "reviewform1"

#### A simple combobox

The "author" combobox shows the "author_id" column of the "review" table. The column holds the numeric value, but what we want to select is the name of the author as defined in the "author" table.

For this we will set the values as shown in the figure below. Three extra fields are used for a combobox:

- listdatasource: this is the datasource that contains the master list

- listcolumn: the column in the listdatasource which contains the key value for the column field. Its data will be written in the column field.

- viewcolumn: name of the column in the listdatasource that contains the values that we want to display on the screen

##### A simple combobox

The "author_id" field in the "authors" listdatasource has an equivalent field in the "review" datasource, called "author_id". Instead of displaying the identification numbers we would rather see the author's names, so we set the viewcolumn to "name". As you can see in fds3, the formdatasource for the listfield contains nothing extraordinary.

##### The form datasource dialog(3)

#### A complex combobox

The "Literature" combobox should list the literature written by the author who is selected in the "Author" combobox and should immediately update its contents when a new author is selected. This requires a little bit more thought and planning.

##### A complex combobox

We need to access the "literature" table and set the "review" table as being the master datasource. This is so far "business as usual". If this is all you set you will find that the "Literature" combobox will only update its contents when you change the "Author" combobox and store the changes. To modify this behaviour, click the "react on master changes?" checkbox in the datasource (should now contain an "x").

##### The form datasource dialog(4)

Now it almost works as designed. But when you try to delete a row in the "review" form you get prompted that you can't do this due to row dependency. To modify this behaviour you can set different depending modes. In this case all we need to do is select "no handle" for "depending mode". That's all.

However, if you enter a review and save it, you will discover that although selecting an author selects his works, the same review comment is displayed. That is clearly not satisfactory. It is left as an exercise for you to create the reviewform2 shown below. This form is based on the literature table, for it is the author's work that is to be reviewed. The literature combo has Combomode: Selector; Listdatasource: literature and Viewcolumn: title. The datasource of the author lineedit is authors depending on literature. The datasource of the memofield is review depending on literature.

##### The form "reviewform2"

##### The depending modes

> - standard - cannot delete a master row when there are depending rows in the depending datasource and cannot change the value of a master connection field.

> - nohandle - allows changes and deletion, but ignores changes to the key fields

> - change - if a master connection field is changed, the equivalent depending fields will change their values too.

> - delete - if the master row is deleted then the depending rows will also be deleted

> - change+delete - combination of the change and delete modes

### Defining images

A data-aware image field can be added as easily as a line-edit field. Simply choose the image object (the Mona Lisa) and position it anywhere in your form. Set the column (if the column type is 'binarycolumn' images will be stored inside the table (not recommended!), otherwise (recommended) it will store the path and the name in the column ).

You should not store images inside the database. Instead only store the file location and the image name within the database. This way, memory management is much better.

Let's say your images are located in '/opt/images'. Then set 'Image path' in the property editor to this value. Set 'Field' to a fieldname in your table that contains the file names. That's all. During viewmode you can set the image when you click the right mouse button on the image field and select 'Load image'.

If you want to display a non-dataaware image field, you can set a permanent image in the property editor position 'Local image'.

### Setting default values

Default values are values that are used in a field when inserting a new row where the user did not give a specific value to that field. For fields' you can edit the default values within the property editor; for gridcolumns, default values can be set in the grid column selection dialog.

In addition to all characters you can type with your keyboard, the following function names are possible

> - %NOW% the actual date, time or datetime, depending on the fieldtype. Default is datetime

> - %NOWDATE% the actual date

> - %NOWTIME% the actual time

> - %TRUE% the driver-specific true value

> - %FALSE% the driver-specific false value

### Setting the tab order of fields

You can define the tab order of the fields. Open the dialog window by clicking the "Arrow down" button in the toolbar (see tab1).

#### Starting the taborder

Fields that are in the left part of the dialog are not in the keyboard tab order, fields in the right part of the dialog are in the ascending order as shown in this window (see tab2).

#### The tab order window"

## Reports

A good database frontend is not complete without the ability to produce reports. In this chapter we will learn how to create neat reports. Before starting, you should have a look at reportoptions to set some important preferences.

Double-click "Reports" in the list view. The reportdesign window is displayed and the Property Editor dialog window is opened. The reportdesign window has a vertical toolbar on the left hand side.

### The reportdesign window

So far it looks similar the "formdesign" window, but with some differences. Before you start designing reports, you should already be knowledgeable on form creation. See forms for details.

> - The left toolbar provides only one fieldtype

> - The design area is divided into areas known as sections

Reports are divided in sections in which reportdata can be displayed. There are two section types:

> - predefined sections with special meaning

>   - the "reportbeginsection" and "reportendsection". These will only will be shown once, the "reportbeginsection" is displayed BEFORE all the datasources' data is be displayed, and its equivalent "reportendsection" is displayed at the very end of the reportdata

>   - the "pageheader" and a "pagefootersection": which, as the name suggests, will be displayed on each page as header or footer

>   - the "datasection" (main data section and the only section without a sibling). This section will be printed for every row in a datasource

> - user defined sections, to group the data: they _always_ exist as pairs, a headersection and a footersection. Headersections will be printed before the datasection, footersections after the datasection. It is necessary to define a column for these sections. The sections will be printed when the value of the column changes

First let's try to create a simple report.

### A simple report

First select the datasource ("literature" table) on which the report depends. To do this you have to change the report properties. To access the report properties, nothing else must be selected. Click somewhere in the dark grey area outside the sections. To set the datasource see property for details.

Now let's create a new field. Select 'new field' (on the toolbar on the left) and follow that by clicking an area in the datasection (make sure it is the datasection and not one of the others). Set the 'title' column in the property editor. To preview what we have done, change to viewmode. Congratulations. You have created your first report.

### The report field

A report field allows you to print formatted data. So we will take a closer look at what we can do with this field. Within the 'format' tab you can select a lot of the usual format styles such as fonts, alignment, number formatting etc. In the 'frame' tab of the Property Editor you can define lines to be painted. The horizontal and vertical lines should become clear to you after you have tried them out. The diagonal lines are not so self-explanatory: "diagonalLuRo" paints from the bottom left hand corner up to the top right hand corner and "diagonalLoRu" paints from the top left hand corner down to the bottom right hand corner. Note: In case you are wondering how "diagonalLuRo" translates to bottom left to top right, it's an abbreviation from the German "Links Unten Rechts Oben" and I think you can work out "diagonalLoRu")

You will be familiar with most of the fields on the "Data" tab from using Property Editor during the creation of a form. There are two new fields:

> - value field

> - and the running count field

The value field contains the string that will be printed. There are some variables you can use. The most important variable is the already set %VALUE% variable that will be replaced with the actual data from the database column. As the field value will contain a string, any string will be valid, for example: 'Hi, my name is %VALUE% , blah bla this is the field %COLUMNNAME%' is a valid string. Other possible variables are

> - %PAGENUMBER% the relative pagenumber: use this variable to set the number of the first page (very useful in pageheader or footersection)

> - %ABSOLUTEPAGENUMBER% the physical page number

> - %ROWNUMBER%

> - %DATE% the current date

> - %TIME% the current time

if a column is set

> - %COUNT%

> - %COLUMNNAME%

> - %DATASOURCENAME%

> - %VALUE%

if the field type is numeric you can also use

> - %SUM%

> - %MIN%

> - %MAX%

> - %AVERAGE%

> - %STDDEV% (standard deviation)

> - %STDDEVSAMPLE%

With this knowledge, we can now try to format this report to make it more stylish and readable to the user. First we will create a new field that will print the static text 'My first report' at the very beginning of the report. Create this field in the reportheadersection, moving it to the upper left hand corner and resizing it to the maximum width. Now change the fontsize of this field to 24 and overwrite the content of the value field with 'My first report'. Notice that we left the column field empty.

Next we want to see the page number centred on the bottom of each page. Create a new field in the pagefootersection, moving it to the upper left hand corner and resizing it to the maximum width. Overwrite the content of the value field with 'page -%PAGENUMBER%-', set the alignment field to 'center' and in the "Frame" tab set the top line field to 'yes'.

Save the report as 'literaturereport'. We need it in a later exercise. In the following figure you can see the resulting report. The parallel double lines were created as an empty field with topline and bottom line enabled.

#### A simple report

If the text size exceeds the width of the field, you can use the "linebreak" property. If the text exceeds the field height, you can use the "dynamic height" property. The field will then resize automatically to hold the whole text (make sure that the linebreak property is set, when the dynamic height property is set).

### User defined report sections - a more complex report

The objective for our next report is to see all the titles for each author. Start by creating a new query called 'examplequery' using the following SQL statement

    select name, title from authors, literature where author_id=author

Create the new report based on this datasource. Create one field in the datasection and connect it to the column 'title'. It now looks like our previous report. Create a new userdefined section by clicking on the 'Sections' button in the left toolbar. A new dialog opens.

#### the reportsection dialog

Add 'name' into the field below 'Section to add' and press the button with the right arrow. You will see that a new pair of sections have now embraced the datasection. Press the 'Exit' button to close the dialog. Add a field to the newly created 'name' sectionheader and set 'name' as the column. Now have a look at the result. Looks neat, doesn't it?

Add a new field to the 'name' sectionfooter and set 'name' as the column. Replace the valuefield entry with 'There are %COUNT% titles for the author "%VALUE%" in this database'.

#### A complex report

Some additional sectionfooter field properties have been set: the border lines and wordbreak set to "yes".

### Subreports

Last, but not least, we create a report using a subreport. It should do more or less the same as the report in the previous section. Create a new report based on the 'authors' table and a new field in the datasection depending on the 'name' column.

We are now going to change the datasection properties. Click on the header of the datasection and then click on the "Subreport" button in the "Data" tab. The subreportdialog will be displayed.

#### The subreport window

Set the report we created first, "literaturereport", as the subreport. Remember that this report is based on the 'literature' table. The "literaturereport" (the subreport) should show only the literature of the authors shown in the main report. So set the fields as shown in the figure above.

Using the 'before sectiondata' checkbox, you can control whether the subreport is printed before or after the data of the main report section.

### Show reports depending on form values

When you open the report of the last section (the subreport section) you will see the data of all authors. But wouldn't it be nice to see and print only the data of the author currently displayed in the form? First create a "Report" button on the form "authorform". This button will open the report as shown below:

#### The form property showing the button values

So far this is nothing special. Now click on the button with the 3 dots right of the 'object' field. The following dialog appears:

#### The reportcondition dialog

Here you can link the form data with the report. Select the column 'author_id' as report field, the form datasource 'authors' and the form field 'author_id'. Then press the button with the 2 arrows. That's all. Now the button opens the report as intended.

This dialog allows you to connect report fields in two ways. Either with the value of a formdatasource-column as shown above or with a constant value. To do so let the 'form datasource' field empty and enter the constant value into the form field.

## What's next - Scripting &knoda;

If you want to extend the features of forms and reports you can write your own scripts using Python. How you can do this is described in the scriptingtutorial ( or in the internet &knoda; scripting tutorial). Database examples can be found at &hk_classes; download page

## Miscellaneous

### Import a CSV file

A CSV file (CSV = comma separated values) is a text file which contains table data. Each line in this file represents a row in the table and the fields are usually separated by commas. The very first row in this type of file can be a header row that contains the names of the field.

To import data from a file, select the menu File->Import->CVS The following window appears:

#### The CSV import dialog

After you have selected the filename and set the other properties to the correct values, press the "OK" button.

The entries 'Date format' to 'Locale' are only visible when you click the 'Options' button. These values allow you a fine grained definition of the data in the text file.

### Export a table or query to a CSV file

To export a table, select the menu File->Export->CVS. The following window appears:

#### The CSV export dialog

Enter the filename and set the other properties to the correct values and then press the "OK" button. The entries 'Date format' to 'Locale' are only visible when you click the 'Options' button. These values allow you a fine grained definition of the data in the text file.

Of course it is also possible to export queries and views.

### Export a table or query to a XML file

To export a table, select the menu File->Export->XML. The following window appears:

#### The XML export dialog

Enter the filename and set the other properties to the correct values and then press the "OK" button.

Of course it is also possible to export queries and views.

### Using the filter

If you have too many datasets in your tables, queries or forms, it is possible to reduce them by temporarily setting a filter. The definition of the filter will not be saved. To use it you have to perform two steps

- define the filter

- activate the filter

The horizontal toolbar in every window contains the following 2 buttons

#### The filter toolbuttons

The left button is for defining a filter, the right one to activate/deactivate the filter.

#### Form filter

A form filter shows you the form and you can write condition for a field directly in field. (e.g. '>15 and <20').

##### The form filter dialog

#### Table and query filter

To define a filter, press the filter definition button and enter a conditional statement. It has the same syntax as the "WHERE" syntax of SQL-statements.

##### The filter definition dialog

After you have closed the dialog, the filter activation button is enabled. Press it to activate the filter, press it again to deactivate the filter.

### Comboboxes in grids

It is possible to define the columntype in grids. To do so, open the column selection dialog as shown in gridselect2. In the combobox "Columntype" you can define three different representations of a column.

- edit - the standard lineedit field

- bool - a boolean field

- combo - a combobox field

If you select the latter (combo) you can set the combobox properties.

#### The column selection dialog

And here is an example grid:

#### The column selection dialog

You will have to double-click the field in View Mode before you can see the combo control.

### Colours in forms and reports

There are 2 different colours: foreground colours and background colour.

- foreground colour is used to paint text and frames

- background colour is used to fill the background of the widget

To set and change colours for all objects in a form or report