Customizing a report
This section provides more information on how to define the contents of a report. The reports generated by the software typically have the following structure:
- Lines
- The main reference element of the report. For example, a report which will list the number of new cases for all users will use the “Users” table for the “line” information. On the other hand, a report which would list the journal of activities for one specific user would use the
“Follow-ups” table. A report must include at least a source element for the lines of the report.
- Columns
- The column information lists information in relation to the “Line” information. For example, if the line is using the “users” table and the “column” is using the “follow-ups” table, then it is possible to extract information on the follow-ups for each user. More detailed examples
are provided in the next sections.
- Filters
- After selecting the source elements for the lines and (optinally) columns for the report, it is possible to filter the results based on certain criteria. For example, to generate a monthly report, it will be necessary to add a filter based on the date of the case or follow-ups.
Defining the lines and columns of reports
The report line and column each allow to use one source element, from which many fields can be used. The only exception to this are keywords, because they only have a title, so specifying the field is not necessary.
To define the source element of a line or column of a new report, follow these steps:
- From the “Report details” form, select the source table or keyword for the report line (later repeat for the report column, if necessary).
- Click on the “Validate” button. It will refresh the screen, showing the selected source, as well as a list of fields available (if the source is a table).
- To add a field, select it from the menu located on the “Add a field” line of the form, then click on “Validate”. The fields are shown in the report in the order that they were added.
To change the line or column source, all of the fields selected for the source must first be removed. Fields can be removed by clicking on the “X” located next to the title of the field. When there are no fields selected for a source, a “X” is shown next to the name of the source in order
to change it.
Example: Number of cases per user
To list the number of cases per user, within a given period, follow these steps:
- As the “line information” source, select the table “User”, then click on “Validate”.
- Add the field “name”, then click on “Validate”. Repeat with the “surname” field.
- As the “column information” source, select the table “Case”, then click on “Validate”.
- Add the field “count”, then click on “Validate”.
To count the number of new cases for a given period, it is possible to add a filter based on the creation date of the case:
- In the “report filters” section, select the “Case: creation date” item from the menu, then click on “Validate”.
- After the screen is refreshed, a new menu will be shown next to the name of the field (creation date), which by default shows “none”. Change the value for “in”, then click on “Validate”.
- Two sets of fields will then be displayed in order to enter the date interval for the report. If you would like to use this reports on many intervals, for example each month, simply leave the fields empty.
The report is now ready to be generated, using the “Generate report” button at the top of the screen. If a “creation date” filter was created and its value was left empty, the software will show a screen to enter the date interval.
Please note that in this specific case the list of cases are seperated by case stage and a total is shown at the end of each line (the sum of all case stages for the user) as well as a total at the end of the report (the sum of cases for all users).
Example: Time spent of each follow-up type, for each user
To list the total amount of time spent on each follow-up type, for each user, follow these steps:
- As the “line information” source, select the table “User”, then click on “Validate”.
- Add the field “name”, then click on “Validate”. Repeat with the “surname” field.
- As the “column information” source, select the table “Follow-up”, then click on “Validate”.
- Add the field “type”, then click on “Validate”.
To limit the results to activities for a given period, use the following filter:
- In the “report filters” section, select the “Follow-up: Start” item from the menu, then click on “Validate”.
- After the screen is refreshed, a new menu will be shown next to the name of the field (creation date), which by default shows “none”. Change the value for “in”, then click on “Validate”.
- Two sets of fields will then be displayed in order to enter the date interval for the report. If you would like to use this reports on many intervals, for example each month, simply leave the fields empty.
The report is now ready to be generated, using the “Generate report” button at the top of the screen. If a “start date” filter was created and its value was left empty, the software will show a screen to enter the date interval.