Versionsübersicht

Version	Bearbeiter	Datum	Bemerkung/Änderungen
1.00	Patrick Kuhnke	05.12.2015	Erstanlage
1.01	Patrick Kuhnke	22.01.2016	Neuer Parameter %arch%
1.02	Patrick Kuhnke	20.08.2016	Dokumentation zu neuen Startparametern

Inhaltsverzeichnis

1. Zielsetzung und System Voraussetzungen. 3

2. Paket-Struktur. 3

3. Aufbau der package.xml 3

3.1. <package> Header. 4

3.2. Variablen. 4

3.2.1. Globale Variablen. 4

3.2.2. <variable> Option. 5

3.3. <cmd> Befehl 5

3.4. <check> Befehl 6

3.4.1. Definition. 6

3.4.2. Mögliche Optionen. 7

4. WinPKG.exe. 8

4.1. Konfiguration von WinPKG.. 8

4.2. Startparameter von WinPKG.. 8

4.3. Changelog. 9

1. Zielsetzung und System Voraussetzungen

Das Windows Package Tool soll eine einfache Möglichkeit bereitstellen Software auf einem Windows Gerät in der aktuellsten Version zu Installieren. Dabei soll nur noch die Software installiert werden, welche noch nicht auf dem aktuellen Stand ist. Des Weiteren sollen die Pakete einfach zu aktualisieren und erweiterbar sein.

Als Basis für diese Dokumentation wird ein frisch installiertes Windows 7 verwendet. Die genutzte Edition (Home, Ultimate, Enterprise) ist dabei nicht von Bedeutung. Die Software ist getestet unter Windows XP bis hin zu Windows 10 und auf jedem System ohne weitere Runtimes wie z.B. „.NET Framework“ oder „Java“ lauffähig.

2. Paket-Struktur

Beginnend ab dem Verzeichnis in dem die WinPKG.exe liegt wird in jedem Verzeichnis, inklusive aller Unterverzeichnisse, nach der Datei „package.xml“ gesucht. Diese XML Datei definiert die Paket-Informationen wie z.B. Installationsabläufe und prüfungen ob ein Programm bereits installiert ist. In dem gleichen Verzeichnis befinden sich idealerweise auch die Installations-Dateien für das Paket. Diese können aber auch in Unterverzeichnissen hinterlegt werden.

Beispiel für den Adobe Flash Player:

3. Aufbau der package.xml

Eine package.xml Datei für den Adobe Flash Player ist wie folgt aufgebaut und kann als Beispiel genommen werden.

3.1. <package> Header

Jedes Package braucht eine einmalige ID, einen verständlichen Namen und einen Gruppennamen unter der das Paket gelistet werden soll. Diese Informationen stehen in der ersten Zeile der package.xml.

Folgende Optionen sind möglich bzw. Erforderlich

Name	Beschreibung	Default
id	Einmalige ID für das Paket damit intern damit gearbeitet werden kann	Pflichtangabe
name	Dies ist der Titel des Paketes der in der Oberfläche angezeigt wird	Pflichtangabe
group	Name der Paketgruppe in der das Paket angezeigt werden soll. Groß/Kleinschreibung sind wichtig.	Pflichtangabe
priority	Erlaubt sind Zahlenwerte. Diese Option ermöglicht es Pakete vor anderen zu installieren, wenn dies benötigt wird. Je kleiner der Wert desto früher wird das Paket abgearbeitet.	Optional. Standard: 50
desc	Beschreibung für das Paket.	Optional
prereq	Benötigt das Paket zwangsweise ein anderes Paket das zunächst Installiert werden muss, dann kann dessen ID hier angegeben werden.	Optional
checked	Ermöglicht es das Paket nicht automatisch Aktiviert zu initialisieren.	Optional (0/1)

Beispiel:

3.2. Variablen

3.2.1. Globale Variablen

Es gibt bestimmte Variablen die schon Vordefiniert sind und global an jeder Stelle in der package.xml genutzt werden können. Es können auch auf System-Variablen zugegriffen werden wie z.B. %windir%

Folgende Variablen sind möglich

Name	Beschreibung	Default
App	Gibt den Pfad zu der WinPKG.exe wieder	-
Package	Gibt den Pfad zu dem Ordner der genutzten package.xml wieder	-
ARCH	Gibt die Architektur des aktuellen Systems wieder. (x86, x64)	-

3.2.2. <variable> Option

Es können häufig genutzte Strings als Variablen definiert werden. In diesem Beispiel wird die Variable „Name“ mit dem Inhalt „Adobe Flash Player“ angelegt. Alle Vorkommnisse in der package.xml die %NAME% enthalten werden dann ersetzt. Diese Option wird nach dem Paket Header definiert.

Folgende Optionen sind möglich bzw. Erforderlich

Option	Beschreibung	Default
name	Name der Variable	Pflichtangabe
value	Wert der Variable	Pflichtangabe

Beispiel:

</package>

3.3. <cmd> Befehl

Innerhalb der Sektion “<install></install>” wird jeder Befehl (<cmd .. /> ) der Reihe nach abgearbeitet

Folgende Optionen sind möglich bzw. Erforderlich

Name	Beschreibung	Default
debug	Option um beim Initialisieren des Paketes die aufgelösten Werte von Variablen auszugeben bei dem <cmd> Befehl.	Optional (0/1)
arch	x86: der Befehl wird nur auf 32 bit Systemen ausgeführt. x64: der Befehl wird nur auf 64 bit Systemen ausgeführt. *: der Befehl wird immer ausgeführt (Standard).	Optional (x86, x64, *)
path	Dateiname des Tools das ausgeführt werden soll.	Pflichtangabe
param	Parameter die zur Ausführung des Setups notwendig sind.	Optional
name	Name des Programms. Standardangabe ist der Paketname der im <package> Header angegeben wurde.	Optional (Paketname)

