| Sv translation | ||||
|---|---|---|---|---|
| ||||
In der Facility-Bibliothek sind alle Facility-Typen, dazu gehörige Eigenschaften und Meanings hinterlegt. Damit das System der Facility-Bibliothek funktioniert, welches vor allem von intelligenten Vererbungen innerhalb der Facility-Typen profitiert, ist es wichtig, dass die Bibliothek effizient verwaltet wird. Deshalb besprechen wir in diesem Artikel 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 allgemein wie möglich zu gestalten, bedeutet, dass sie für so viele Anwendungsfälle wie möglich einsetzbar sind. Das heißt, dass zum Beispiel 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, dass sie optimal zu ihrem Anwendungsbereich passen. Beispiel: Beim Einrichten einer Facility für ein Büro ist es möglich, den Typen "Raum" zu verwenden, da dieser so allgemein gestaltet ist, dass er zu allen Räumen ohne spezielle Anforderungen passt. Ein Facility für einen Kühlraum bringt jedoch unter Umständen besondere Anforderungen mit sich, weshalb es notwendig ist, einen spezifischeren Typen zu verwenden. 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 Einstellungen benötigen, die so nicht durch andere Typen abgedeckt werden. Ist dies nicht der Fall, sollte kein neuer Facility-Typ angelegt werden! Beispiel: Soll eine Kaffeemaschine als Facility angelegt werden, ist es durchaus möglich, dass alle dafür notwendigen Eigenschaften wie "Hersteller" oder "Garantie bis" bereits am Typen "Equipment" hinterlegt sind. Daher kann dieser Facility-Typ für die Kaffeemaschine benutzt werden. Wird eine neue Eigenschaft benötigt, wie zum Beispiel "Sorte der Kaffeebohnen", kann ein neuer Typ angelegt werden. 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 "Geeicht bis" benötigt. Diese Eigenschaft findet aber auch am übergeordneten Typen "Zähler" und all seinen anderen untergeordneten Facility-Typen Verwendung. Es ergibt jedoch keinen Sinn, die Eigenschaft beim Typen "Equipment" zu verwenden, da sie nicht für alle dort untergeordneten Typen gilt. "Geeicht bis" sollte demzufolge beim höchstmöglichen 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 separate 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 Eigenschaftenseite an Facilities übersichtlicher, hilft dem Nutzer dabei, diese einzutragen und erleichtert die Zuordnung. Beispiel: Beim Facility-Typen "Equipment" können zahlreiche Angaben zu den Ausrüstungsgegenständen als Eigenschaft hinterlegt werden. Allgemeine Angaben wie der Hersteller oder die Inventar Nummer werden in einer Gruppe zusammengefasst, ebenso wie alle technischen Daten und die Abmessungen des Geräts. 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 eindeutig von anderen unterscheidbar ist. 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 eine Zahl als Wert 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 man sich an vorher festgelegte Konventionen halten, um eine gewisse Konsistenz zu gewährleisten. Damit diese eindeutig und konsistent benannt werden, 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 properties and meanings. The systems of the facility library and the inheritance of types works best if it's efficiently build and managed. 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. This mans that a type and 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 lots of 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 a facility that should represent an office, because it is designed to match all rooms without any special requirements. However, a facility for a cooling chamber might come with certain specifications that require a more specialized type. Control if a new type is necessary!Some facilities are so specific that they need their own type, because they require settings that are not covered by other types. A new type should only be created if that's the case! Example: A new facility for a coffee machine needs properties like "Manufacture" and "Warranty until" that are covered by the type "Equipment". So this type could easily be used for a coffee machine. It would only be necessary to create a new type if a special property is needed, e.g. "Type of coffee beans". Use the inheritance wisely!Properties are passed on from higher-ranking to subordinate facilities. Like this, general properties can be reused at specialized types. That's why they should be used as high as possible. Example: The facility type "Electricity meter" requires the property "Calibrated until" This property is also used by the higher-ranking type "Meter" and all of its subordinate facility types. However, it would not make sense to add this property to "Equipment", because not all of its sub-types would use it. "Calibrated until" should therefore be used by the highest possible 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 separate 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 then it would make it impossible to separate the data, especially at higher-ranked 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. Example: The facility type "Equipment" enables you to add a lot of information about your appliances as properties. General information like the manufacturer ir the inventory number are grouped up, just like all technical data and the dimensions of the device. Simplify the search for facilities!If a property marked as "searchable", its associated facility can be found in QBRX via the search function. 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 can definitely be distinguished from others. 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 number. 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 a simple number is not specific enough and would just deliver too many, incoherent results. Tips for a successful 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 so enable a consistent and clear naming. 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" fot "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. |