Dieser Hilfetext beschreibt den Einstieg in die Arbeit mit dem Cockpit-ID-Tool und vermittelt einen Einblick in dessen Funktionsweise. Zunächst finden Sie einige generelle Hinweise zur Nutzung des Werkzeugs. Bitte gehen Sie diese aufmerksam durch, bevor Sie mit der Arbeit mit dem Tool beginnen. In den folgenden Abschnitten wird die Benutzung der Anwendung Schritt für Schritt beschrieben.
Aufgabe des Werkzeugs ist es, IDs an ausgewählte globale Elemente zu vergeben.
Dabei werden nur globale Elemente berücksichtigt, die noch keine ID haben.
Jede mit dem Tool vergebene ID besteht aus dem Präfix DB und einer vierstelligen
Nummer beginnend bei 0001. Während das Präfix fest ist, wird die Nummer
während der ID-Vergabe hochgezählt. Neue IDs werden entsprechend der
letzten bekannten (mit "DB" beginnenden) ID generiert.
Beachten Sie bitte, dass beim Löschen von globalen Elementen die entsprechenden
IDs wieder frei werden. Wenn also das globale Element DB0003 gelöscht wird,
und dieses die höchste Nummer hatte, dann wird diese Nummer wieder vergeben.<br>
Die IDs globaler Elemente, die bereits eine ID haben, werden nicht verändert -
auch dann nicht, wenn die ID vom beschriebenen Format abweicht.
Zusätzlich zum ID-Feld wird ein sogenanntes kombiniertes Namensfeld generiert. Dieses beinhaltet eine Kombination aus ID und Name des globalen Elements. Für ein Element mit der ID "DB0001" und dem Namen "Einkauf" würde demnach der Wert "DB0001 Einkauf" generiert werden.
Mit Hilfe der ID-Deaktivierungs-Eigenschaft wird festgesetzt, welche
globalen Elemente keine ID erhalten sollen. Dieser Wert steht standardmäßig
auf "falsch". Vergewissern Sie sich vor der ID-Vergabe, dass nur für diejenigen
globalen Elemente, die keine ID erhalten sollen, diese Eigenschaft auf "wahr"
gesetzt wurde.
Die ID von globalen Elementen, bei denen die Eigenschaft auf "wahr" steht,
wird gelöscht. In das kombinierte Namensfeld dieser Elemente wird der Elementname
eingetragen.
Das Tool sollte nur auf einem Client zur gleichen Zeit benutzt werden.
Andere Nutzer sollten Ihre Änderungen vor dem Start des Tools auf den Server spielen,
da ansonsten gesperrte globale Elemente nicht aktualisiert werden können.
Dies betrifft insbesondere neue und umbenannte globale Elemente, die noch
keine ID haben oder seit ihrer Umbenennung nicht aktualisiert wurden und ist
für die Aktualisierung des kombinierten Namensfeldes von Bedeutung.
Beachten Sie bitte, dass nur diejenigen globalen Elemente berücksichtigt werden,
die auf dem Client, der das Tool ausführt, bekannt sind. Es wird empfohlen,
sicherzustellen, dass alle relevanten Änderungen anderer Benutzer auf den
Server gespielt wurden. Aktualisieren Sie das Projekt manuell, um zu gewährleisten,
dass diese Änderungen auf Ihren Rechner übertragen sind.
Nach der Benutzung empfiehlt es sich, alle Änderungen auf den Server zu laden,
da mitunter viele globale Elemente gesperrt sein können. Eine Benutzung sollte
mit dem Starten des Tools beginnen und mit dem Hochladen der Änderungen enden.
Sofern nicht bereits geschehen, ist es notwendig Eigenschaften für globale Elemente zu definieren, die dann vom Tool mit den entsprechenden Werten gefüllt werden können.<br> Gehen Sie dazu wie folgt vor:
Wählen Sie im Projektnavigator Ihr Projekt aus und öffnen Sie mit der rechten Maustaste das Kontextmenü.
Wählen Sie im Kontextmenü den Eintrag Eigenschaften.
Wählen Sie im Menüpunkt Weitere Eigenschaften ändern den Unterpunkt Globales Element.
Wählen Sie Hinzufügen, um eine weitere Eigenschaft hinzu zu fügen.
Erstellen Sie drei Eigenschaften für:
die ID-Eigenschaft
die Eigenschaft für den kombinierten Namen
die ID-Deaktivierungs-Eigenschaft
Sie müssen für jede Eigenschaft eine ID, einen Anzeigenamen und einen Datentyp angeben.
Die ID-Deaktivierungseigenschaft muss vom Datentyp Wahrheitswert sein,
die beiden anderen Eigenschaften vom Typ Zeichenkette.
Achten Sie insbesondere beim Erstellen der Eigenschaft für den kombinierten
Namen auf eine schlüssige Bezeichnung der Eigenschaft-ID, da diese für die
Ausgabe in Berichten benötigt wird.
Wir empfehlen weiterhin die ID für die ID-Eigenschaft "id" zu nennen.
Bestätigen Sie Ihre Eingaben mit OK
Die ID-Deaktivierungs-Eigenschaft hat zunächst immer den Standardwert "falsch". Um ein globales Element von der ID-Vergabe auszuschließen, muss dieser Wert auf "wahr" gesetzt werden. Gehen Sie nun jedes auszuschließende Element im Repository durch, und setzen Sie den Wert auf "wahr". Gehen Sie dabei wie folgt vor:
Wählen Sie, zum Beispiel in der Repository-Sicht, ein globales Element mit der rechten Maustaste an.
Wählen Sie im Kontextmenü den Eintrag Eigenschaften.
Wählen Sie im Dialog die Option Weitere Eigenschaften und setzen Sie nun im Kästchen neben Ihrem Wahrheitswert ein Häkchen.
Bestätigen Sie Ihre Eingabe mit OK.
In der Sicht Repository können Sie die Wahrheitswerte mehrerer globaler Elemente auf einmal ändern. Gehen Sie wie folgt vor:
Markieren Sie alle globalen Elemente, bei denen Sie die ID-Deaktivierungs-Eigenschaft setzen oder löschen möchten. Deaktivieren Sie gegebenenfalls die Baumdarstellung, um alle existierenden globalen Elemente zu sehen. Nutzen Sie Filter, um sich globale Elemente eines bestimmten Typs anzeigen zu lassen. Mit Hilfe der Umschalt- und der Strg-Taste ist es möglich, mehr als ein Element auszuwählen.
Aktivieren Sie nun das Menü der Sicht und wählen Sie dort den
Eintrag Werkzeuge > Wert setzen....
Nun öffnet sich ein Dialog, in dem Sie folgende Informationen finden und selbst eingeben können:
Geben Sie hier die ID-Deaktivierungs-Eigenschaft und den gewünschten
Zielwert ("gelöscht" für "mit ID" bzw. "gesetzt" für "ohne ID") an.
Bestätigen Sie Ihre Eingabe mit OK.
Die Werte werden aktualisiert. Sie werden nach dem Vorgang über
alle Änderungen informiert. Dies beinhaltet eine Auflistung aller
modifizierten globalen Elemente und gegebenenfalls eine Benachrichtigung
darüber, ob Elemente nicht geändert werden konnten
(z. B. aufgrund von Sperren anderer Benutzer).
In der Sicht Repository können Sie nun die IDs den globalen Elementen zuordnen. Gehen Sie wie folgt vor:
Markieren Sie alle globalen Elemente, die bei der ID-Vergabe berücksichtigt werden sollen.
Aktivieren Sie nun das Menü der Sicht und wählen Sie dort den
Eintrag Werkzeuge > Aktualisiere Element-IDs....
Nun öffnet sich ein Dialog, in dem Sie folgende Informationen finden und selbst eingeben können:
Die Anzahl der Elemente, die bei der ID-Vergabe berücksichtigt werden
Der Name der Eigenschaft, die mit der ID gefüllt werden soll
Der Name der Eigenschaft, die mit der ID-Name-Kombination gefüllt werden soll
Der Name der Eigenschaft, die die ID-Vergabe deaktiviert
Geben Sie hier die für diesen Zweck erstellten Eigenschaften an.
Bestätigen Sie Ihre Eingabe mit OK.
Die IDs werden generiert. Sie werden nach der ID-Vergabe über
alle Änderungen informiert. Dies beinhaltet eine Auflistung aller
modifizierten globalen Elemente und gegebenenfalls eine Benachrichtigung
darüber, ob gegenwärtig IDs doppelt vergeben sind oder nicht vergeben
werden konnten (z. B. durch manuelle Änderung, nebenläufige Änderung
oder Sperren anderer Benutzer).
Machen Sie Ihre Änderungen für alle Nutzer verfügbar indem Sie sie auf den Server laden.
Die ID-Eigenschaften können als alternative Beschriftung in einem Plan angezeigt werden. Gehen Sie dazu folgendermaßen vor:
Wählen Sie den gewünschten Plan im Projektnavigator und aktivieren Sie mit der rechten Maustaste das Kontextmenü.
Wählen Sie hier den Eintrag Mit Eigenschaft "[Kombiniertes Namensfeld]" öffnen.
Die globalen Elemente werden mit den Werten aus dem kombinierten Namensfeld im Planeditor angezeigt.
Sie können die Werte der gesetzten Eigenschaften außerdem in der
Detailsicht und in den Eigenschaften-Dialogen der globalen Elemente einsehen.
Sie können die ID-Eigenschaften als alternative Beschriftung in Plänen oder innerhalb einer Auflistung Ihrer globalen Elemente in Ihre Berichte aufnehmen.
Um Pläne als Grafik in Berichte aufzunehmen wird folgender Code in den
Bericht aufgenommen (Beispiel aus dem ARCWAY Standard-Komplettreport):
#####################################################################
##
## MACRO: showPlan
## Creates the report output for one plan. For each plan the name, ## the ## description, an image of the plan and all contained unique ## elements will ## be added to the report.
##
## @para [in] plan reference to a plan
##
#####################################################################
#macro( showPlan $plan )
[..]
## Add an image of the plan and a caption
<para role="Image">
$plan.getImageFile()
</para>
[..]
#end
Ändern Sie die Zeile
$plan.getImageFile()
folgendermaßen, um Ihre Pläne mit alternativer Beschriftung in einen Bericht aufzunehmen:
$plan.getImageFileWithReplacedPlanElementName("custom.idname")
Dabei entspricht custom.idname in diesem Fall der ID, die Sie für die
weitere Eigenschaft für das kombinierte Namensfeld gewählt haben (vgl. Erstellen von weiteren Eigenschaften).
Um die ID-Eigenschaften innerhalb einer Auflistung Ihrer globalen Elemente in den Bericht aufzunehmen, geben Sie die weiteren Eigenschaften globaler Elemente mit im Bericht aus.
Benutzen Sie zum Erstellen von Berichten auch die Hilfeseiten zu diesem Thema und den ARCWAY Standard-Komplettreport als Beispiel.