> 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/ddf-configurator.md).

# DDF Configurator

## Introduction

The **DDF Configurator** provides a graphical interface for creating and editing Orchestra Data Description Files (DDFs).

Use it to:

* create and configure domains;
* create Publish and Subscribe data items;
* edit item properties;
* open and modify existing DDFs;
* import DDF or CSV data; and
* save configurations as DDF or CSV files.

## Interface overview

The DDF Configurator contains two main views:

* **Explorer View:** Displays the DDF hierarchy, including the Orchestra root element, domains, Publish and Subscribe sets, and data items.
* **Properties View:** Displays the properties of the element currently selected in the Explorer View.

Use the Explorer View to navigate and organize the DDF, then use the Properties View to configure the selected element.

## Create a Domain

A domain contains:

* a **Publish** set for data sent from the Framework to the External Component; and
* a **Subscribe** set for data received by the Framework from the External Component.

To create a domain:

1. Right-click the Orchestra root element and select **Add Domain**.
2. Select the new domain and press **F2** to rename it.
3. Configure the domain properties in the Properties View.

The Orchestra training workflow confirms this sequence: right-click to add a domain, press F2 to rename it, then configure properties such as synchronization, states, multiple publishers, and connection type. [\[OP-400\_Co-...estra\_edit | PowerPoint\]](https://opalrttechnologies104.sharepoint.com/sites/TrainingMaterial/_layouts/15/Doc.aspx?sourcedoc=%7B12EBC94C-2BDB-4502-B5F7-DC966B214BBA%7D\&file=OP-400_Co-Simulation_Orchestra_edit.pptx\&action=edit\&mobileredirect=true\&DefaultItemOpen=1)

A newly created domain contains empty Publish and Subscribe sets.

> **Important:** Domain names must be unique within the DDF.

***

### Create a Data Item

Create each data item in either the Publish or Subscribe set of its domain.

To create a data item:

1. Right-click the appropriate **Publish** or **Subscribe** set.
2. Select **Add Item**.
3. Press **F2** to rename the item.
4. Configure its properties in the Properties View.

The current training material uses this same right-click and F2 workflow for adding and renaming data items. [\[OP-400\_Co-...estra\_edit | PowerPoint\]](https://opalrttechnologies104.sharepoint.com/sites/TrainingMaterial/_layouts/15/Doc.aspx?sourcedoc=%7B12EBC94C-2BDB-4502-B5F7-DC966B214BBA%7D\&file=OP-400_Co-Simulation_Orchestra_edit.pptx\&action=edit\&mobileredirect=true\&DefaultItemOpen=1)

Remember:

* **Publish**: Framework → External Component
* **Subscribe**: External Component → Framework

***

### Configure a Data Item

Select a data item in the Explorer View to configure its properties.

Depending on the item, properties include:

* name;
* type;
* length;
* description; and
* default value.

#### Default Values

Default values apply only to items in the **Subscribe** set.

I would keep that statement from your old documentation because it corresponds to the DDF semantics you have already documented: a default value provides the Framework with a value when subscribed data has not been provided by the External Component.

I would **not repeat all naming and datatype rules here**. Instead link to **Orchestra DDF Reference**.

***

### Open a DDF

To open an existing DDF:

1. Select **File > Open**.
2. Select the DDF.
3. Click **Open**.

The DDF Configurator parses the file and displays its content in the Explorer View.

If the DDF contains invalid syntax, the Configurator reports an error instead of loading the configuration.

***

### Import Configuration Data

#### Import a DDF

Use **File > Import > DDF** to merge domains from another DDF into the current configuration.

If an imported domain has the same name as a domain already present, that domain is rejected while processing continues with the remaining imported domains. This behavior is explicitly documented in the current Orchestra page. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

This is different from **Open**:

* **Open** replaces the configuration currently being viewed.
* **Import** adds compatible domains to the current configuration.

#### Import a CSV File

Use **File > Import > CSV File** to import Orchestra configuration data from CSV. The current Orchestra documentation explicitly lists CSV import through the DDF Configurator. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra)

For the CSV syntax, refer to **Orchestra CSV File Reference**.

***

### Save the Configuration

To save changes to an opened DDF, use the **Save** command.

To create a new file or save the configuration in another format, use **Save As** and select the required format:

* DDF (`.xml`)
* CSV (`.csv`)

This is where your **Orchestra CSV File Reference** page becomes complementary rather than repetitive.

***

### Select Domains and Data Items for Simulink Blocks

I would keep this part, but make it much shorter because it describes an important behavior that is easy to miss.

When the DDF Configurator is opened from an RT-LAB Orchestra Simulink block, select the domain that the block uses.

Only **one domain can be associated with a given block**.

You can also select which data items from that domain are mapped to the block's inputs and outputs.

> **Note:** Domain and item selection only affects mapping back to the Simulink block. When the DDF Configurator runs as a standalone application, these selections do not affect the generated DDF.

This section belongs here, not in **Orchestra DDF Reference**, because it is specific to Configurator behavior.

***

## What I would remove from the legacy content

#### Remove: Importing a Dymola Input File

I would **not migrate this section**.

The legacy Orchestra page does still contain a procedure for importing `dsin.txt`. The old [RT-LAB\_UG.pdf](https://opalrttechnologies104.sharepoint.com/sites/Support2/Shared%20Documents/General/RT-LAB_UG.pdf?web=1\&EntityRepresentationId=d0156fdf-9eee-491f-8057-4249c2348c36) contains the same workflow. [\[Orchestra | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/RD/pages/45881870/Orchestra) [\[RT-LAB\_UG | PDF\]](https://opalrttechnologies104.sharepoint.com/sites/Support2/Shared%20Documents/General/RT-LAB_UG.pdf?web=1)

However, this is historical functionality tied to the old Orchestra/Dymola integration. As we established earlier, the dedicated Orchestra Dymola workflow should not be presented as a current first-class integration. Current OPAL-RT Dymola documentation instead focuses on FMI/FMU workflows. [\[Via Suppor...elica IDEs | Confluence\]](https://opal-rt.atlassian.net/wiki/spaces/EUD/pages/23219750/Via+Supported+Modelica+IDEs)

#### Probably remove: Command-Line Arguments

I would also strongly consider **not migrating the `ddfConfig.jar` command-line section** unless Engineering confirms that this workflow is still supported and useful.

The commands:

java -jar ddfConfig.jar -open ...

and:

java -jar ddfConfig.jar -convert ...

look like implementation-level legacy tooling. They are not needed to understand or use the normal Configurator workflow.

If still supported and there is a real use case for automated conversion, put them in a small **DDF Configurator Command-Line Reference**, not on the main page.

#### Remove: Clearing the Explorer View

`File > Clear` does not deserve its own section. At most:

> Select **File > Clear** to remove all elements from the current Explorer View. This does not delete a previously saved DDF.

#### Compress: Renaming

You currently have separate **Renaming a Domain** and **Renaming a Data Item** sections. Combine the behavior:

> To rename a domain or data item, select it and press **F2**, enter the new name, then press **Enter**.

The training material confirms F2 as the normal rename workflow. [\[OP-400\_C](https://opalrttechnologies104.sharepoint.com/sites/TrainingMaterial/_layouts/15/Doc.aspx?sourcedoc=%7B12EBC94C-2BDB-4502-B5F7-DC966B214BBA%7D\&file=OP-400_Co-Simulation_Orchestra_edit.pptx\&action=edit\&mobileredirect=true\&DefaultItemOpen=1)


---

# 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/ddf-configurator.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.
