| Sv translation | ||||
|---|---|---|---|---|
| ||||
In der Facility-Bibliothek sind alle Facility-Typen, dazu gehörige Eigenschaften und Meanings hinterlegt. Eigenschaften, die an Facility-Typen hinterlegt sind, werden in der Hierarchie nach unten hin vererbt. Deshalb ist es wichtig, die Bibliothek so aufzubauen, dass diese Vererbung sinnvoll genutzt werden kann. In diesem Artikel besprechen wir in Form eines Best-Practice die wichtigsten Aspekte, die bei der Verwaltung der Facility-Bibliothek zu beachten sind.
Regeln zum Anlegen von Typen, Meanings und EigenschaftenSo allgemein wie möglich und so spezifisch wie nötigAlle Facility-Typen und ihre Elemente so allgemein wie möglich zu gestalten, bedeutet, dass sie für so viele Anwendungsfälle wie möglich einsetzbar sind. Das heißt, dass ein Typ so gestaltet sein muss, dass seine dazugehörigen Properties und Meanings auf so viele Facilities wie möglich übertragbar sind. Durch einen solchen Aufbau kann der Facility-Typ für viele Facilities genutzt werden und gleichzeitig problemlos Eigenschaften an zahlreiche untergeordnete Facility-Typen vererben. Die Facility-Typen und ihre Elemente sollten dennoch so spezifisch wie nötig beschrieben werden! Sie sollten zwar universell einsetzbar, aber trotzdem so spezifisch gestaltet sein, dass sie optimal zu ihrem Anwendungsbereich passen. Beispiel: Der Typ "Raum" ist so allgemein gehalten, dass er für eine Vielzahl an Facilities verwendet werden kann, die keine besonderen Anforderungen haben, wie zum Beispiel Büros. Es gibt jedoch auch spezifischere Raum-Typen wie "Kühlraum", die für Facilities geeignet sind, die spezielle Eigenschaften für die Auswertung ihrer Daten benötigen. Kontrolliere, ob ein neuer Typ wirklich notwendig ist!Einige Facilities sind so spezifisch, dass es notwendig ist, einen eigenen Typen für sie anzulegen, weil sie Eigenschaften benötigen, die so nicht durch andere Typen abgedeckt werden. Ist dies nicht der Fall, sollte kein neuer Facility-Typ angelegt werden! Beispiel: Am Typen "Equipment" sind zahlreiche Eigenschaften hinterlegt, die auf eine Vielzahl an unterschiedlichen Geräten passen. Deshalb kann dieser Typ für viele Geräte verwendet werden. Es wäre erst dann nötig, einen neuen Typen anzulegen, wenn zusätzliche Eigenschaften an einer Facility benötigt werden, die noch nicht an "Equipment" hinterlegt sind und nicht zu "Equipment" oder dessen untergeordneten Typen passen. Zum Beispiel "Sorte der Kaffeebohnen" bei einer Facility für eine Kaffeemaschine. Nutze die Vererbung weise!Eigenschaften werden immer von übergeordneten an untergeordnete Facility-Typen vererbt. So können allgemeine Eigenschaften an speziellen Typen wiederverwendet werden. Deshalb sollten sie so weit oben wie möglich in der Hierarchie eingesetzt werden. Beispiel: Beim Facility-Typen "Elektrozähler" wird die Eigenschaft "Zählernummer" benötigt. Diese Eigenschaft findet aber auch am übergeordneten Typen "Zähler" und all seinen anderen untergeordneten Facility-Typen Verwendung. Es ergibt jedoch wenig Sinn, die Eigenschaft beim Typen "Equipment" zu verwenden, da sie nicht für alle dort untergeordneten Typen sinnvoll ist. "Zählernummer" sollte demzufolge beim Typen "Zähler" angebracht werden, da es sinnvoll auf alle untergeordneten Typen vererbt werden kann. Nutze Meanings um Daten zu separieren!Wenn es notwendig ist, Daten separiert voneinander zu aggregieren, werden auch getrennte Meanings benötigt. Beispiel: In den meisten Fällen ist es notwendig, die Lastgänge vom Erdgas und der Elektrizität getrennt voneinander auszuwerten. Natürlich könnte man für beides das Meaning "Lastgang" benutzen, aber dann wäre es nicht möglich, die Daten auch in übergeordneten Facilities voneinander zu unterscheiden. Da ein Bedarf daran besteht, die Lastgänge getrennt voneinander zu betrachten, ist es auch sinnvoll, separate Meanings anzulegen. Hinweise zu EigenschaftenGruppiere Eigenschaften sinnvoll!Eine sinnvolle Gruppierung von Eigenschaften macht die Eigenschaftsseite an Facilities übersichtlicher, hilft dem Nutzer dabei, diese einzutragen und erleichtert das Verständnis. Alle Eigenschaften, die keiner Gruppe zugeordnet werden, werden automatisch der Gruppe "Allgemeine Angaben" zugeordnet. Beispiel: Beim Facility-Typen "Equipment" können zahlreiche Angaben zu den Ausrüstungsgegenständen als Eigenschaft hinterlegt werden. Technischen Daten und die Abmessungen des Geräts haben jeweils eine eigene Gruppe. Vereinfache die Facility-Suche!Ist eine Eigenschaft als "searchable" markiert, kann deren zugehörige Facility in QBRX über die Suche gefunden werden. Eigenschaften sollten als "searchable" markiert werden, wenn sie dabei helfen, Facilities zu finden. Es sollte jedoch nicht jede Eigenschaft markiert werden, da sonst unnötig viele Suchergebnisse geliefert werden. Die Funktion sollte auch nur bei Eigenschaften verwendet werden, deren Wert typisch für eine bestimmte Eigenschaft ist, wie zum Beispiel eine Postleitzahl oder Telefonnummer. Beispiel: Adressen von Standorten sind sinnvolle, suchbare Eigenschaften, da der Nutzer manchmal eher die Adresse eines Ladens zur Verfügung hat, statt dessen Nummer. Auch der Hersteller von Ausrüstungsteilen ist eine Eigenschaft, nach der zum Beispiel gesucht werden kann, um baugleiche Geräte zu finden. Es wäre jedoch nicht sinnvoll, das Gewicht eines Objektes als "searchable" zu markieren, da ein solcher Zahlenwert nicht eindeutig genug ist und zu viele, zusammenhanglose Ergebnisse liefern könnte. Tipps zur BenennungNamen konsistent und eindeutig wählen!Eine eindeutige Benennung erleichtert es dem Nutzer, den richtigen Facility-Typen und dessen Elemente auszuwählen und danach zu filtern. Dabei sollte sich an vorher festgelegte Konventionen gehalten werden, um eine gewisse Konsistenz zu gewährleisten. Es sollte vorher eine dementsprechende Einigung getroffen werden, die in einer Dokumentation festgehalten wird. Abkürzungen vermeiden!Es gibt Abkürzungen, die allgemein bekannt sind und von jedem verstanden werden, wie zum Beispiel "z.B.". Es gibt allerdings auch Abkürzungen, die zwar praktisch erscheinen, aber aufgrund ihrer Unbekanntheit oder Doppeldeutigkeit mehr Probleme verursachen als lösen. Nicht jeder kennt die Abkürzung "NTH" für "nice to have". Stattdessen könnte sie auch als "Nothing" oder "No Therapy Helpful" gedeutet werden. Im Zweifelsfall sollte immer davon ausgegangen werden, dass die Bedeutung einer Abkürzung nicht bekannt ist! |
| Sv translation | ||||
|---|---|---|---|---|
| ||||
The facility library contains all facility types, their respective properties and meanings. Properties of facility types will be passed on to subordinate ones. That's why it's important to build a library that wisely utilizes this inheritance system. We'll be talking about some important aspects in form of a best practice that will help you with the management of the facility library.
Rules for the creation of types, meanings and propertiesAs general as possible and as specific as necessaryDesigning all facility types and their elements as general as possible means that they can fit as many scopes as possible. A type, its properties and meanings should, for example, be build to apply to various facilities. Such a structure enables the usage of a facility type for many facilities and an easy inheritance of properties to subordinate facility types. However, the facility types and their elements should also be modeled as specific as possible. They should be used in an universal way but still be specific enough to optimally match the requirements of their scope. Example: The facility type "Room" can be used for various facilities without any special requirements, e.g. offices. However, there also are more specific types such as "Cooling chamber" that suit facilities that need additional properties to evaluate data. Check the necessity of a new type!Some facilities require specific properties that are not covered by other types and therefore need their own type. A new type should only be created if that's the case and no other type matches the facility's requirements! Example: The type "Equipment" has many properties that fit various different devices. That's why it can be used for a lot of facilities. It would only be necessary to create a new type if additional properties are needed that don't fit "Equipment" and its sub-types. For example "Type of coffee beans" for a coffee machine facility. Use the inheritance wisely!Properties are passed down from higher-ranking to subordinate facility types. Like this, general properties can be reused at specialized types. That's why properties should be assigned as high as possible. Example: The facility type "Electricity meter" requires the property "Meter number". This property is also used by the higher-ranking type "Meter" and all of its other subordinate facility types. However, it would probably make no sense to add this property to "Equipment", because not all of its sub-types would use it. "Meter number" should therefore be used by the type "Meter" so it can reasonably be passed down to its sub-types. Use meanings to separate data!If it's necessary to separately aggregate data, you'll also need different meanings. Example: In most cases, it does make sense to separately evaluate load profiles for gas and electricity. The meaning "Load profile" could of course be used for both, but this would make it impossible to separate the data, especially at higher-ranking facilities. If there is a need for separate aggregation, like in this case, separate meanings should be used. Tips for propertiesGroup up properties reasonably!A reasonable grouping of properties tidies up the property page of a facility and helps the user to add new properties and assign them correctly. All properties without a group will automatically be grouped up under "General information". Example: The facility type "Equipment" enables you to add a lot of information about your appliances as properties. All technical data and the dimensions of the device have their own groups. Simplify the search for facilities!If a property is marked as "searchable", its associated facility can be found in QBRX via the global filter. Properties should be marked as "searchable" if they are helpful for the search for facilities. However, not every property fits these criteria. Some are too unspecific and a search for them would deliver too many results. The function should therefore only be used for properties whose values are typical for their respective property, like a postal or a telephone number. Example: Addresses of sites are reasonable, searchable properties, because it could be easier for the user to look for the address of a shop than for its name. The manufacturer of equipment could also be searchable due to the fact, that a search for identically structured devices could be helpful. However, it would not make sense to look for the weight of a device, because such a numeric value is not specific enough and would just deliver too many, incoherent results. Tips for a reasonable namingChoose consistent and clear names!A definite naming makes it easier for the user to choose the right facility types and its elements and to filter them. Previously set conventions should hold on to to ensure a certain consistency. An appropriate agreement should be created beforehand and written down in a documentation. Avoid acronyms!Some acronyms are well known and understood by almost everybody, for example "e.g.". However, there are also acronyms that seem to be practical but fail to work in reality due to their unfamiliarity and ambiguity. More problems are cause than solved by them. Not everybody knows the acronym "NTH" for "nice to have". It could also mean "nothing" or "no therapy helpful". If in doubt, leave it out! It's always safer to assume that the meaning of an acronym is unknown. |