4.9. Site configuration

A site configuration defines the individual components that exists in a specific site. It also defines the relationship between those components.

The site configuration can either be defined as a separate YAML file or be combined with the YAML file of the SXL when needed. The Excel file always combines the SXL and the site configuration.

4.9.1. Meta data

In order to uniquely identify an SXL and site configuration for a supervision system the site id and the version needs to be known. See RSMP/SXL Version. The SXL defines the site id, but meta data is needed to provide the SXL version.

The site configuration may define a set of meta data of a specific site. It is defined in the first sheet named “Version” in in the Excel version and at the very top of the YAML version.

In each SXL it must defined which version of RSMP it conforms to.

It contains:

Table 4.33 meta data

Excel

YAML

Plant id

id

Plant name

description

Constructor

constructor

Reviewed

(not used)

Approved

(not used)

Created date

created-date

SXL revision [1]

version

RSMP version

rsmp-version

Footnotes

4.9.2. Components

A site consists of components, identified by unique component ids (cId).

Using the Excel format; components are defined in it’s own sheet - one for each site. Using the YAML format, each component is defined like this:

sites:
  <site-id>:
    description: site description
    components:
      <component-type>:
        <component-1>:
          componentId: AA+BBCCC=DDDEEFFF
          ntsObjectId: AA+BBCCC=DDDEEFFF
          externalNtsId: 00000

Where:

  • <site-id> is the site id. This is needed during initial handshake

  • description. Site description

  • <component-type> defines which component type the component belongs to

  • <component-1> is the name of the component. For instance “signal group 1”

  • componentId is the Component ID

  • ntsObjectId is the Component ID for the NTS object

  • externalNtsId is the External NTS id

A component can either be categorized as a single component or grouped component, also known as the main component(s).

The main component(s) is defined by componentId and ntsObjectId which are being set equal. This means that the component is visible from NTS.

Single components have a unique componentId but uses the ntsObjectId of their main component.

externalNtsId and ntsObjectId are optional and only used if the component is intended to be sent to NTS.

Note

NTS is used at the Swedish Transport Administration. Other road authorities typically leaves the xNid and ntsOid as empty strings.