Protocol – Record process values and create a PDF

1. What does the Protocol object do?

Protocol creates new documentation of an operation. It records start, end, duration, operator, batch/order, program/recipe and the configured process parameters. A successful completion saves a PDF and its associated data file.

PDF and Open PDF display existing files. The Protocol object's Start button starts recording; it does not automatically start a machine or recipe.

2. Insert and open properties

1. Save the project and insert Documents → Protocol.
2. Open properties and set the object name, position and size. The example uses X = 20, Y = 140 and 320 × 116 pixels.
3. Set the optional label and area assignment.
4. Choose Configure process protocol.

The card contains batch/order on the left, program/recipe on the right and Start, Finish and Last PDF. Configure it in the editor and operate it in play mode. Set its displayed protocol title in the protocol configuration.

3. Understand the configuration window

The three areas cover the document header, start and stop, and the process parameters to record.

There are two Apply buttons: the one beside New and Delete adds or updates an individual parameter in the list. The bottom-right button applies the complete protocol configuration. Then confirm the object properties and save the project.

4. Document header

Document title

Enter a meaningful title, such as “Maintenance run – Machine 1”. It must not be empty.

Description / Machine

Identify the equipment or purpose so that the document can be understood later.

Customer logo

Optionally use Select to choose a PNG or JPG.

A title such as “Process protocol” alone says nothing about the sources or quality of the recorded values.

5. Manual operation or PLC trigger?

Manual in play mode: use the object's Start and Finish buttons. Trigger fields are disabled in this mode.

By PLC trigger: assign PLC/device, IP address where applicable, symbolic name or PLC address and bit 0 to 31. Use Select symbol to help choose the source. A 0 → 1 transition starts recording; 1 → 0 finishes it and creates the files. Manual Start/Finish buttons are unavailable in PLC mode.

Important: the first received high trigger value can already start recording. Check the source and initial state before testing. A continuously high signal does not finish a protocol; without a received ending signal there is no normally completed PDF. Automatic triggers run in play mode independently of manual start permission.

6. Add and edit process parameters

1. Choose New or select an existing parameter on the left.
2. Enter a clear name, such as “Actual temperature – Tank 1”.
3. Choose Process value for a reading or Fixed text for a constant entry.
4. For readings, assign PLC/device and symbol/address, preferably through Select symbol. For fixed text, enter the content in PLC address or fixed text.
5. Select the capture mode and optional unit, such as °C.
6. Use Apply beside New to update the parameter list.

Delete removes the selected parameter from the configuration. At least one parameter is required; the maximum is 16. A unit labels the value without converting it.

The initial Setpoint temperature and Actual temperature entries have no assigned devices or addresses. Configure their sources or replace them before useful recording is possible.

The list on the left and the selected parameter on the right

The left list contains existing parameters. Click Setpoint temperature, for example, to load its settings on the right. Empty fields on the right do not mean the list is empty: the screenshot shows the form prepared for a new parameter.

Each row summarises the name, symbol/address where available, capture mode and unit. Check the row after applying changes.

What belongs in each field?

Process parameter name

A readable label, such as “Setpoint temperature – Tank 1”. This describes the value; it is not its PLC address.

Source

Process value reads an assigned process signal. Fixed text records entered content, such as a machine identifier. Fixed text is not a measurement.

When should the value be captured?

Selects the evaluation shown in the report. Start and end can suit a setpoint; average can suit an actual temperature. The next section explains each mode.

PLC / Device

The device or connection belonging to the source. It must match the address. A similarly named value on a different device is a different source.

Symbolic name

A readable name of a configured PLC signal, such as “Temperature_Setpoint”. Simply entering an invented name does not establish a data connection.

PLC address or fixed text

For process values, enter the signal address belonging to the device. For fixed text, enter the actual content, such as “Machine 1”. Its meaning depends on the source selection.

Unit (optional)

A label such as °C, bar or l/min. It does not convert raw readings: adding °C does not turn 600 into 60.0 °C.

Select symbol

Opens the PLC/communication table for signal selection. Choose the required entry, then check device, symbol, address and unit. Use signals from your actual project.

Completed example: Anlage_Sollwert

The following screenshot shows a process parameter already applied to the list. This actual entry illustrates how the fields work together:

Name: Anlage_Sollwert

This labels the parameter in the report. You could rename it “Machine setpoint” for the reader without changing its data source.

Source: Process value

The content is read from the assigned process source rather than entered here as fixed text.

PLC / Device: Modbus_Testserver

This configured device supplies the value. The device and address identify the source together.

Symbolic name: Anlage_Sollwert

The readable name of the selected signal. It may match the parameter label, although label and signal name have different purposes.

PLC address: 40007

The address assigned to this signal in the example project. Do not copy it to another machine without checking. Use “Select symbol” to choose the correct assignment for your project.

Capture mode: Start and end

Records the signal's value when recording starts and finishes. The protocol does not write a new setpoint to the PLC.

Unit: empty

No unit is appended. Add an appropriate unit if the value represents a physical quantity; do not infer it from the name or address.

