UserClient - Grundlagen AUVESY GmbH & Co KG Fichtenstraße 38B D-76829, Landau Deutschland
Inhalt UserClient - Grundlagen 3 1. Check-Out 4 2. Projekt im Editor bearbeiten 10 3. Neue Version erstellen und Check-In durchführen 12 4. Versionen vergleichen 16 5. Frühere Version wiederherstellen 19 2
UserClient - Grundlagen Das UserClient-Fenster ist in drei wesentliche Bereiche aufgeteilt: Mit dem versiondog UserClient können Sie mittels effektivem Datenmanagement in DREI EINFACHEN SCHRITTEN eine Änderung an einem Projekt vornehmen. Mehr dazu erfahren Sie in den folgenden Abschnitten: 1. Check-Out die neueste Version eines Projekts vom Server auf Ihren lokalen PC kopieren 2. Projekt mit Editor bearbeiten auf übliche Weise Änderungen vornehmen 3. Neue Version erstellen und Check-In Änderungen dokumentieren, eine Version erstellen und auf den Server kopieren Weitere wichtige Funktionen sind das Vergleichen von Versionen und das Wiederherstellen einer früheren Version. Mehr dazu erfahren Sie in den folgenden Abschnitten: 4. Versionen vergleichen 5. Frühere Version wiederherstellen Letzte Aktualisierung: 19. August 2016 3
1. Check-Out Es ist wichtig zu wissen, dass das versiondog-system, einschließlich der Check-Out-Funktion, komponentenbasiert ist. Was ist eine "Komponente"? Eine Komponente ist ein Verzeichnis mit versiondog-eigenschaften. Für eine Komponente wird im UserClient-Projektbaum das versiondog-komponententypsymbol (statt des normalen Verzeichnissymbols) angezeigt. Eine Komponente enthält üblicherweise ein Projekt es ist unbedingt empfehlenswert, Ihre Daten auf diese Weise zu organisieren. Weitere Informationen zu Komponenten finden Sie im versiondog INFO-Tutorial "Komponenten und Komponententypen". Was ist ein "Check-Out"? Wenn Sie einen Check-Out durchführen, werden die aktuelle Version einer Komponente (also ein Verzeichnis) und der dazugehörige Inhalt (z.b. ein Projekt) aus dem Serverarchiv in das Clientarchiv auf Ihrem lokalen PC kopiert. Der Check-Out-Vorgang wird komponentenweise durchgeführt Sie können einen Check-Out mehrerer Komponenten durchführen, doch Sie können keinen Check-Out eines Teils einer Komponente durchführen. Sowohl Sie ALS AUCH andere Benutzer, die mit dem Server verbunden sind, können einen Check-Out von Komponenten durchführen. 4
Beachten Sie VOR DEM CHECK-OUT die verschiedenen Ansichtsoptionen im Projektbaum (siehe nachfolgenden Screenshot): EINE SEHR NÜTZLICHE TASTENKOMBINATION, mit der Sie Ihren normalen Dateimanager (z.b. Windows Explorer) direkt aufrufen und den Inhalt des lokalen Arbeitsverzeichnisses einer Komponente anzeigen können: a. Wählen Sie die Komponente im versiondog-projektbaum aus. b. Drücken Sie die Tastenkombination Strg+E (diese Tastenkombination ist ähnlich, jedoch NICHT IDENTISCH mit der üblichen Windows-Tastenkombination WIN-Taste+E). Neben der oben aufgeführten Tastenkombination können Sie das Arbeitsverzeichnis im Dateimanager über die Ribbonleiste (Registerkarte "Start") oder über das Kontextmenü (Option "Bearbeiten") aufrufen. 5
So führen Sie einen Check-Out durch: 1. Wählen Sie im Projektbaum die Komponente, die Sie auschecken möchten. 2. Wählen Sie in der Registerkarte "Start" > Ribbon-Item "Check-Out" (siehe unten): 3. Daraufhin wird das Dialogfeld "Check-Out" mit der vorausgewählten Komponente angezeigt. 4. Klicken Sie auf "Check-Out". Check-Out-Optionen Bei der täglichen Arbeit der meisten Benutzer sind drei Optionen besonders wichtig: "Lieferanten Check-Out" Wenn Sie dieses Kontrollkästchen aktivieren, wird die Option erweitert, so dass Sie einen beliebigen Pfad für die ausgecheckten Daten angeben können. Hierbei kann es sich um ein beliebiges Verzeichnis auf einem internen oder externen Laufwerk, z.b. auf einem USB-Stick, handeln. Dies ist besonders dann nützlich, wenn externes Personal (Lieferanten) am Projekt arbeitet. Für diesen Fall finden Sie weitere wichtige Informationen im versiondog INFO-Tutorial "Mit Lieferanten arbeiten". 6
"In Bearbeitung" Wenn Sie dieses Kontrollkästchen aktivieren, markieren Sie eine Komponente, so dass alle Benutzer das Bearbeitungssymbol in der Spalte "Sperrstatus" im oberen Bereich der Änderungshistorie und der Komponentenübersicht sehen. Diese Option dient lediglich der Information anderer Benutzer. Andere Benutzer werden NICHT daran gehindert, die Komponente auszuchecken und sie werden NICHT daran gehindert, eine neue Version einzuchecken. "Für andere Benutzer sperren" wird als weitere Option angezeigt, wenn "In Bearbeitung" aktiviert ist. Wenn Sie dieses Kontrollkästchen aktivieren, markieren Sie eine Komponente, so dass alle Benutzer das Schlosssymbol in der Spalte "Sperrstatus" im oberen Bereich der Änderungshistorie und der Komponentenübersicht sehen. Diese Option hindert andere Benutzer IMMER NOCH NICHT daran, die Komponente auszuchecken, doch SIE VERHINDERT, dass andere Benutzer eine neue Version einchecken können. HINWEIS: Sie können den UserClient so einstellen, dass beim Check-Out immer automatisch der Sperrstatus "In Bearbeitung" oder "Für andere Benutzer sperren" ausgewählt wird. Hierfür wählen Sie in der Registerkarte "Extras" > Ribbon-Item "Client Einstellungen". FAQ: Wie kann man beim Check-Out die Optionen In Bearbeitung bzw. Check-In nur möglich für: voreinstellen, so dass Benutzer nur mit dieser Einstellung auschecken dürfen? Diese Optionen können folgendermaßen voreingestellt werden: a. Anpassung der entsprechenden ini-datei Fügen Sie die folgende Sektion in die unten genannte Datei ein Pfad: Datei: Abschnitt: <C:\vdClientArchive>\VD$A\Configuration client.ini [CheckInCheckOut] 5626=n Dabei gilt: 7
n = 0 - kein Zwang, die Option kann vom Benutzer geändert werden (Default) n = 1 - Benutzer kann nur mit der Option In Bearbeitung auschecken n = 2 - Benutzer kann nur mit der Option Check-In nur möglich für: auschecken b. Über die grafische Benutzeroberfläche UserClient starten Tab Extras selektieren Bereich Einstellungen > Schaltfläche Client Einstellungen betätigen Fenster Client Einstellungen wird angezeigt Tab Check-In / Check-Out selektieren Im Bereich Check-Out Optionen kann eine der drei folgenden Optionen ausgewählt werden: Check-Out ohne Vorbelegung (Default) Check-Out immer im Sperrstatus in Bearbeitung Check-Out immer im Sperrstatus Für andere Benutzer sperren Beachten Sie, dass diese Option wird in Grau gesetzt und kann von Benutzer nicht geändert werden. FAQ: Wie kann man beim Check-Out die Optionen In Bearbeitung bzw. Check-In nur möglich für vorauswählen? Fügen Sie den folgenden Eintrag in die unten genannte Datei ein Pfad: Datei: Abschnitt: <C:\vdClientArchive>\VD$A\Configuration client.ini [CheckInCheckOut] 5625=n 8
Dabei gilt: n = 0 - kein Vorbelegen (Default-Wert) n = 1 - dem Benutzer wird die Option In Bearbeitung vorbelegt n = 2 - dem Benutzer wird die Option Check-In nur möglich für: vorbelegt 9
2. Projekt im Editor bearbeiten SIE ÖFFNEN DEN ENTSPRECHENDEN EDITOR für ein Projekt direkt in versiondog wie folgt: Wählen Sie einfach im Projektbaum eine Datei aus, gehen Sie in die Registerkarte "Start" und klicken Sie auf "Editor öffnen" (siehe unten). Den Editor können Sie auch über das Kontextmenü oder durch Drücken der Taste F4 aufrufen. BEARBEITEN SIE IHR PROJEKT wie üblich. versiondog beeinflusst diese Arbeit in keiner Weise. Beachten Sie die folgenden wichtigen Punkte: Das Arbeitsverzeichnis des Clientarchivs auf Ihrem lokalen PC ist der Speicherort des Projekts oder der Datei, das bzw. die Sie gerade bearbeiten. Mit der Tastenkombination Strg+E öffnen Sie Ihren Dateimanager (z.b. Windows Explorer) und darin das Arbeitsverzeichnis des Elements, das gerade im Projektbaum ausgewählt ist. Änderungen, die Sie vornehmen und speichern, werden lokal gespeichert (im Arbeitsverzeichnis). Ihre geänderten Dateien werden NICHT automatisch in das Serverarchiv kopiert. UM SICHERUNGSKOPIEN VON ZWISCHENSTÄNDEN IHRER ARBEIT IM SERVERARCHIV ZU SPEICHERN, bevor Sie einen Stand erreicht haben, von dem Sie eine Version erstellen möchten, gehen Sie wie folgt vor: 10
Speichern Sie das Projekt oder die Datei, schließen Sie es/sie und verwenden Sie dann die Schnellspeicherung (siehe versiondog INFO-Tutorial "Schnellspeicherung"). NACHDEM SIE IHRE ÄNDERUNGEN VORGENOMMEN und einen Stand erreicht haben, von dem Sie eine Version erstellen möchten (eine Version ist ein dokumentierter "Schnappschuss" Ihres Projekts, zu dem Sie jederzeit zurückkehren können), gehen Sie wie folgt vor: Speichern Sie das Projekt oder die Datei, schließen Sie den Editor und gehen Sie dann wie unter 3. Neue Version erstellen und Check-In beschrieben vor. Beachten Sie, dass es für Situationen, in denen Sie lediglich die nachfolgend aufgeführten DREI EINFACHEN SCHRITTE mit einem Minimum an Funktionalität ausführen möchten, den versiondog EasyClient gibt: 1) Check-Out, 2) Projekt mit Editor bearbeiten, 3) Neue Version erstellen und Check- In. 11
3. Neue Version erstellen und Check-In durchführen Was ist eine "Version"? Eine Version ist faktisch ein "Schnappschuss" der Inhalte einer Komponente (z.b. eines Projekts). Versionen werden auf Ihrem lokalen PC erstellt, bevor sie auf den Server kopiert werden (während des Check-In-Vorgangs). Versionen werden in versiondog automatisch dokumentiert mit Benutzername, Computer, Datum und Uhrzeit (WER hat die Änderungen vorgenommen, WO und WANN). Versionen benötigen weitere manuelle Dokumentation in Form von präzisen Anmerkungen (in den Textfeldern "Änderungsgrund" und "Kommentar"), die den Entwicklungsstand des Projekts zum Zeitpunkt der Erstellung der Version eindeutig darlegen (WAS wurde geändert und WARUM). Es ist empfehlenswert, dann eine Version zu erstellen, wenn ein definierbarer Stand in der Entwicklung eines Projekts (zu dem Sie möglicherweise zurückkehren möchten) erreicht ist. Wenn Sie Ihr Projekt ZWISCHEN DEN VERSIONEN als Sicherungskopie auf den Server kopieren möchten, verwenden Sie die Schnellspeicherung (siehe versiondog INFO-Tutorial "Schnellspeicherung"). Was ist ein "Check-In"? Beim Check-In-Vorgang wird eine Version auf den versiondog-server kopiert (Versionen werden auf Ihrem lokalen Rechner erstellt). Nachdem Sie den Check-In einer Version durchgeführt haben, verbleibt die Version auf dem Server. Besteht eine Verbindung zum Server, können sowohl Sie ALS AUCH andere Benutzer einen Check-Out zuvor eingecheckter Versionen durchführen. 12
So erstellen Sie eine neue Version und führen einen Check-In durch Wie genau Sie vorgehen, um eine neue Version zu erstellen und diese auf dem Server einzuchecken, ist davon abhängig, ob Sie zu dem Zeitpunkt, zu dem Sie eine neue Version erstellen, eine Verbindung zum Server haben oder nicht. In beiden Fällen beginnen Sie mit der Erstellung einer Version (dieser Vorgang erfolgt immer auf dem lokalen PC): Im Projektbaum wählen Sie dann die Komponente, von der Sie eine Version erstellen möchten (siehe Screenshot oben): SZENARIO A Sie haben eine Verbindung zum Server. 1. Gehen Sie in die Registerkarte "Start". 2. Klicken Sie auf das Ribbon-Item "Neue Version erstellen". Wenn Sie keine Änderungen vorgenommen haben, werden Sie in einer Meldung darüber informiert, dass beim Vergleich keine Unterschiede gefunden wurden. In den meisten Fällen bedeutet dies, dass es nicht nötig ist, 13
eine Version zu erstellen. Wenn es einen bestimmten Grund gibt, weshalb Sie dennoch eine Version erstellen möchten, besteht die Möglichkeit dazu in der Registerkarte "Extras". 3. Werden beim Vergleich lokale Änderungen gefunden, wird das Dialogfeld "Neue Version erstellen" geöffnet. Es zeigt die Änderungen an, die Sie ggf. prüfen und genehmigen können. 4. Geben Sie Anmerkungen ein (geben Sie zumindest unter "Globaler Kommentar" einen Eintrag im Textfeld "Änderungsgrund:") ein. 5. Klicken Sie auf "Version erstellen und Check-In" und die neue Version wird lokal erstellt. Direkt im Anschluss (und ohne, dass Sie weitere Maßnahmen ergreifen müssen) wird der Check-In-Vorgang durchgeführt. SZENARIO B Sie haben KEINE Verbindung zum Server. Führen Sie die Schritte 1 bis 4 wie in SZENARIO A (oben) beschrieben aus und gehen Sie dann wie folgt vor: 5. Klicken Sie auf "Version lokal erstellen" und die neue Version wird lokal erstellt, doch ein Check-In ist derzeit NICHT möglich, weil keine Verbindung zum Server besteht (HINWEIS: Sie können mehrere Versionen lokal erstellen, ohne diese einzuchecken.) 6. WENN SIE SPÄTER EINE VERBINDUNG ZUM SERVER HABEN: a. Wählen Sie im Projektbaum die Komponente mit der neu erstellten Version aus, die noch nicht eingecheckt ist. b. Gehen Sie in die Registerkarte "Start" > Ribbon-Item "Check-In" (siehe unten) c. Daraufhin wird das Dialogfeld "Check-In" mit der vorausgewählten Komponente ange- 14
zeigt. d. Klicken Sie auf "Check-In". FAQ: Beim Check-In kommt es zu einer Fehlermeldung nach dem Schema "[Name: GetDiskFreeSpaceEx] [Info: <Verzeichnis>] [HINWEIS:Zugriff verweigert]". Wie kann ich dieses Problem beheben? Stellen Sie sicher, dass ihr Konto Schreibzugriff auf das Serverarchiv und auf die Remotefreigabe hat. OPTIONAL: KOMPONENTE NACH DEM CHECK-IN LOKAL LÖSCHEN Wenn es nicht nötig ist, eine Kopie der Komponente auf Ihrem lokalen PC zu behalten, kann es sich bewähren, die Komponente nach dem Check-In lokal zu löschen. Dadurch wird es erforderlich, einen Check-Out der neuesten Version durchzuführen, wenn Sie wieder Änderungen am Projekt vornehmen möchten. Zum lokalen Löschen gehen Sie wie folgt vor: a. Klicken Sie mit der rechten Maustaste auf die Komponente. b. Wählen Sie im Kontextmenü "Bearbeiten" > "Löschen" (dadurch löschen Sie lokal und NICHT auf dem Server). c. Das Dialogfeld "Komponente löschen" wird angezeigt. d. Aktivieren Sie das Kontrollkästchen "Arbeitsverzeichnis der Komponente löschen". e. Klicken Sie auf "Löschen". HINWEIS: Sie können den UserClient so einstellen, dass nach dem Check-In die Komponenten immer automatisch gelöscht werden. Hierfür wählen Sie in der Registerkarte "Extras" > Ribbon-Item "Client Einstellungen". 15
4. Versionen vergleichen versiondog kann Ihnen Vergleiche erstellen, die nebeneinander dargestellt werden, so dass Sie die Unterschiede auf verständliche Weise überblicken können. Folgendes können Sie vergleichen: Jede beliebige Version mit dem Arbeitsverzeichnis Jede beliebige Version mit einer anderen Version Vor dem Vergleich müssen die Versionen lokal vorliegen oder der Anwender muss am Server angemeldet sein. In der Änderungshistorie grau dargestellte Versionen sind lokal NICHT vorhanden. Möchten Sie Versionen, offline vergleichen, müssen diese zunächst ausgecheckt werden. Siehe 1. Check-Out. Beachten Sie das Dropdown-Feld im Dialogfeld "Check-Out" (siehe unten): So vergleichen Sie eine Version mit dem Arbeitsverzeichnis Wählen Sie im Projektbaum eine Komponente aus und gehen Sie dann wie folgt vor: 1. Gehen Sie in die Registerkarte "Status". 2. Wählen Sie in der Änderungshistorie eine Version aus. 16
3. Klicken Sie auf das Ribbon-Item "Arbeitsverzeichnis mit Version vergleichen" (siehe unten): 4. Daraufhin wird das Fenster "vd - Vergleich" angezeigt, in dem die Unterschiede aufgeführt werden. So vergleichen Sie eine Version mit einer anderen Version Wählen Sie im Projektbaum eine Komponente aus und gehen Sie dann wie folgt vor: 17
1. Gehen Sie in die Registerkarte "Status". 2. Wählen und setzen Sie einen Vergleichspartner, der dann angeheftet dargestellt wird (Version 6 im Beispiel oben). 3. Wählen Sie die Version aus, die Sie mit dem gesetzten Vergleichspartner vergleichen möchten (Version 4 im Beispiel oben). 4. Klicken Sie auf den Abwärtspfeil des Ribbon-Item "Arbeitsverzeichnis mit Version vergleichen". 5. Klicken Sie auf "Mit selektierter Version vergleichen". 6. Daraufhin wird das Fenster "vd - Vergleich" angezeigt, in dem die Unterschiede aufgeführt werden. FAQ: Wie kann die maximal angezeigte Anzahl an Unterschieden geändert werden? 1. Navigieren Sie zu folgender INI-Datei auf dem versiondog-server: <Drive:>\vdServerArchive\VD$A\Configuration\Server.ini 2. Fügen Sie folgenden Abschnitt hinzu: [Compare] 7003=n (Dabei ist 'n' die maximale Anzahl an Unterschieden, die nach einem Vergleich dargestellt werden; min Wert: 64, max Wert: 16384) 18
5. Frühere Version wiederherstellen Sie können jede frühere Version einer Komponente über die Funktion "Version kopieren" wiederherstellen. HINWEIS: Während die Check-Out-Funktion die LETZTE Version aus dem Serverarchiv in das Arbeitsverzeichnis des Clientarchivs kopiert, kopiert die Funktion "Version kopieren" ALLE AUSGEWÄHLTEN Versionen in das Arbeitsverzeichnis (oder in ein anderes Verzeichnis, wenn Sie eines angeben). So stellen Sie eine frühere Version wieder her 1. Gehen Sie in die Registerkarte "Start". 2. Wählen Sie im Projektbaum eine Komponente aus. 3. Wählen Sie in der Änderungshistorie die Version aus, die Sie wiederherstellen möchten. Dabei spielt es keine Rolle, ob die Version, die Sie wiederherstellen möchten, grau dargestellt ist 19
(grau dargestellte Versionen sind lokal nicht vorhanden, doch während dieses Vorgangs wird die Version aus dem Serverarchiv kopiert, weshalb sie zu dem Zeitpunkt, zu dem Sie sie auswählen, nicht lokal vorhanden sein muss). 4. Klicken Sie auf das Ribbon-Item "Version kopieren". 5. Daraufhin wird das Dialogfeld "Version in Arbeitsverzeichnis kopieren" angezeigt, in dem das Arbeitsverzeichnis der Komponente als Zielverzeichnis vorausgewählt ist. Die aktuellen Inhalte des Zielverzeichnisses werden gelöscht. 6. Wenn Sie die frühere Version in ein anderes Verzeichnis kopieren möchten, können Sie das Verzeichnis über die Schaltfläche "Durchsuchen..." angeben. GEBEN SIE KEIN VERZEICHNIS AN, DAS WICHTIGE DATEN ENTHÄLT. GEBEN SIE NICHT DEN DESKTOP AN. GEBEN SIE KEINEN LAUFWERKSBUCHSTABEN AN. 7. Klicken Sie auf "Weiter". 8. Wenn Ihr Zielverzeichnis leer ist, wird die Version ohne weitere Eingaben von Ihnen in das Verzeichnis kopiert. WENN IHR ZIELVERZEICHNIS NICHT LEER IST, MÜSSEN SIE BESTÄTIGEN, DASS DESSEN INHALTE GELÖSCHT WERDEN, DAMIT DIE VERSION KOPIERT WERDEN KANN. Klicken Sie auf "Inhalt löschen", um den Löschvorgang und den Kopiervorgang auszuführen. 20