Solution Gallery Structure

The Solution Gallery has a strictly defined file and data structure that must be adhered to in order for solutions to be displayed in the OPC Router.

File Structure

The following outlines the file structure within a Solution Gallery:

• All solution entries (solution.yaml) must be located in directories at the root level.
• Tags are defined in an optional tags.yaml file at the root level and can be referenced in the individual solution.yaml files.
• Project data is located in a config directory at the solution level.
• Program data is located in a program directory at the solution level.

Example of a file structure:

📁 Solution Gallery Root
┣ 📁 Beispiel Solution 1
┃  ┣ 📁 config
┃  ┃  ┗ 📁 versioned
┃  ┃     ┣ 📁 ConnectionGroups
┃  ┃     ┃  ┗ 📁 Connections
┃  ┃     ┃     ┗ 📄 example_connection.yaml
┃  ┃     ┗ 📁 Plugins
┃  ┃        ┗ 📁 RestApi
┃  ┃           ┗ 📄 example_rest_plugin.yaml
┃  ┣ 📁 program
┃  ┃  ┗ 📁 devices
┃  ┃     ┗ 📄 example.dll
┃  ┣ 📄 description_de.md
┃  ┣ 📄 description_en.md
┃  ┗ 📄 solution.yaml
┗ 📄 tags.yaml

Format Version

The format version must be specified in all Solution Gallery-relevant configuration files (not project or program data) to ensure compatibility. Currently, the required value is 1.

For more information, see the following definitions and the Solution Structure.

Definitions

TranslatableString

A translatable string allows text to be translated automatically.

It is not necessary to specify individual fields. A value without a language specified is automatically used for all languages.

Field Name	Type	Description	Default Value
DE	string	German translation	Unknown
EN	string	English translation	Unknown

tags.yaml

Field Name	Type	Description
FormatVersion	int	Format version
Tags	Mapping (Tag metadata)	Key: Tag

IDValue: Tag metadata |

Tag metadata

Field name	Type	Description
DisplayName	TranslatableString	Display name of the tag
BackgroundColor	string	Tag background color (HEX, RGB)
TextColor	string	Tag text color (HEX, RGB)

Example

Below is an example of a tags.yaml file.

tags.yaml

FormatVersion: 1
Tags:
  example_tag:
    DisplayName:
      DE: "Beispiel Tag"
      EN: "Example Tag"
    BackgroundColor: "#52856c"
    TextColor: "white"