Why does Anlage_Sollwert appear twice in the list? The row shows the parameter label, then the symbolic name, then Start and end. These are different properties of one entry, not two measurements or two parameters.

Example report result: If the signal reads 60 at start and 80 at completion, the result is equivalent to Anlage_Sollwert – Start: 60 · End: 80. If it remains at 60, both values are 60. These are illustrative values, not measurement results demonstrated by the screenshot.

What has been saved at this point? “Process parameter applied” confirms the entry has been applied to this dialog's parameter list. Next, apply the complete configuration at the bottom right, confirm the object properties if needed and save the project. The upper Apply button alone does not save the project.

The existing Setpoint temperature and Actual temperature entries remain in the list. Adding Anlage_Sollwert does not replace them. Select and delete them individually if unnecessary, or configure their sources correctly as well.

Example 1: Setpoint temperature at start and end

1. Select the existing Setpoint temperature entry.
2. Set its name to “Setpoint temperature – Tank 1” and choose Process value.
3. Use Select symbol to select your device's temperature setpoint. “Temperature_Setpoint” is an example name, not a prescribed address.
4. Select Start and end and °C.
5. Use Apply beside New to update the entry.

Example: a reading of 60 at the start and 80 at the end produces an entry equivalent to Start: 60 · End: 80 °C. Recording does not change the setpoint.

Example 2: Average actual temperature

1. Select Actual temperature.
2. Choose Process value and the actual temperature signal, rather than the setpoint signal again.
3. Select Average and °C, then apply the parameter.

Exactly three numeric samples of 58, 60 and 62 give an average of 60. A real recording includes all collected numeric samples. To document the highest temperature as well, choose New and add another parameter for the same signal with Maximum capture mode.

Example 3: Machine identifier as fixed text

1. Click New and enter “Machine identifier” as its name.
2. Select Fixed text.
3. Enter “Machine 1” in PLC address or fixed text. No PLC device or symbol is needed for this source.
4. Select, for example, Start value; leave the unit empty.
5. Use Apply to add the parameter to the list.

Use New, Apply and Delete correctly

New clears the fields and deselects the existing entry. Only Apply adds the new list item. When an existing item is selected, Apply updates that item. Choose New first to add an additional parameter.

Delete removes the selected parameter from the configuration list; it does not alter PDFs already generated. Apply each parameter's changes before selecting another entry or applying the overall configuration at the bottom right. Otherwise the uncommitted field changes are not part of the parameter list.

Final check: Are all intended entries listed? Do the devices and signals match? Have setpoint and actual value been confused? Are units and capture modes appropriate? Then apply the full configuration, save the project and create a test report with known values.

7. When should the value be captured?

Start and end

Records both values, such as the setpoint before and after an operation.

Start value

Records the value at the beginning.

End value

Records the value at completion.

Minimum / Maximum

Records the lowest or highest numeric value among the samples collected.

Average

The arithmetic mean of collected numeric samples, not a guaranteed time-weighted or continuous measurement.

Start/end modes suit fixed text; minimum, maximum and average require numbers. If no value is available at the start, the first valid value received later can become the start value. Missing values may appear as –.

A brief peak between samples may be missed. A plausible average or the existence of a PDF does not establish complete or correct process measurement.

8. Create a manual protocol

1. Apply the configuration, save and start play mode.
2. Check or enter batch/order. An empty batch field is filled automatically on start.
3. Enter Program / Recipe. A manual start is rejected without it. This text documents the association; it does not launch a recipe.
4. Choose Start. The status shows RECORDING RUNNING; batch and program cannot be edited during recording.
5. Choose Finish after the operation and check the completion message.
6. Use Last PDF to open the latest PDF available for this object.

Finish ends recording; it is not a machine stop. There is no new completed PDF before completion. An available Last PDF may belong to an earlier operation.

9. Check files and completion

Normal process protocols are stored under Protokolle/year/month in the project, based on the start time. Identifiers begin with PR- and a timestamp. Each PDF has a corresponding .json data file.

Manual completion reports status and PDF path. If saving fails, read the error; automatic completion errors are also recorded in the logbook. Check the project path, write access and available disk space. A failed completion must not be treated as a fully archived operation.

Use Open PDF to select older PDFs. The PDF guide covers viewer controls, printing and file selection.

10. Role permissions and responsible use

Start process protocols, Finish process protocols, Open process reports as PDF and Edit process protocol templates are separate permissions. Configuration also requires editor access and saving requires project save permission. Free PDF selection requires Select local PDF files. See the Users guide.

Administrators should also avoid changing configuration or triggers during a required recording. Complete the recording as intended and verify its files before switching to the editor. Entering the editor exits play mode; it is neither a normal protocol completion nor a safe machine shutdown.

Before production use, test a complete cycle: signal sources, trigger start and end, known comparison values, parameter list, PDF content and storage. Do not treat simulation data as actual plant measurements. Successful PDF generation alone confirms neither correct sources nor approval of the operation.