# Preparation

#### Adding metadata to the report

The capabilities of the analysis stand or fall with the available data. To get the most out of the analysis, reports should **at a minimum** include the following information:

Per test execution:

* Serial number
* PartNr (or Product ID)
* Date of test execution
* overall result

{% hint style="info" %}
Ideally, the reports contain further metadata and also user-defined fields on product properties or test environment. **You can filter and group by this data later**. This information can be added to the test sequence very easily if the special test steps are needed. **In the program directory you will find examples and instructions on how to optimize your test sequences for the Report Analyzer.** This is not a technical requirement for operation, but it improves the possibilities of evaluation enormously!
{% endhint %}

Per test step:

* Measurement ID
* Name of the measurement
* Measurement value
* Data type
* Limits
* Timestamp
* Execution time

#### Measurement ID

At the very least, however, you should know the conventions for forming the Measurement ID, which is used to identify measurements in the Report Analyzer. For this purpose, the respective step name is preceded by a unique identifier in square brackets, e.g. instead of

`Voltage Input Channel 1` => `[ADC_0010] Voltage Input Channel 1`

Content and length of this ID are arbitrary. However, IRS recommends a short combination of the acronym of the respective test sequence and a consecutive number with sufficient reserve intervals.

results in the Report Analyzer:

* Measurement ID: `ADC_0010`
* Measurement Name: `Voltage Input Channel 1`

The use of the ID is not technically required, but if the Measurement ID is missing, the very cryptic TestStand Step ID is used as a substitute for reasons of unambiguity (e.g. *ID#:OgNqkZFG6RGN9ggAJw99EB*).

{% hint style="info" %}
Please also refer to the enclosed, more detailed information about the IRS Report Format and also to the already above mentioned example sequences in TestStand format.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.irs.systems/report-analyzer/documentation/preparation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.