Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.
Sv translation
languagede

QRL steht für "QBRX Resource Locator". Eine QRL adressiert Facilities in QBRX sowie deren Ressourcen. 

<Ressourcen-Typ>:[<Facility-Pfad>]:<Ressource>

QRLs werden benötigt, um Facilities und Ressourcen in QBRX zu identifizieren. Sie werden zum Beispiel für die Adressierung von Datenpunkten benötigt.

Die Referenzen können sich sowohl auf Facilities selbst, als auch auf deren Ressourcen, wie zum Beispiel Eigenschaften, Datenpunkte oder Dokumente, beziehen. In diesem Beitrag erklären wir Ihnen, wie QRLs aufgebaut sind und zeigen anhand kurzer Anwendungsbeispiele, wie die einzelnen Ressourcen in QBRX jeweils referenziert werden können.


Absolute und relative Pfade

Ein Pfad ist eine Zeichenfolge, die innerhalb einer hierarchischen Struktur auf eine Facility verweist.

Pfade können sowohl absolut als auch relativ angegeben werden.

Absolute Pfade führen eindeutig zur adressierten Facility. Solche Zeichenfolgen sind dann sinnvoll, wenn unmissverständlich eine bestimmte Facility oder Ressource abgerufen werden soll. 

Relative Pfade hingegen sind vom jeweiligen Bezugsort abhängig. Bei Datenpunkten, welche sich auf anderen Datenpunkte beziehen, sind relative Pfade sinnvoll, da auch nach einer Verschiebung der Facility, weiterhin alle Referenzen im Datenpunkt stimmen. 

Adressierung von Facilities

Eine Facility wird wie folgt adressiert:

fac:<Facility-Pfad>

Die QRL besteht aus zwei Teilen:

  • Ressourcentyp "fac"
  • Pfad der Facility
    • Absolut: /<Facility-Key> wählt eine Facility aus
    • Relativ: .. - wählt die Parent-Facility aus 
    • <Facility-Pfad>/<Facility-Key> - wählt ein Kind aus

...


Adressierung von Facility-Ressourcen

Eine Facility-Ressource wird wie folgt adressiert:

<Ressourcen-Typ>:[<Facility-Pfad>]:<Ressource>

Die QRL zur Adressierung von Facility-Ressourcen besteht aus drei Teilen:

  • Typ der Ressource
    • "doc" - Dokumente
    • "dp" - Datenpunkte
    • "prop" - Eigenschaften
  • Pfad der Facility
  • Ressource (Key)
    • Bezeichnung bzw. Identifikator einer Ressource, eines Datenpunktes oder einer Eigenschaft 

Anwendungsbeispiele

AnwendungsfallAdressaufbauTypQRL
Adressierung einer einzelnen Facility

Facility-Pfad und Facility-Key

absolut

fac:/hoerburger/niederlassung_erfurt

Eltern-Facility und Facility-Key

relativ

fac:../niederlassung_erfurt

Facility-Key

relativ

fac:niederlassung_erfurt

Adressierung eines einzelnen DokumentsFacility-Pfad und Ressourcen-Keyabsolut

doc:/hoerburger/niederlassung_erfurt:energiereport_april_

...

2022

Ressourcen-Keyrelativ

doc::energiereport_april_

...

2022

Adressierung eines DatenpunktesFacility-Pfad und Ressourcen-Keyabsolut

dp:/hoerburger/niederlassung_erfurt:electricity_load_profile

Eltern-Facility, Facility-Key und Ressourcen-Keyrelativ

dp:../niederlassung_erfurt:electricity_load_profile

Eltern-Facility und Ressourcen-Keyrelativ

dp:..:electricity_load_profile

Ressourcen-Keyrelativ

dp::electricity_load_profile

Sv translation
languageen

QRL stands for "QBRX Resource Locator". A QRL addresses facilities in QBRX and their resources. 

<resource type>:[<facility path>]:<resource>

We use QRLs to identify facilities and resources in QBRX. They could, for instance, be used to address data points.

QBRX can refer to facilities and their resources, like properties, documents or data points. In this article, we'll be talking about the general structure of QRLs and some practical examples on how to refer to facilities and single resources in QBRX.


Absolute and relative paths

A path is a string, that refers to a facility inside a hierarchical structure.

Paths can be absolute or relative.

Absolute paths lead explicitly to the addressed facility. Such strings are used to explicitly identify a certain facility or resource. 

The outcome of a relative path depends on its current place of reference. Relative paths are useful for data points, that refer to other data points, because all of the references still work, even after moving a facility.

Addressing facilities

A facility is referred to like this:

fac:<facility path>

The QRL consists of two parts:

  • Resource type "fac"
  • Path of the facility
    • Absolute: /<Facility-Key> - leads to a facility
    • Relative: .. - leads to a parent-facility
    • <facility path>/<facility key> - leads to a sub-facility


Addressing facility resources

A facility resource is referred to like this:

<resource type>:[<facility path>]:<resource>

The QRL consists of three parts:

  • Resource type
    • "doc" - documents
    • "dp" - data points
    • "prop" - properties
  • Facility path
  • Resource (key)
    • Name of a resource, data point or property


Examples

ApplicationAddress structureTypeQRL
Addressing a single Facility

Facility path and facility key

absolute

fac:/hoerburger/niederlassung_erfurt

Parent-facility and facility key

relative

fac:../niederlassung_erfurt

Facility key

relative

fac:niederlassung_erfurt

Addressing a single DocumentFacility path and resource keyabsolute

doc:/hoerburger/niederlassung_erfurt:energiereport_april_2022

Resource keyrelative

doc::energiereport_april_2022

Addressing a data pointFacility path and resource keyabsolute

dp:/hoerburger/niederlassung_erfurt:electricity_load_profile

parent-facility, facility key and resource keyrelative

dp:../niederlassung_erfurt:electricity_load_profile

parent-facility and resource keyrelative

dp:..:electricity_load_profile

resource keyabsolute

dp::electricity_load_profile