Metadata

These labels travel with the service commissioning file, so a service stays recognizable wherever it is installed or stored.

The metadata section (required) holds the properties that identify a service, such as its name and version. Connectware requires only name.

Metadata Properties

Property	Type	Required
name	string	Required
homepage	string	Optional
icon	string	Optional
provider	string	Optional
version	string	Optional

name

A short title typically used in UI representation.

It is allowed to use parameter substitutions in this property, for example setting it to !sub 'Machine ${machineNum}' if there exists a parameter machineNum.

The auto-generated default Service ID will be generated from this string by removing all characters that are not allowed for the Service ID. For backward-compatibility reasons, in Connectware version 1.0.x all characters are changed to lowercase and also all punctuation is removed, including underscore and period.

• Required

• Type: string

  • maximum length: 80 characters

homepage

URL to the homepage of the provider

• Optional

• Type: string

• Format: uri – Uniform Resource Identifier (according to RFC3986)

icon

A link to an icon image typically used in UI representation

• Optional

• Type: string

provider

The provider/author of the this service commissioning file

• Optional

• Type: string

version

A version number for the service. Connectware accepts any string, so use whichever scheme suits you, such as a semantic version, and raise it as you revise your service commissioning file.

Connectware shows this value in the Version column of the Service Overview.

This property is unrelated to the version section, which declares the format of the service commissioning file itself.

version: 1.0.0

• Optional

• Type: string

Example

metadata:
  name: Simulated Machining Center
  icon: https://example.com/machine-icon.svg
  provider: cybus
  homepage: https://www.cybus.io