> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/model-and-simulation/co-simulation/co-simulation-with-orchestra/configure-orchestra-data-exchange/orchestra-csv-file.md).

# Orchestra CSV File

## Introduction

An Orchestra CSV file provides a spreadsheet-friendly format for defining Orchestra domains and data items.

You can create or edit the CSV file in a text editor or spreadsheet application such as Microsoft Excel, then import it into the **DDF Configurator**. The DDF Configurator can also export DDF data to CSV for easier review or bulk editing.

{% hint style="info" %}
The CSV file is an alternative way to represent and edit Orchestra configuration data. The Data Description File (DDF) remains the XML representation of the Orchestra communication configuration.
{% endhint %}

An Orchestra CSV file consists of:

1. a **header**, which defines the domains and CSV columns; and
2. a **body**, which defines the data items exchanged through those domains.&#x20;

## CSV header

The CSV header contains two required elements:

* **Domain descriptor**
* **Column list**

### Domain descriptor

The Domain Descriptor defines the configuration of each Orchestra domain represented in the CSV file.

The available attributes are:

<table data-search="false"><thead><tr><th>Attribute</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code></td><td>Valid identifier</td><td>Domain name</td></tr><tr><td><code>connection</code></td><td><code>local</code> or <code>remote</code></td><td>Connection type</td></tr><tr><td><code>cardName</code></td><td><code>VMIPCI5565-64M</code> or <code>VMIPCI5565-128M</code></td><td>Reflective-memory card used for a legacy remote connection</td></tr><tr><td><code>pciIndex</code></td><td>Positive integer</td><td>PCI index of the communication card</td></tr><tr><td><code>synch</code></td><td><code>Y</code> or <code>N</code></td><td>Enables or disables synchronous operation</td></tr><tr><td><code>state</code></td><td><code>Y</code> or <code>N</code></td><td>Writer Access Priority setting</td></tr><tr><td><code>multiPub</code></td><td><code>Y</code> or <code>N</code></td><td>Writer Access Exclusivity setting</td></tr></tbody></table>

{% hint style="info" %}
**Note:** CSV header data is case-sensitive.
{% endhint %}

### Column list

The Column List identifies how each column in the CSV body maps to DDF data. **The Column List should contain the following columns: domain, frameworkToClient, clientToFramework, type, length, default, description.**

The columns can appear in any order. However, if you add custom columns, the complete standard Column List must appear before the additional columns.

The `domain` values used in the body must correspond to domains defined in the Domain Descriptor.

## CSV body

The CSV body contains the data exchanged through Orchestra.

Each row represents one data item, and each column defines one property of that item.

<table data-search="false"><thead><tr><th>Column</th><th>Description</th></tr></thead><tbody><tr><td><code>domain</code></td><td>Domain containing the data item</td></tr><tr><td><code>frameworkToClient</code></td><td>Data sent from the Framework to the External Component</td></tr><tr><td><code>clientToFramework</code></td><td>Data sent from the External Component to the Framework</td></tr><tr><td><code>type</code></td><td>Data type</td></tr><tr><td><code>length</code></td><td>Number of elements</td></tr><tr><td><code>default</code></td><td>Default value, when applicable</td></tr><tr><td><code>description</code></td><td>Optional description</td></tr></tbody></table>

The `frameworkToClient` and `clientToFramework` names express the same directionality represented by the DDF `PUBLISH` and `SUBSCRIBE` sets:

* `frameworkToClient` corresponds to data sent by the Framework.
* `clientToFramework` corresponds to data received by the Framework.

This also makes the direction more explicit when editing the interface in a spreadsheet.

Each domain referenced in the CSV body must first be defined in the Domain Descriptor.

Data items belonging to the same domain do not need to be placed next to each other.

If the `domain` field of a row is empty, Orchestra assigns that item to the domain most recently specified in the CSV body.

## Create a CSV file

You can create an Orchestra CSV file in either of the following ways:

* Create a text file and save it with the `.csv` extension.
* Create the data in Microsoft Excel and save the workbook as a CSV file.

When using a spreadsheet application, verify the generated CSV before importing it, particularly if the application automatically reformats values.

## Import CSV data into the DDF configurator

The **DDF Configurator** can import data from an Orchestra CSV file.

Use this workflow when:

* defining many data items;
* modifying an existing interface in bulk;
* preparing signal definitions in a spreadsheet;
* reusing similar signal lists across configurations.

The DDF Configurator supports:

* creating a DDF from scratch;
* importing and updating an existing DDF;
* importing CSV data; and
* exporting DDF data to CSV.

After importing the CSV, review the domain and data-item configuration in the DDF Configurator before using it in the co-simulation.

## Export DDF data to CSV

You can also use the DDF Configurator to export DDF data to CSV.

This is useful when you need to:

* review a large interface in tabular form;
* modify many data-item definitions;
* reuse the data definitions in another configuration; or
* compare interface definitions.

After making changes, import the CSV back into the DDF Configurator and regenerate or update the DDF as required.

## CSV and DDF mapping

The two formats represent the same core Orchestra concepts differently:

<table data-search="false"><thead><tr><th>Orchestra concept</th><th>DDF</th><th>CSV</th></tr></thead><tbody><tr><td>Domain</td><td><code>&#x3C;domain name="..."></code></td><td>Domain Descriptor / <code>domain</code></td></tr><tr><td>Synchronous mode</td><td><code>&#x3C;synchronous>yes/no&#x3C;/synchronous></code></td><td><code>synch=Y/N</code></td></tr><tr><td>Framework → External Component</td><td><code>PUBLISH</code> set</td><td><code>frameworkToClient</code></td></tr><tr><td>External Component → Framework</td><td><code>SUBSCRIBE</code> set</td><td><code>clientToFramework</code></td></tr><tr><td>Data type</td><td><code>&#x3C;type></code></td><td><code>type</code></td></tr><tr><td>Array length</td><td><code>&#x3C;length></code></td><td><code>length</code></td></tr><tr><td>Default value</td><td><code>&#x3C;default></code></td><td><code>default</code></td></tr><tr><td>Description</td><td><code>&#x3C;description></code></td><td><code>description</code></td></tr></tbody></table>

{% hint style="info" %}
**Important:** Notice that Boolean syntax differs between the two formats. For synchronous operation, the DDF uses `yes`/`no`, while the CSV Domain Descriptor uses `Y`/`N`. The CSV reference explicitly defines `synch` as `Y/N`.
{% endhint %}

## When to use CSV

Use the CSV format when the Orchestra interface contains many data items or when working in a spreadsheet is more convenient than editing XML directly.

Use the XML DDF when:

* manually configuring a small interface;
* reviewing the complete Orchestra structure;
* configuring connection-specific XML attributes;
* troubleshooting the exact configuration consumed by Orchestra.

For a new user, understanding the **DDF structure first** is recommended, then using CSV as a convenience for managing larger interfaces.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/rt-lab/model-and-simulation/co-simulation/co-simulation-with-orchestra/configure-orchestra-data-exchange/orchestra-csv-file.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
