Check-In¶

Der AutoCheckIn ermöglicht es, Komponenten über die Kommandozeile einzuchecken und dabei, falls erforderlich, eine neue Version zu erstellen. Über Einstellungen in der Konfigurationsdatei können die Stammdaten sowie der Komponententyp geändert werden.

In der Kommandozeile muss folgender Befehl eingegeben werden:

C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:{vdClientArchive}" [/account:{User}] [/domain:{domain}] [/password:{password}] /CFile:d:{configuration file}

Die notwendigen Parameter und Werte für den Kommandozeilenaufruf entnehmen Sie der folgenden Tabelle.

Parameter	Beschreibung
/rd:{ClientArchive}	Voll qualifizierter Pfad zum Clientarchiv
/account:{Benutzer}	Name des Benutzers, der den Check-In vornimmt Nur erforderlich, falls der Benutzername nicht in der Konfigurationsdatei übergeben wird.
/domain:{Domäne}	Domäne des Benutzers Nur erforderlich, wenn der Benutzername über die Kommandozeile übergeben wird.
/password:{Passwort}	Passwort des Benutzers Nur erforderlich, wenn der Benutzername über die Kommandozeile übergeben wird.
/CFile:{Konfigurationsdatei}	Voll qualifizierter Pfad zur Konfigurationsdatei
/JobConfig	Gibt an, dass ein Job erstellt werden soll Nur erforderlich, wenn lediglich die Jobkonfiguration geändert und keine Komponente erzeugt, keine Versionierung und kein Check-In durchgeführt werden soll.

Konfigurationsdatei¶

Um eine Komponente über die Kommandozeile einzuchecken, zu versionieren oder einen Job zu erstellen, wird eine INI-Datei zur Konfiguration benötigt. Die notwendigen Sektionen, Schlüssel und Werte der Konfigurationsdatei entnehmen Sie der folgenden Tabelle.

Info

Besitzt ein Wert führende oder abschließende Leerzeichen, muss er in der Konfigurationsdatei in Anführungszeichen stehen. Ist für einen Schlüssel ein Standardwert angegeben, muss dieser Schlüssel nicht zwingend in der Konfigurationsdatei übergeben werden.

Sektion [User]¶

Schlüssel	Beschreibung	Werte	Default
Account	Name des Benutzers, der den Check-In vornimmt Nur erforderlich, wenn der Benutzername nicht in der Konfigurationsdatei übergeben wird.		Leerer String
Domäne	Domäne des Benutzers Nur erforderlich, wenn der Benutzername auch in der Konfigurationsdatei übergeben wird.		Leerer String
Password	Domäne des Benutzers Nur erforderlich, wenn der Benutzername auch in der Konfigurationsdatei übergeben wird.		Leerer String
PasswordMode	Gibt an, wie das Passwort zu behandeln ist. Nur erforderlich, falls der Benutzername auch in der Konfigurationsdatei übergeben wird.	0: Das Passwort wird als unverschlüsselt behandelt und direkt übertragen. 2: Der Schlüssel wird ignoriert und das Passwort muss über die Kommandozeile eingegeben werden.

