Reports

Templates

The last step in the variant selection flow is to generate the Report. Usually you want the report to include the information about the Sample, Researcher, date, your Institution, selected variants and some additional comments. Moreover, the report should be written in your selected language.

To solve this problem GeneBe provides an option to use your template. You need to prepare a .docx file with a template that later will be filled with real data. Please download Example reports template and edit using your favourite editor. This may be a simple start. When you have your template ready test it, go to Settings and there use the Test template form to upload your .docx file, system will let you download the filled verion immediatelly, so that you can see if it works correctly.

If you accept your template upload it using the form.

Now the template will be accessible on the Report page.

Variables available in the template

System looks for the special strings in your template and fills them. For example {{sampleName}} will be replaced by the sample name etc. Refer to the example template to see the possible variables.

There is a special case of the tables and lists. Look at the template carefully to see how they are created, so that you have your lists filled correctly.

Building tables is a special case. If you want to build a table you need to use {{*Rows}} variable, for example {{variantRows}}. Put it in an empty table row after the header, before the data. Use [values] in the row below. Look into the example template, everything will become clear.

If you need more help about the template syntax: GeneBe uses https://github.com/Sayi/poi-tl , please watch examples on that site.