Create a Protocol Template

Owned by Stefan Appl
Last updated: Aug 18, 2023 by Lutz Klabuhn
3 min read

Create a new jBEAM project and put at least one “Interactive Table” (click on jBEAM menu “Graph Editor” > “Controls” > “Interactive Table”) in the graphic window. Open the Interactive Table Editor and do the following settings:

  1. In the name text field put in “PT[optional]”

  2. Configure “Title”, “Frame”, “Horizontal Grid”, “Vertical Grid”

  3. Put in the “general headercells” some header information and format it, example: The unit of the dataobject can be displayed by putting in ”@yunit(CurrDataItem)@”. The name of the dataobject can be displayed by putting in ”@name(CurrDataItem)@”.

The column configuration can be done in two ways:

  1. Simple way: Using the Batch Report Protocol Editor: Create Batch Report Generator component (see chapter “Editor”). Load the protocol template (at least one “Interactive Table” with name “PT[optional] must be inside the template) into the template configuration of the Batch Report Generator (see chapter “Templates”). Click on button “Change template” and after that a new dialog with titel “Change template” is opened. Within the dialog, click on button “Change protocol template” and the following protocol template editor is shown:At the left side, the spreadsheet (“Interactive Table” components with name “PT[optional]” are shown) can be choosen and at the right side there is the configuration of the selected spreadsheet. At the upper part, the view can be selected that is applied to all columns in the spreadsheet. Among them is the import of channel names from importers. The user can select an importer data format and click on the import button and after that, the importer editor is opened. After the file or test has been loaded, the channel names of the import file or test are filled into the combo boxes in column “Channel name” at the table below. In this table, the columns can be removed, added, changed. A column can be set to index and it will show an index channel starting at 1-n in protocol report. If “Continue” is set to active on a column then this column will be displayed in all horizontal splitted tables (for further information - see paragraph before). The channel name that should be assigned to the column can be choosen from combo box or put in manually. Additionally, the number of decimal digits and the unit can be set for each column. If no unit is set then the unit from importer is used later in the protocol report.At the bottom, there is a checkbox “Fillup dataobjects from test automatically”. If it is activated then the spreadsheet is filled up with the dataobject from the datasources that are active during report generation. If the protocol is ready configured, click on button “OK” or “Apply” and in the dialog “Change template” there is a button “Save template” that will save all the modifications to file (for furher information see chapter “Templates”).

  2. Difficult way: Columns can be predefined by opening the Interactive Table Editor and adding “Channel” columns and put in the dataobject name and doing other settings like format, individual headercells, decimal digits etc. The producer name is not relevant and is replaced by Batch Report Generator.
    There are two special columns:

    • Index column can be defined by putting “index” as producer name and optional set the dataobject name.

    • If the user wants to automatically fill up the table with dataobjects that are present in test or import file then create a column with dataobject name “*”.