Beispiel:

</install>

</package>

3.4. <check> Befehl

3.4.1. Definition

Es können mehrere Checks nötigt sein um zu unterbinden, dass ein Programm installiert wird da das Programm entweder bereits installiert ist oder eine Voraussetzung nicht erfüllt ist. Sollte ein <cmd> durch einen oder mehrere Checks nicht zugelassen werden, dann wird es gar nicht erst zur Installation angeboten.

Die Checks müssen nicht an einen <cmd> gebunden sein, sondern können noch vor dem <install> zweig definiert werden und so schon im Vorwege für das gesamte Paket ein Ausschluss zu definieren.

Beispiel: Ein Paket enthält mehrere Komponenten die installiert werden müssen, dann erhält jeder <cmd> einzeln seine Checks die dafür sorgen, dass diese eventuell nicht installiert werden.

Wenn jedoch vor <install> ein Check auf das Betriebssystem oder eine Datei definiert wurde und dieser nicht erfolgreich ist, dann wird das Paket gar nicht erst weiterbearbeitet und somit auch nichts installiert.

<check type="os" condition=">=" value="5.1.2600.5512" />

</install>

</package>

3.4.2. Mögliche Optionen

Es ist möglich mehrere <check .. /> in ein <cmd ..> </cmd> zu setzen und diese zu kombinieren. Entweder ein Check für jede Architektur oder es soll erst geprüft werden ob das Betriebssystem erlaubt ist und danach ob die Datei schon existiert (oder nicht). Erst wenn alle Checks erfolgreich waren wird das cmd zur Installation freigegeben.

Folgende Optionen sind möglich bzw. Erforderlich

Name	Beschreibung	Default
type	Definiert die Art der Prüfung - OS: Prüft auf die Betriebssystem-Version - File: Prüfung auf existenz von Dateien	Pflichtangabe
condition	Je nach zuvor definiertem Type bestehen andere Möglichkeiten. OS: - : Alle Versionen erlaubt (Standard) - Vergleichsoperatoren o <= : Kleiner oder gleich o >= : Größer oder gleich o = : exakt gleich o < : kleiner als o > : größer als File: - exist: Wenn die Datei existiert, dann .. - notexist: Wenn die Datei nicht* existiert, dann .. - md5: Wenn der Prüfwert der bei PATH angegebenen Datei exakt mit der bei VALUE übereinstimmt - Standard: Produkt-Version der bei PATH angegebenen Datei prüfen. Die bei OS definierten Vergleichsoperatoren können auch hier angewendet werden	Pflichtangabe
debug	Option um beim Initialisieren des Paketes die aufgelösten Werte von Variablen auszugeben bei dem <check> Befehl.	Optional (0/1)
path	Dateiname des Tools das ausgeführt werden soll.	Pflichtangabe
value	Mögliche Werte: Versionsnummern und MD5 Werte	Optional
arch	x86: der Check wird nur auf 32 bit Systemen ausgeführt x64: der Check wird nur auf 64 bit Systemen ausgeführt *: der Check wird immer ausgeführt (Standard)	Optional Optional (x86, x64, *)

Beispiele:
<check type="os" condition="<" value="6.2.9200.0" />

4. WinPKG.exe

4.1. Konfiguration von WinPKG

WinPKG sucht beim Start eine Konfigurationsdatei namens „WinPKG.xml“ und verarbeitet einige Einstellungen sofern die Datei gefunden wird.

Zunächst wird im Startverzeichnis in der die Anwendung liegt gesucht. Sollte dort nichts gefunden werden wird in %systemdrive% und danach in %windir% und %windir%\system32 gesucht.

Folgende Optionen sind möglich bzw. Erforderlich

Option	Beschreibung	Default
maximized	Maximiert das Programmfenster	Optional (0/1)
RebootWhenFinish	Startet das System am Ende aller Installationen sofort neu.	Optional (0/1)
<timer />	Der integrierte Timer kann über folgende Optionen gesteuert werden. - Value: Zeit in Sekunden die der Timer runterzählt. Bei „0“ Beginnt die Installation sofort. - Enabled: (0/1) Timer komplett aktivieren oder deaktivieren	Optional
<set />	Überschreibt den vordefinierten Wert der Option „checked“ aus der angegebenen Package-ID aus den package.xml Dateien. Beide Parameter sind Pflichtangaben. - component: Package-ID - checked: Paket aktivieren oder deaktivieren (0/1)	Optional

Beispiel:

</settings>

4.2. Startparameter von WinPKG

WinPKG.exe kann mit folgenden Parametern gestartet werden.

Option

Beschreibung

/debug

Mit diesem Parameter werden an gewissen Schlüsselpunkten beim Laden der Anwendung und vor dem Start von Installationen Informationen ausgegeben um mögliche Fehler in Paketen ausfindig zu machen.

/silent

Unterdrückt die Meldung, dass keine weiteren Pakete zur Installation zur Verfügung stehen.

4.3. Changelog

Datum	Version	Änderungen
20.08.2016	1.0.0.12	- Neuer Startparameter /silent
22.01.2016	1.0.0.11	- Neue globale Variable %arch% mit den Optionen x86 bzw. x64
05.12.2015	1.0.0.10	- Windows 10 Support beim Erkennen des Betriebssystems - Neue Prüfmöglichkeit: MD5 Werte bei TYPE=“file“
14.05.2014	1.0.0.9	- Changelog nicht mehr bekannt