Check-In

Der AutoCheckIn ermöglicht es, Komponenten über die Kommandozeile einzuchecken und dabei gegebenenfalls 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:{Benutzer} [/domain:{Domäne}] [/password:{Passwort}] /CFile:d:{Konfigurationsdatei}

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

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, falls der Benutzername über die Kommandozeile übergeben wird.
/password:{Passwort}	Passwort des Benutzers Nur erforderlich, falls der Benutzername über die Kommandozeile übergeben wird.
/CFile:{Konfigurationsdatei}	Voll qualifizierter Pfad zur Konfigurationsdatei
/JobConfig	Zeigt, dass ein Job erstellt werden soll Nur erforderlich, falls 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 Abschnitte, Schlüssel und Werte der Konfigurationsdatei entnehmen Sie der folgenden Tabelle.

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 in der Konfigurationsdatei übergeben werden.

Sektion	Schlüssel	Beschreibung
[User]	Account	Name des Benutzers, der den Check-In vornimmt Nur erforderlich, falls der Benutzername nicht über die Kommandozeile übergeben wird. Der Standardwert ist eine leere Zeichenkette.
	Domain	Domäne des Benutzers Nur erforderlich, falls der Benutzername auch in der Konfigurationsdatei übergeben wird. Der Standardwert ist eine leere Zeichenkette.
	Password	Passwort des Benutzers Nur erforderlich, falls der Benutzername auch in der Konfigurationsdatei übergeben wird. Der Standardwert ist eine leere Zeichenkette.
	PasswordMode	Angabe, wie das Passwort zu behandeln ist. Mögliche Werte sind: 0: Das Passwort wird als unverschlüsselt behandelt und direkt übergeben. 2: Der Schlüssel wird ignoriert und das Passwort muss über die Kommandozeile eingegeben werden. Nur erforderlich, falls der Benutzername auch in der Konfigurationsdatei übergeben wird.
[Component]	Dir	Relativer Pfad zur Komponente Am Anfang steht ein umgekehrter Schrägstrich, am Ende nicht.
[Component]	ComponentTypeId	Gültige Komponententyp-ID, mit der die bestehende Komponententyp-ID ersetzt wird
[CreateComponent]	ComponentTypeId	Existiert die Komponente noch nicht, kann sie neu angelegt werden. Voraussetzung hierfür ist, dass eine gültige Komponententyp-ID hinterlegt wurde, welche 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 den Schlüssel 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, welche 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 den Schlüssel 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), so wird die Komponente nicht angelegt und der gesamte AutoCheckIn-Vorgang schlägt fehl.
[Version]	Enabled	Angabe, ob vor dem Check-In eine Version erstellt werden soll. Mögliche Werte: Y: Es wird eine neue Version erstellt. N: Es wird keine neue Version erstellt. Der Standardwert ist N.
	HversionUserDefined	Versionsnummer der gegebenenfalls erzeugten Version Der Standardwert ist eine leere Zeichenkette.
	Comment	Kommentar zur Version Ein Zeilenumbruch wird mit <br> dargestellt. Der Standardwert ist eine leere Zeichenkette.
	ChangeReason	Änderungsgrund für die Version Ein Zeilenumbruch wird mit <br> dargestellt. Der Standardwert ist eine leere Zeichenkette.
	WithoutComparison	Angabe, ob ein Vergleich durchgeführt werden soll. Mögliche Werte: Y: Es wird kein Vergleich durchgeführt. N: Der Vergleich wird durchgeführt. Der Standardwert ist N. Wird kein Vergleich durchgeführt (Y), wird auch dann eine neue Version erstellt, wenn es keine Unterschiede zur vorherigen Version gibt.
	SilentMode	Angabe, ob VDogAutoCheckIn.exe beim Vergleich eine Meldung öffnen darf. Mögliche Werte: Y: Es können Meldungen geöffnet werden. N: Es werden keine Meldungen geöffnet. Der Standardwert ist N.
	UserId	Benutzer-ID, unter der die Version erzeugt werden soll Format: {ID mit 32 Zeichen} Der Standardwert ist der angemeldete Benutzer.
	ComputerName	Name des Rechners, auf dem die Version erzeugt werden soll Der Standardwert ist der Name des Rechners, auf dem der VDogCheckIn läuft.
	TimeStamp	Zeitstempel, an dem die Version erzeugt wurde Format: {YYYYMMDD HHMMSS} Der Standardwert ist der aktuelle Zeitstempel.
	TagName	Tag, welcher der erzeugten Version zugewiesen werden soll. Dieser Schlüssel ist optional.
	CreateTagIfNotAlreadyExists	Angabe, ob ein Tag erzeugt wird, falls kein Tag für die Version existiert Y: Der Tag wird erzeugt, falls er noch nicht existiert. N: Nur existierende Tags werden mit der erzeugten Version verknüpft. Existiert der Tag nicht, schlägt die Applikation fehl. Die erzeugte Version bleibt ohne Tag.
	TagComment	Falls ein neuer Tag erzeugt wird, kann hier ein Kommentar zum Tag hinzugefügt werden.
