Vordefinierte Eigenschaften
Verwendung
Im Knowledge Management werden Standardeigenschaften für Ressourcen (Dateien und Ordner) verwendet. Diese geben z. B. an, wann welcher Benutzer ein Dokument angelegt hat. Neben der Nutzung dieser Standardeigenschaften ist es möglich, zusätzlich eigene Eigenschaften zu definieren.
Eigenschaften sollen nicht in allen Fällen für jedes Dokument oder jeden Ordner gelten. Ihr Einsatz ist auch eingeschränkt möglich. Entsprechend Ihren Anforderungen können Sie festlegen, für welche Dokumente, Ordner, MIME-Typen oder Ressourcentypen bestimmte Eigenschaften gültig sein sollen.
Integration
● Vordefinierte Eigenschaften werden bei der Suche berücksichtigt. Bei einer Suchanfrage können Sie gezielt nach Dokumenten suchen, die bestimmte vordefinierte Eigenschaften aufweisen.
● Der Komponenten-Monitor nutzt vordefinierte Eigenschaften um Systemzustände anzuzeigen.
● In Ressourcen-Renderer-Einstellungen und Collection-Renderer-Einstellungen können Sie vordefinierte Eigenschaften angeben (siehe auch Anzeige von Eigenschaften).
● In Eigenschaftsstrukturen können Sie vordefinierte Eigenschaften geordnet anzeigen lassen.
Voraussetzungen
Der Service für Eigenschaften und Metadaten ist aktiviert.
Funktionsumfang
Namensräume
Bei der Definition einer Eigenschaft muss ein Namensraum angegeben werden. Ein Namensraum definiert einen Systembereich, in dem eine Eigenschaft (definiert durch ihre Eigenschafts-ID) genau einmal existieren darf.
Möchten Sie eigene Eigenschaften anlegen, ist es empfehlenswert, einen eigenen Namensraum zu nutzen.
Die Konfiguration eines Namensraumes umfasst folgende Parameter:
Parameter eines Namensraumes
Parameter |
Obligatorisch |
Beschreibung |
Alias |
Ja |
Alias des Namensraumes |
Namespace |
Ja |
Angabe des Namensraumes z. B. http://sapportals.com/xmlns/mynamespace |
Gruppen
Sie können Eigenschaften, die zueinander in einem gewissen Kontext stehen in Gruppen zusammenfassen. Diese Gruppen werden z. B. bei den Ressourcen-Renderer-Einstellungen verwendet.
Die Konfiguration einer Gruppe umfasst folgende Parameter:
Parameter einer Gruppe
Parameter |
Obligatorisch |
Beschreibung |
Name |
Ja |
Name der Gruppe |
Key for Label |
Nein |
Angabe des entsprechenden Schlüssels aus der Bundle-Datei, der für diese Gruppe verwendet wird Wird keine Schlüssel angegeben, wird in allen Sprachen auf der Oberfläche der Name der Gruppe angezeigt. Siehe auch Tabelle am Ende dieses Abschnitts |
Bundle File |
Nein |
Angabe einer Bundle-Datei, die Bezeichner und Schlüssel der Gruppe enthält Tragen Sie den Namen der Bundle-Datei mit Ihrer verwendeten Paketstruktur, aber ohne Erweiterung (.properties) ein, z. B. com.<%mycompany%>.km.resource.bundle.mybundle |
Position |
Nein |
Angabe der relativen Position, an der die Gruppe auf der Oberfläche angezeigt wird 0 = die
Gruppe wird an erster Stelle angezeigt Dieser Parameter wird ab EP 6.0 SP1 nicht mehr verwendet. |
Ausgeblendet |
Nein |
gibt an, ob die Gruppe auf der Oberfläche versteckt wird Dieser Parameter wird ab EP 6.0 SP1 nicht mehr verwendet. |
Die Eigenschaften sind in diesem Gruppentyp nicht geordnet. Möchten Sie die Reihenfolge der Eigenschaften vorgeben, dann verwenden Sie innerhalb einer Eigenschaftsstruktur eine Eigenschaftsgruppe (siehe Eigenschaftsstrukturen).
Metadatenerweiterungen
Eine Metadatenerweiterung ist ein modulares Set von Einstellungen, das Sie bei der Definition von Eigenschaften wiederverwenden können. In der Definition einer Metadatenerweiterung können Sie neben einer Bundle-Datei auch JAVA-Klassen angeben, die ergänzende Funktionen implementieren.
Parameter einer Metadatenerweiterung
Parameter |
Obligatorisch |
Beschreibung |
Name |
Ja |
Name der Metadatenerweiterung |
Description |
Nein |
nähere Beschreibung der Metadatenerweiterung |
Bundle File |
Nein |
Angabe der genutzten Bundle-Datei Tragen Sie den Namen der Bundle-Datei mit Ihrer Paketstruktur, aber ohne Erweiterung (.properties) ein, z. B. com.<%mycompany%>.km.resource.bundle.mybundle Siehe auch Tabelle am Ende dieses Abschnitts |
Dynamic Values Class |
Nein |
Angabe einer JAVA-Klasse, die einer Eigenschaft mögliche Werte zuweist |
Validation Class |
Nein |
Angabe einer JAVA-Klasse, die prüft, ob Werte einer Eigenschaft im verwendeten Kontext gültig sind Sie können bspw. eine JAVA-Klasse bereitstellen, die das Format von Datumsangaben prüft. |
Eigenschafts-Renderer
Ein Eigenschafts-Renderer wird zur Anzeige von Eigenschaften auf der Benutzungsoberfläche verwendet. In der zugehörigen JAVA-Klasse können auch Abhängigkeiten mit anderen Eigenschaften implementiert sein.
In der Standardauslieferung sind bereits mehrere Eigenschafts-Renderer enthalten. Wenn Sie eigene Eigenschafts-Renderer definieren möchten, müssen Sie JAVA-Klassen bereitstellen, die diese implementieren.
Parameter von Eigenschafts-Renderern
Parameter |
Obligatorisch |
Beschreibung |
Name |
Ja |
Name des Eigenschafts-Renderers |
Beschreibung |
Nein |
nähere Beschreibung des Eigenschafts-Renderers |
Display Modes |
Ja |
Angabe der Anzeigemodi, bei denen der Eigenschafts-Renderer zur Anzeige der Eigenschaft verwendet werden soll create: beim Erstellen eines Dokuments display: beim Anzeigen eines Dokumentes edit: beim Anzeigen und Ändern eines Dokumentes list: bei einer Ressourcenliste Wenn Sie keine Angabe machen, wird ein Standard-Renderer verwendet. |
Renderer Class |
Ja |
Angabe der JAVA-Klasse, die den Eigenschafts-Renderer implementiert |
Definition einer Eigenschaft
Bei der Definition einer Eigenschaft können Sie neben dem Wertevorrat der Eigenschaft weitere Informationen (Metadaten) angeben:
Parameter von Eigenschaften
Parameter |
Obligatorisch |
Beschreibung |
Unique ID |
Ja |
Angabe eines eindeutigen Bezeichners, der vom Configuration-Framework verwendet wird |
Description |
Nein |
nähere Beschreibung der Eigenschaft |
Property ID |
Ja |
Bezeichner, der in Kombination mit dem Parameter Namespace Alias einen eindeutigen Bezeichner der Eigenschaft im System bildet |
Namespace Alias |
Ja |
Auswahl eines Namensraumes, der der Eigenschaft zugewiesen werden soll |
Typ |
Ja |
Angabe des Typs der Eigenschaft folgende Typen stehen zur Verfügung: Boolean, Date, Integer, RID, String, Text, Time, Timestamp, User, URL, XML Die Information über den Typ der Eigenschaft kann von anderen Services oder Komponenten ausgelesen und weiterverarbeitet werden. Hinweis für Eigenschaften des Typs User: Beachten Sie die Erläuterung in der Beschreibung des Parameters Default Value. Hinweis: Wenn Sie nachträglich den Typ einer indizierbaren Eigenschaft ändern, müssen Sie die betroffenen Indizes reindizieren. Hinweis für die spätere Indizierung: Standardmäßig indiziert TREX Eigenschaften des Typs String als Text-Eigenschaften. Sie können aber auch festlegen, dass TREX diese Eigenschaften als String indizieren soll. Weitere Informationen: Eigenschaften bei TREX als String indizieren |
Group |
Ja |
Auswahl einer Gruppe, die der Eigenschaft zugeordnet werden soll |
Obligatorisch |
Nein |
gibt an, ob die Eigenschaft obligatorisch ist Z. B. können Sie ein Dokument erst dann im System abspeichern, wenn Sie die zugehörige Eigenschaft mit einem Wert belegt haben. Obligatorische Eigenschaften werden auf der Benutzungsoberfläche mit einem Stern angezeigt. |
Multi-Valued |
Nein |
gibt an, ob die Eigenschaft mehrere Werte annehmen kann |
Read Only |
Nein |
gibt an, ob die Eigenschaft schreibgeschützt ist Beispiel: eine systemnahe Eigenschaft wie Dateigröße darf nicht manuell verändert werden |
Maintainable |
Nein |
gibt an, ob der Wert der Eigenschaft nachträglich geändert werden Nutzen Sie die Kombination der Parameter Maintainable und Read Only, um der Eigenschaft einmalig einen Wert direkt nach dem Anlegen einer Datei oder eines Ordner zuzuweisen. |
Indexable |
Nein |
gibt an, ob die Eigenschaft indiziert werden kann Aktivieren Sie diesen Parameter, wenn Sie bei einer Suchanfrage diese Eigenschaft berücksichtigen möchten. |
Default Value |
Nein |
Angabe eines Standardwertes Dieser Standardwert wird der Eigenschaft einer Datei oder eines Ordner automatisch nach dessen Anlage zugewiesen. Hinweis für Eigenschaften des Typs User: Wenn Sie bei neuen Eigenschaften den Typ User verwenden und im Parameter Default Value %user.id% eintragen, wird auf der Benutzungsoberfläche im Eingabefeld der Eigenschaft automatisch der aktuelle Benutzer als Wert eingetragen. |
Allowed Values (csv) |
Nein |
kommagetrennte Angabe der Werte, die die Eigenschaft annehmen kann z. B. value_01,value_02,value_03 In den Bundle-Dateien der verschiedenen Sprachen können Sie für jeden Wert einen Bezeichner in der jeweiligen Sprache angeben. z. B. in der Bundle-Datei der Standardsprache (zumeist Englisch) my-labels.properties: value_color_01=Green und in der deutschen Bundle-Datei my-labels_de.properties: value_color_01=Grün Das System wendet eine alphanumerische Sortierung an, wenn die Liste im Dialogfenster Eigenschaften gerendert wird. Diese Sortierung wird auch für sprachabhängige Wertelisten angewandt. |
Key for Label |
Nein |
Angabe des entsprechenden Schlüssels aus der Bundle-Datei, der für diese Eigenschaft verwendet wird Wird kein Schlüssel angegeben, wird in allen Sprachen auf der Oberfläche die Property ID der Eigenschaft angezeigt. siehe auch Tabelle am Ende dieses Abschnitts und Bezeichner von Eigenschaften ändern |
Meta Data Extension |
Nein |
Angabe einer Metadatenerweiterung, die für diese Eigenschaft verwendet werden soll |
Folder Validity Patterns (csv) |
Nein |
kommagetrennte Angabe der Ordner (nur die Ordner selbst, nicht die enthaltenen Dokumente), denen diese Eigenschaft zugewiesen wird Falls Sie bereits eine Angabe im Parameter Document Validity Patterns gemacht haben, aber kein Folder Validity Pattern nutzen möchten, dann entfernen Sie hier den standardmäßig eingetragenen / aus dem Eingabefeld. Hinweis zur Notation: / und /** : die Eigenschaft
ist für den angegeben Ordner und alle Unterordnern gültig /* : die Eigenschaft ist nur für den angegeben Ordner gültig Beispiel: /runtime/** : Die Eigenschaft ist für alle Ordner und Unterordner im Repository runtime gültig. |
Document Validity Patterns (csv) |
Nein |
kommagetrennte Angabe der Ordner, deren bestehenden Dokumenten diese Eigenschaft zugewiesen wird Beim Anlegen neuer Dokumente wird die Eigenschaft automatisch den neuen Dokumenten zugewiesen. Hinweis zur Notation: / und /** : die Eigenschaft ist für alle Dokumente im angegeben Ordner und allen Unterordnern gültig /* : die Eigenschaft ist nur für die Dokumente im angegeben Ordner gültig Beispiel: /runtime/** : Die Eigenschaft ist für alle Dokumente im Repository runtime und dessen Unterordnen gültig. |
Resource Types (csv) |
Nein |
kommagetrennte Angabe der Ressourcen-Typen, die diese Eigenschaft annehmen können Ressourcen-Typen werden intern im Framework von KM verwendet. |
Mime Types (csv) |
Nein |
kommagetrennte Angabe der MIME-Typen, die diese Eigenschaft annehmen können |
Default Sorting |
Ja |
gibt die standardmäßige Art der Sortierung der Eigenschaft an, die von einem Collection-Renderer ausgewertet werden kann Ascending: es wird aufsteigend sortiert Descending: es wird absteigend sortiert Wenn Sie nach dieser Eigenschaft in einem KM-Navigations-iView sortieren möchten, müssen Sie diese im verwendeten Collection-Renderer im Parameter Property for Sorting (rndSortProperty) eintragen. |
Label Icon |
Nein |
Angabe einer Grafikdatei, die als Symbol zu dieser Eigenschaft angezeigt werden soll z. B. ein Vorhängeschloss für eine gesperrte Datei |
Hidden |
Nein |
gibt an, ob die Eigenschaft auf der Oberfläche angezeigt wird Aktivieren Sie diesen Parameter, wenn die Eigenschaft versteckt bleiben soll. |
Dependencies |
Nein |
gibt an, ob Abhängigkeiten zwischen dieser Eigenschaft und anderen Eigenschaften existieren Mit diesem Parameter wird z. B. die kontextsensitive Aktualisierung von Feldern umgesetzt. Sie geben die JAVA-Klasse, die diese Abhängigkeiten implementiert, in der Konfiguration eines Eigenschafts-Renderers an. Wenn zwischen dieser Eigenschaft und einer anderen Eigenschaft eine Abhängigkeit existiert, wählen Sie in der Konfiguration der anderen Eigenschaft den entsprechenden Eigenschafts-Renderer im Parameter Property Renderer aus. |
Additional Metadata (csv) |
Nein |
kommagetrennte Angabe von zusätzlichen Werten, die von anderen Services genutzt werden können |
Property Renderer |
Nein |
Angabe eines Eigenschafts-Renderers, der für diese Eigenschaft verwendet werden soll Wenn Sie keine Auswahl treffen, verwendet das System einen Standard-Renderer. Aktivieren Sie im Falle von Abhängigkeiten zu anderen Eigenschaften den Parameter Dependencies bei diesen Eigenschaften. |
Virtual |
Nein |
Eine Eigenschaft gilt als virtuell, wenn Sie automatisch durch das System generiert wird. Sie kann nur dann angezeigt und gepflegt werden, wenn das System sie aktuell verwendet. Z. B. werden die Eigenschaften cm_tbp_validfrom und cm_tbp_validto nur dann genutzt, wenn das zeitabhängige Publizieren eingeschaltet ist. |
Composed of |
Nein |
Angabe der Eigenschaften, aus denen die aktuelle Eigenschaft zusammengesetzt ist |
Comparator Class |
Nein |
Angabe einer JAVA-Klasse, die ein neues Sortierkriterium für das Sortieren von Ressourcenlisten anbietet Dies ist nützlich, wenn der Wert einer Eigenschaft kein sinnvolles Sortieren erlaubt. Z. B. könnten Sie eine JAVA-Klasse implementieren, die als Sortierkriterium für die Eigenschaft Benutzer nicht deren Wert (eine kryptische Benutzer-ID), sondern den vollständigen Namen des Benutzers verwendet. |
Quellen und Priorität der Bezeichner
Bezeichner von Eigenschaften und Gruppen können aus verschiedenen Systemquellen mit unterschiedlicher Priorität stammen.
Quellen und Priorität der Bezeichner von Eigenschaften
Quelle |
Priorität |
Hinweis |
Die Bezeichner und Werte sind in einer JAVA-Klasse (Dynamic Values Class), die in einer Metadatenerweiterung angegeben ist, enthalten. |
1 (höchste) |
Die Angaben können in den meisten Fällen nicht angepasst werden. |
Die Bezeichner und Werte sind in der Bundle-Datei, die in der Definition der Metadatenerweiterung angegeben ist, enthalten. |
2 |
Wir empfehlen, diese Datei zu pflegen. |
Die Bezeichner und Werte sind in der Bundle-Datei, die in der Konfiguration des Service für Eigenschaften und Metadaten angegeben ist, enthalten. |
3 |
|
Die Bezeichner und Werte sind in der systeminternen Bundle-Datei der Service-Implementierung enthalten |
4 |
Die Standard-Angaben sollten nicht angepasst werden. |
Statt eines Bezeichners wird die Angabe des Parameters Property ID, bzw. der Wert selbst verwendet. |
5 (niedrigste) |
erlaubt nur einsprachige Bezeichner |
Quellen und Priorität der Bezeichner von Gruppen
Quelle |
Priorität |
Hinweis |
Die Bezeichner sind in der Bundle-Datei, die in der Konfiguration einer Gruppe angegeben ist, enthalten. |
1 (höchste) |
Wir empfehlen, diese Datei zu pflegen. |
Die Bezeichner sind in der Bundle-Datei, die in der Konfiguration des Service für Eigenschaften und Metadaten angegeben ist, enthalten. |
2 |
|
Die Bezeichner und Werte sind in der systeminternen Bundle-Datei der Service-Implementierung enthalten |
3 |
Die Standard-Angaben sollten nicht angepasst werden. |
Statt einem Bezeichner wird die Angabe des Parameters Name verwendet. |
4 (niedrigste) |
erlaubt nur einsprachige Bezeichner |
Bundle-Dateien für Sprachversionen
Sprachversionen werden über verschiedene Bundle-Dateien realisiert. Ein Suffix im Namen der Bundle-Datei kennzeichnet die Sprachversion.
Die englischen Bezeichner und Schlüssel sind ist in der Bundle-Datei mit dem Suffix _en enthalten (z. B. mybundle_en.properties), die deutschen Bezeichner entsprechend in der Bundle-Datei mit dem Suffix _de (z. B. mybundle_de.properties).
Wenn kein Bundle für eine bestimmte Sprache vorhanden ist, greift das System automatisch auf die Standard-Bundle-Datei zu (z.B. myBundle.properties). Die Sprache der Standard-Bundle-Datei ist meistens Englisch. Weitere Informationen finden Sie unter Bezeichner von Eigenschaften ändern.
Einschränkungen
Das Repository-Manager-Framework überprüft nicht, ob Metadaten für vordefinierte Eigenschaften gültig sind. Somit wird auch die Information über den Typ einer Eigenschaft nicht mit dem angegebenen Wert der Eigenschaft verglichen und validiert. Der Service für Eigenschaften und Metadaten erweitert in erster Linie die Benutzungsoberfläche.
Aktivitäten
● Um eine Eigenschaft anzulegen oder zu konfigurieren, wählen Sie Content Management → Global Services → Property Metadata → Properties.
Bestehende Eigenschaften können Sie aus einem System exportieren und in ein anderes System importieren (siehe Export und Import von Eigenschaften und Metadaten).
● Um einen Namensraum anzulegen, wählen Sie Content Management → Global Services → Property Metadata → Namespaces.
● Um eine Gruppe anzulegen, wählen Sie Content Management → Global Services → Property Metadata → Groups.
● Um einen Eigenschafts-Renderer anzulegen oder zu konfigurieren, wählen Sie Content Management → Global Services → Property Metadata → Property Renderer.
● Um eine Metadatenerweiterung anzulegen oder zu konfigurieren, wählen Sie Content Management → Global Services → Property Metadata → Metadata Extensions.
Beispiel
Sie möchten im Ordner /documents/projectshare Textdokumenten die Eigenschaft Bearbeiter zuweisen. Die Konfiguration der Eigenschaft könnte so aussehen:
Unique
ID
= cm_bearbeiter
Description
= Beschreibt die Rolle „Bearbeiter“ im
Genehmigungsprozess
Key for Label
= cm_bearbeiter
Property ID
= Bearbeiter
Indexable
= Aktiviert
Maintainable
= Aktiviert
Mandatory
= Aktiviert
Default Sorting
= Ascending
Type
= User
Document Validity Patterns = /documents/projectshare/**
Mime Types
= text/plain
Group =
default
Metadata Extension =
myextension
Namespace Alias
= mynamespace
Da es sich bei den möglichen Bearbeitern um Personen handelt, geben Sie Type = User an. Um bei einer Suche gezielt nach Textdokumenten eines bestimmten Bearbeiters suchen zu können, aktivieren Sie den Parameter Indexable.
In der Definition der Metadatenerweiterung myextension tragen Sie die Bundle-Datei ein, die den Bezeichner für den Schlüssel cm_bearbeiterenthält.
Weitere Informationen
Bezeichner von Eigenschaften ändern