Sektion [Component|¶

Schlüssel	Beschreibung
Dir	Relativer Pfad zur Komponente. Am Anfang steht ein Backslash, am Ende nicht.
ComponentTypeId	Gültige Komponententyp-ID, mit der die bestehende ersetzt wird

Sektion [CreateComponent]¶

Schlüssel	Beschreibung
ComponentTypeId	Existiert die Komponente noch nicht, kann sie neu angelegt werden. Voraussetzung hierfür ist, dass eine gültige Komponententyp-ID hinterlegt wurde, die dann als Vorlage herangezogen wird. Sind beide Schlüssel ComponentTypeId und ComponentId vorhanden, wird immer der Schlüssel ComponentId herangezogen (d.h. wenn Sie einen Wert für den Schlüssel ComponentId eingegeben haben, brauchen Sie keinen Wert für ComponentTypeId einzugeben).
ComponentId	Existiert die Komponente noch nicht, kann sie neu angelegt werden. Voraussetzung hierfür ist, dass eine gültige Komponenten-ID hinterlegt wurde, die dann als Vorlage herangezogen wird. Sind beide Schlüssel ComponentTypeId und ComponentId vorhanden, wird immer der Schlüssel ComponentId herangezogen (d.h. wenn Sie einen Wert für den Schlüssel ComponentId eingegeben haben, brauchen Sie keinen Wert für ComponentTypeId einzugeben).
WorkingDir	Angabe eines externen Arbeitsverzeichnisses
Source	Das Arbeitsverzeichnis kann direkt mit Dateien befüllt werden. Quelle ist entweder ein Verzeichnis oder eine ZIP-Datei. Befinden sich im Arbeitsverzeichnis bereits Daten (z.B. im Falle einer Wiederverwendung einer Komponente oder eines Imports einer Verzeichnisstruktur), wird die Komponente nicht angelegt und der gesamte AutoCheckIn Vorgang schlägt fehl.

Sektion [Version]¶

Schlüssel	Beschreibung	Werte	Default
Enabled	Gibt an, ob vor dem Check-In eine Version erstellt werden soll.	Y: Eine neue Version wird erstellt. N: Es wird keine neue Version erstellt.	N
HversionUserDefined	Versionsnummer der Version, die ggf. erstellt wird.		Leerer String
Kommentar	Kommentar zu dieser Version. Ein Zeilenumbruch wird mit `<br>` angezeigt.		Leerer String
ChangeReason	Änderungsgrund für diese Version. Ein Zeilenumbruch wird mit `<br>` angezeigt.		Leerer String
WithoutComparison	Gibt an, ob ein Vergleich durchgeführt werden soll. Wenn kein Vergleich durchgeführt wird (Y), wird eine neue Version erstellt, auch wenn keine Unterschiede zur vorherigen Version bestehen.	Y: Es wird kein Vergleich durchgeführt. N: Der Vergleich wird durchgeführt.	N
SilentMode	Gibt an, ob VDogAutoCheckIn.exe während des Vergleichs eine Nachricht öffnen darf.	Y: Nachrichten können geöffnet werden. N: Es werden keine Nachrichten geöffnet.	N
UserId	Benutzer-ID, unter der die Version erstellt werden soll. Format: {ID mit 32 Zeichen}.		Der eingeloggte Benutzer
ComputerName	Name des Rechners, auf dem die Version erstellt werden soll.		Der Name des Rechners, auf dem das VDogCheckIn läuft
TimeStamp	Zeitstempel, zu dem die Version erstellt wurde. Format: {YYYYMMDD HHMMSS}.		Der aktuelle Zeitstempel
TagName	Tag, welcher der erzeugten Version zugewiesen werden soll. Dieser Schlüssel ist optional.
CreateTagIfNotAlreadyExists	Gibt an, ob ein Tag erstellt wird, wenn kein Tag für die Version existiert.	Y: Der Tag wird erstellt, wenn er noch nicht existiert. N: Nur vorhandene Tags werden mit der erstellten Version verknüpft. Wenn der Tag nicht existiert, schlägt die Anwendung fehl. Die erzeugte Version bleibt ohne Tag.
TagComment	Falls ein neuer Tag erzeugt wird, kann hier ein Kommentar zum Tag hinzugefügt werden.

Sektion [CheckIn]¶

Schlüssel	Beschreibung	Werte	Default
ReleaseAfterCheckIn	Gibt an, ob die Version der Komponente nach dem Check-In freigegeben werden soll.	Y: Die Version ist freigegeben. N: Die Version ist nicht freigegeben.	Y
SilentMode	Gibt an, ob VDogAutoCheckIn.exe beim Check-In eine Nachricht öffnen darf.	Y: Nachrichten können geöffnet werden. N: Es werden keine Nachrichten geöffnet.	N
IgnoreProjectDataIsNot Versioned	Gibt an, ob VDogAutoCheckIn.exe nicht versionierte Projektänderungen im Editor während des Check-Ins ignorieren soll.	Y: Wenn sich im Arbeitsverzeichnis nicht versionierte Änderungen am Projekt befinden, erscheint eine Warnmeldung. Bereits gespeicherte Versionen werden eingecheckt. N: Wenn sich nicht versionierte Projektänderungen im Arbeitsverzeichnis befinden, wird eine Fehlermeldung angezeigt. Der Check-In wird abgebrochen. Bereits gespeicherte Versionen werden nicht eingecheckt.	N

Sektion[MasterData]¶

Schlüssel	Beschreibung	Werte	Default
Data{1..10}	Gibt die Stammdaten an, die geändert werden sollen. Hierbei gilt: Wenn Sie einen Wert eingeben, wird dieser Wert in das Stammdatenfeld eingetragen. Um das Stammdatenfeld zu leeren, geben Sie keinen Wert ein.		Standardmäßig wird nichts geändert.

Sektion [Result]¶

Schlüssel	Beschreibung
ErrorText{0..n}	Fehlermeldung(en) im Fehlerfall
ErrorCode{0..n}	Fehlercode(s) im Fehlerfall Format: {Anzeigetyp}{Leerzeichen}{Errorcode in hexadezimaler Schreibweise} Anzeigetyp 0: Errorcode wird als Dezimalzahl ohne Vorzeichen dargestellt. Anzeigetyp 1: Errrorcode wird als Dezimalzahl mit Vorzeichen dargestellt. Anzeigetyp 2: Errorcode wird als Hexadezimalzahl dargestellt.
HVersion	Versionsnummer der gegebenenfalls erzeugten Version.
JobId	ID des erzeugten Jobs. Nur erforderlich, wenn die Schlüssel in der Sektion [JobConfig] verwendet werden.

Beispiele¶

Übergabe des Benutzers und Passworts im Aufruf¶

Kommandozeilenaufruf:

C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /account:{User} /domain:Testdomain /password:{Password} /CFile:d:\AutoCheckIn.ini

Konfigurationsdatei AutoCheckIn.ini:

[Component]
Dir=\Factory 1\Hall 1\Area 1\110 S7

Übergabe des Benutzers und des Passworts in der Konfigurationsdatei¶

Kommandozeilenaufruf:

C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c"/rd:D:\vdClientArchive" /CFile:d:\AutoCheckIn.ini

Konfigurationsdatei AutoCheckIn.ini:

[User]
Account={User}
Domain={Testdomain}
Password={Password}
[Component]
Dir=\Werk 1\Halle 1\Bereich 1\110 S7

Übergabe des Passworts im Aufruf und des Benutzers in der Konfigurationsdatei¶

Kommandozeilenaufruf:

C:\Programs\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /password:{password} /CFile:d:\AutoCheckIn.ini

Konfigurationsdatei AutoCheckIn.ini:

[User]
Account=User
Domain=Testdomain
PasswordMode=2
[Component]
Dir=\Werk 1\Halle 1\Area 1\110 S7

Anwendungsbeispiel: Erstellen einer neuen Komponente¶

Batchdatei:

@echo off
set VDTOOL=C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.exe
set CLIENTARCHIVE=D:\vdClientArchive
set PASSWD=********
set USERNAME=Administrator
set CFGFILE=CheckInTest.ini
SET mypath=%~dp0
set CFGFILE=%mypath%%CFGFILE%
echo [ * ] Start Check-In
"%VDTOOL%" "/AT:C" "/RD:%CLIENTARCHIVE%" "/CFile:%CFGFILE%" "/Password:%PASSWD%" "/Account:%USERNAME%"
echo [ * ] Check-In finished (%ERRORLEVEL%)
pause

Konfigurationsdatei CheckInTest.ini:

[Component]
Dir=\Test\NewComponent
[CreateComponent]
// Binary
ComponentTypeId=D565D656350A428E8B286F834C4F74BA

Anwendungsbeispiel: Anpassen der Stammdaten für mehrere Komponenten gleichzeitig¶

Datei CheckIn.bat

@echo off
set VDTOOL=C:\Program Files (x86)\vdogClient\VDogAutoCheckIn.exe
set CLIENTARCHIVE=D:\vdClientArchive
set PASSWD=********
set USERNAME=Administrator
set CFGFILE=CheckInTest.ini
SET mypath=%~dp0
set CFGFILE=%mypath%%CFGFILE%
echo [ * ] Start Check-In
type %CFGFILE% > %CFGFILE%.cfg
echo [Component] >> %CFGFILE%.cfg
echo dir=%*>> %CFGFILE%.cfg
"%VDTOOL%" "/AT:C" "/RD:%CLIENTARCHIVE%" "/CFile:%CFGFILE%.cfg" "/Password:%PASSWD%" "/Account:%USERNAME%"
echo [ * ] Check-In has finished (%ERRORLEVEL%)

Datei CheckIn.ini

[Version]
Enabled=Y
WithoutComparison=Y
[MasterData]
Data1="Offline"

Datei Loop.bat

for /F "tokens=*" %%A in (myfile.txt) do checkin.bat %%A

Datei myfile.txt

\Plant 1\Hall 1\Area 1\110 S7
\Plant 1\Hall 1\Area 2\Documentation\Book list
\Plant 1\Hall 1\Area 2\Documentation\CADD

Check-In¶

Konfigurationsdatei¶

Sektion [User]¶

Sektion [Component|¶

Sektion [CreateComponent]¶

Sektion [Version]¶

Sektion [CheckIn]¶

Sektion[MasterData]¶

Sektion [Result]¶

Beispiele¶

Übergabe des Benutzers und Passworts im Aufruf¶

Übergabe des Benutzers und des Passworts in der Konfigurationsdatei¶

Übergabe des Passworts im Aufruf und des Benutzers in der Konfigurationsdatei¶

Anwendungsbeispiel: Erstellen einer neuen Komponente¶

Anwendungsbeispiel: Anpassen der Stammdaten für mehrere Komponenten gleichzeitig¶

Verwandte Themen¶