[CheckIn]	ReleaseAfterCheckIn	Angabe, ob die Version der Komponente nach dem Check-In freigegeben werden soll. Mögliche Werte: Y: Die Version wird freigegeben. N: Die Version wird nicht freigegeben. Der Standardwert ist Y.
	SilentMode	Angabe, ob VDogAutoCheckIn.exe beim Check-In eine Meldung öffnen darf. Mögliche Werte: Y: Es können Meldungen geöffnet werden. N: Es werden keine Meldungen geöffnet. Der Standardwert ist N.
	IgnoreProjectDataIsNot Versioned	Angabe, ob VDogAutoCheckIn.exe beim Check-In nicht versionierte Projektänderungen im Editor ignorieren soll. Y: Gibt es nicht versionierte Projektänderungen im Arbeitsverzeichnis, erscheint eine Warnung. Bereits gespeicherte Versionen werden eingecheckt. N: Gibt es nicht versionierte Projektänderungen im Arbeitsverzeichnis, erscheint eine Fehlermeldung. Der Check-In bricht ab. Bereits gespeicherte Versionen werden nicht eingecheckt. Der Standardwert ist N.
[MasterData]	Data{1..10}	Angabe der Stammdaten, die verä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 verändert.
[Result]	ErrorText{0..n}	Fehlermeldung(en) im Fehlerfall
	ErrorCode{0..n}	Fehlercode(s) im Fehlerfall Format: {Anzeige-Typ}{Leerzeichen}{Errorcode in hexadezimaler Schreibweise} Anzeige-Typ 0: Errorcode wird als vorzeichenlose Dezimalzahl dargestellt. Anzeige-Typ 1: Errorcode wird als vorzeichenbehaftete Dezimalzahl dargestellt. Anzeige-Typ 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:\Programme\vdogClient\VDogAutoCheckIn.exe /at:c "/rd:D:\vdClientArchive" /account:{Benutzer} /domain:Testdomain /password:{Passwort} /CFile:d:\AutoCheckIn.ini

Konfigurationsdatei AutoCheckIn.ini:

[Component]

Dir=\Werk 1\Halle 1\Bereich 1\110 S7

Übergabe des Benutzers und Passworts in der Konfigurationsdatei

Kommandozeilenaufruf:

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

Konfigurationsdatei AutoCheckIn.ini:

[User]

Account={Benutzer}

Domain={Testdomain}

Password={Passwort}

[Component]

Dir=\Werk 1\Halle 1\Bereich 1\110 S7

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

Kommandozeilenaufruf:

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

Konfigurationsdatei AutoCheckIn.ini:

[User]

Account=Benutzer

Domain=Testdomain

PasswordMode=2

[Component]

Dir=\Werk 1\Halle 1\Bereich 1\110 S7

Anwendungsbeispiel: Erstellen einer neuen Komponente

Batch-Datei:

@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 [ * ] Starte Check-In

"%VDTOOL%" "/AT:C" "/RD:%CLIENTARCHIVE%" "/CFile:%CFGFILE%" "/Password:%PASSWD%" "/Account:%USERNAME%"

echo [ * ] Check-In beendet (%ERRORLEVEL%)

pause

Konfigurationsdatei CheckInTest.ini:

[Component]

Dir=\Test\NewComponent

[CreateComponent]

// Binär

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 [ * ] Starte 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

Verwandte Themen
UserClient -> Check-In