Dashboard-Metadaten erstellen und registrieren

Sie können Dashboard-Metadaten erstellen und registrieren, indem Sie deren XML-Definition festlegen und die registerDashboard()-Methode aufrufen.

Die Dashboard-Metadatendefinition basiert auf XML-Code.
  • Zum Erstellen von Dashboard-Metadaten müssen Sie den XML-Code für die Dashboard-Metadatendefinition erstellen.
  • Um Dashboard-Metadaten zu registrieren, rufen Sie registerDashboard( SCUIDashboardManager auf (die in der Javadoc-Ressource beschrieben ist).

XML-Codebeispiel: Dashboard-Metadatendefinition


<Dashboards>
			<Dashboard id="myhomepage" title="My Homepage" tag="tag_1,tag_n"
														version="0.0.1">
						<Config>
									<Layouts  currentLayoutId="twoEqualColumn">
												<Layout id="twoEqualColumn" type="column"
																				previewIconUrl="/stk/img/dashboard/2col_preview.png">
															<Column id="d_one" width=".49"/>
															<Column id="d_two" width=".49"/>
												</Layout>
									</Layouts>
						</Config>
						<Dashlets>    
									<Dashlet id="dashlet_one" parent="d_one" >
									</Dashlet>
									<Dashlet id="dashlet_two" parent="d_two">
												<Config numberOfColumns="1" >
												</Config>
									</Dashlet>
						</Dashlets>
			</Dashboard>
</Dashboards>
Die Attribut- und Elementbeschreibungen für das obige Beispiel sind nachstehend aufgeführt.
ID
Eindeutige ID des Dashboards. Diese ID wird zur Überprüfung der Ressourcenberechtigungen und der Autorisierung verwendet. Enthält ein Dashboard ein Dashlet, für das der Benutzer keine Berechtigung hat, wird das Dashlet dem Benutzer nicht angezeigt.
Titel
Titel des Dashboards. Das kann ein Paketschlüssel sein, der lokalisiert werden kann.
Markierung
Durch Kommas getrennte Werte für Tagnamen des Dashboards. Diese Tags werden für die Suche nach Dashlets mit übereinstimmenden Tags verwendet. Diese verwandten Dashlets sind beim Anpassen des Dashboards verfügbar.
Hinweis: Sie können auch andere Tags anzeigen, jedoch werden standardmäßig nur Dashlets mit übereinstimmenden Tags angezeigt.
Version
Version der Metadaten im Dashboard. Bei der Multi-Tenancy-Funktionalität können hiermit verschiedene Versionen der Dashboardmetadaten unterstützt werden.
Konfiguration
Das Config-Element dient zur Definition der Konfigurationsoptionen, die zum Übergeben des Dashboards verwendet werden. Eine derartige Konfigurationsoption ist z. B. das Layout von Dashlets in einem Dashboard.
Layouts werden zur Definition der Layout-Strategien verwendet, die von einem Dashboard unterstützt werden. Sie enthalten untergeordnete Elemente, die einzelne Layoutstrategien definieren. Aktuell wird als Dashboardstandardlayout nur ein Spaltenlayout unterstützt.
Dashlets
Liste aller Dashlets, die im Dashboard angezeigt werden sollen. Jedes Dashlet kann folgende Attribut- und Elementsätze enthalten:
  • ID. Referenz-ID des Dashlets, das zum Dashboard hinzugefügt werden soll.
  • Parent. ID des Layout-Containers, in dem das Dashlet hinzugefügt wird.