UserClient - Grundlagen AUVESY GmbH Fichtenstraße 38B D-76829, Landau Deutschland
Inhalt UserClient - Grundlagen 3 1. Check-Out 5 2. Projekt im Editor bearbeiten 11 Projekte bearbeiten 11 3. Neue Version erstellen und Check-In durchführen 13 4. Versionen vergleichen 17 5. Ältere Versionen auschecken 20 6. Projekte per Befehlszeile öffnen 22 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: 3
4. Versionen vergleichen 5. Ältere Version auschecken 6. Projekte per Befehlszeile öffnen Letzte Aktualisierung: 19. August 2016 4
1. Check-Out Die Funktion Check-Out kopiert die aktuelle Version einer Komponente (Verzeichnis) und ihren Inhalt (z.b. ein Projekt) aus dem Serverarchiv in das Clientarchiv auf dem lokalen PC. Es werden immer vollständige Komponenten ausgecheckt; Teile einer Komponente können nicht ausgecheckt werden. Bei einem Check-Out-Vorgang können mehrere Komponenten ausgecheckt werden. Komponenten können nur ausgecheckt werden, wenn Verbindung zum Server besteht Beachten Sie, dass das versiondog-system, einschließlich der Check-Out-Funktion auf Komponenten basiert. Beachten Sie VOR DEM CHECK-OUT die verschiedenen Ansichtsoptionen im Projektbaum 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: 5
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. 6
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-Fenster: 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- 7
Tutorial "Mit Lieferanten arbeiten". "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 1. Gehen Sie zu C:\vdClientArchive>\VD$A\Configuration 2. Öffnen Sie die Datei client.ini 3. Fügen Sie den Abschnitt mit Schlüssel und Wert hinzu: [CheckInCheckOut] 5626=n 8
Dabei gilt: 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 1. UserClient starten 2. Tab Extras selektieren 3. Bereich Einstellungen > Schaltfläche Client-Einstellungen betätigen 4. Fenster Client-Einstellungen wird angezeigt 5. 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 Optionen ausgegraut sind und vom Benutzer nicht geändert werden kann, falls eine Festlegung über die Datei "Client.ini" erfolgt ist (siehe Punkt a.) FAQ: Wie kann man beim Check-Out die Optionen In Bearbeitung bzw. Check-In nur möglich für vorauswählen? 1. Gehen Sie zu C:\vdClientArchive>\VD$A\Configuration 2. Öffnen Sie die Datei client.ini 3. Fügen Sie den Abschnitt mit Schlüssel und Wert hinzu: 9
[CheckInCheckOut] 5625=n 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 10
2. Projekt im Editor bearbeiten Gehen Sie folgendermaßen vor, um in versiondog den Editor für ein Projekt zu öffnen: Wählen Sie im Projektbaum eine Datei aus und klicken Sie in die Registerkarte "Start" auf "In Editor öffnen" (siehe unten). Sie können den Editor auch über das Kontextmenü oder durch Drücken der Taste F4 aufrufen. Projekte bearbeiten 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. 11
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: Speichern Sie das Projekt / 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. 12
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. 13
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 14
Unterschiede gefunden wurden. In den meisten Fällen bedeutet dies, dass es nicht nötig ist, 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- 15
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? Kontaktieren Sie Ihren Systemadministrator, wenn dieser Fehler auftritt, um zu überprüfen, ob Sie Schreibzugriff auf den Ordner "vdserverarchive" beziehungsweise auf die Remotefreigabe haben. 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". 16
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). Die Schaltfläche Check-Out öffnet ein Fenster, in dem Sie auswählen können, welche Versionen in das Clientarchiv kopiert werden sollen. Die neueste Version wird in der Arbeitsverzeichnis der Komponente kopiert. Wenn Sie mehrere Versionen auswählen, werden diese in das ARCHIVE-Verzeichnis der Komponente kopiert: 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. 17
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: 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). 18
4. Klicken Sie auf "Mit selektierter Version vergleichen". 5. 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: AdminClient -> INI Dateien -> 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) Siehe auch: Komponententypen einer bestehenden Komponente ändern 19
5. Ältere Versionen auschecken Ältere Versionen einer Komponente können über die Schaltfläche Version in ein Verzeichnis kopieren ausgecheckt werden. Wenn Sie auf die Schaltfläche klicken, werden die ausgewählten Versionen in das Arbeitsverzeichnis oder ein Verzeichnis, dass Sie angeben, kopiert. So checken Sie eine frühere Version aus 1. Öffnen Sie die Registerkarte "Start". 2. Wählen Sie im Projektbaum eine Komponente aus. 20
3. Wählen Sie in der Änderungshistorie die Version aus, die Sie kopieren möchten. Dabei spielt es keine Rolle, ob die Version, die Sie kopieren möchten, grau dargestellt ist (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 die Schaltfläche "Version in ein Verzeichnis kopieren". 5. Daraufhin wird das Dialogfeld "Version in ein Verzeichnis kopieren" angezeigt, in dem das Arbeitsverzeichnis der Komponente als Zielverzeichnis vorausgewählt ist. A. Falls Sie das Arbeitsverzeichnis als Zielverzeichnis auswählen und dieses leer ist, wird die Version direkt in das Verzeichnis kopiert. Falls das Zielverzeichnis nicht leer ist, und Sie die Version dennoch in das Arbeitsverzeichnis kopieren wollen, klicken Sie auf "Inhalt löschen, dann kopieren". B. Falls Sie ein anderes Verzeichnis auswählen wollen, klicken Sie auf die Schaltfläche "Durchsuchen ". Sie können nur leere Verzeichnisse als Ziel auswählen. 6. Klicken Sie "Weiter", um mit dem Prozess fortzufahren. 21
6. Projekte per Befehlszeile öffnen Sie können Projekte per Befehlszeile öffnen, ohne sich im UserClient anzumelden. Dazu müssen Sie folgende Daten angeben: Den relativen Pfad der Komponente: C:\Programme\VDogClient.exe /at:c /rd:f\vdclientarchive" /CPATH:\Plant 1\Hall 1\Area 1\ 77" oder die ID der Komponente: C:\Programme\VDogClient.exe /at:c /rd:f\vdclientarchive /CID: F48ADE92F701419396364D9BA3ABBC15 und ihre Anmeldedaten für versiondog: /account:{benutzer} /domain:{domian} /password: {Passwort} Zum Beispiel: C:\Programme\VDogClient.exe /at:c /rd:f\vdclientarchive" /CPATH:\Plant 1\Hall 1\Area 1\ 77" /account:versiondog /password:change-it Auf diese Weise wird das Projekt im UserClient geöffnet. Klicken Sie auf "In Editor öffnen", um das Projekt zu bearbeiten. FAQ: In unserem Unternehmen sind die Projekte aus dem "vdserverarchive" auf einer Webplattform aufgelistet. Ist es möglich diese Projekte direkt auf dieser Plattform zu bearbeiten? Die Projekte können per Befehlszeile und über den UserClient bearbeitet werden. Beachten Sie die Informationen in diesem Tutorial für Informationen zum vorgehen. Dieses Vorgehen ist nur möglich, wenn ihre webbasierte Plattform es ermöglicht Programme auf ihrem PC zu starten. Beachten Sie die Dokumentation des Herstellers. 22