Dann habe ich angefangen mir den Wert der SoftwareDepotDistributionFlags Variable durch Logging zu erarbeiten …

Nach dem Logging, der anschließenden Bestätigung durch den Support (Danke an Hr. Zinn) und weitere erfahrene Empirum Nutzer habe ich die nachfolgende Tabelle erstellt, die Euch bei der Nutzung hoffentlich schneller zum Ziel bringt als mich ursprünglich. In der Nachbetrachtung hat mich am meisten zum Stolpern gebracht, dass in der Hilfe vom bitweisen Vergleich mit Dezimal Werten gesprochen wird und dann die aufgeführte Tabelle Hex Werte enthält!

Anbei die von mir zusammengestellte Tabelle mit den Verteilbefehlen aus der DDC, den dazugehörigen Dezimal Werten für den bitweisen Vergleich sowie dem Verteilbefehl aus der deutschen Oberfläche.

Arbeiten mit den Werten in der Setup.inf

Setup.inf Beispiele:

;---Abfragen eines gesamten Verteilbefehls (Reinstallation per Pull/Push ohne vorherige Deinstallation)
 If BitXor (%SoftwareDepotDistributionFlags%, 99) == "0" | BitXor (%SoftwareDepotDistributionFlags%, 8291) == "0" Then "ReInstall" Else "EverythingElse" EndIf

;---Abfragen einer einzelnen Verteiloption
 If BitAnd (%SoftwareDepotDistributionFlags%, 32) != "0" then "ForceOnceMachine_is_set" else "ForceOnceMachine_is_not_set" endif

Der Beitrag Empirum Setup.inf – SoftwareDepotDistributionFlags erschien zuerst auf Workplace Management Blog.

• EXIT – das Skript wird vorzeitig verlassen und die Installation wird als Erfolg gewertet. Reboot Anforderungen werden verarbeitet.
• ABORT – das Skript wird vorzeitig verlassen und die Installation wird als Fehler gewertet. In der Management-Console ist der Status „FAILURE“ (Fehler aufgetreten). Das bedeutet, dass das Paket am Client immer wieder ausgeführt wird. Das wiederholte Ausführen wird ggf. durch die maximale Fehleranzahl, die der Agent (ab Empirum v15) zulässt, eingegrenzt. Wird ein Paket mit einem ABORT verlassen, werden Reboot (Reboot= bzw. SetReboot) Anforderungen des Skriptes an den Agenten verworfen!
• ABORTSILENT – das Skript wird vorzeitig verlassen und die Installation wird auf dem Client als Fehler gewertet. In der Management-Console ist der Status wiederum „SUCCESS“ (erfolgreich). Das bedeutet, dass das Paket am Client immer wieder ausgeführt wird. Das wiederholte Ausführen wird ggf. durch die maximale Fehleranzahl, die der Agent (ab Empirum v15) zulässt, eingegrenzt. Wird ein Paket mit einem ABORTSILENT verlassen, werden Reboot (Reboot= bzw. SetReboot) Anforderungen des Skriptes an den Agenten verworfen!
• ABORTREBOOT – das Skript wird vorzeitig verlassen und die Installation wird auf dem Client als Fehler gewertet. In der Management-Console ist der Status „Reboot Pending“ (Neustart ausstehend). Die Installation des Paketes wird nach dem durchgeführten Neustart erneut gestartet. Die Reboot Anweisungen werden somit nicht verworfen!

Welchen Befehl nutzt man nun wann?
Der Abort wird gerne genutzt, wenn die Überprüfung einer extern aufgerufenen Installation (MSI, Unatteded) überprüft wird und die Überprüfung auf den erwarteten Erfolg nicht erfüllt ist.
Dies kann man sich in den Paketvorlagen MSI.inf und Unattended.inf ansehen.

Den EXIT Befehl kann man zum Beispiel nutzen, wenn man ein Paket vorzeitig beendet möchte, weil die Installation der Software ggf. bereits außerhalb von Empirum erfolgt ist.

Der AbortSilent wird genutzt, wenn ein Paket ggf. mehrmals aufgerufen werden muss, damit die eigentliche Installation der Software erfolgreich ist. Ein anderer Anwendungsfall ist zum Beispiel einen Benutzerteil o.ä. vorzeitig zu verlassen, weil die Voraussetzung (Programm noch nicht gestartet, …) noch nicht vorhanden ist.

Der AbortReboot wird ähnlich wie der AbortSilent eingesetzt, lässt jedoch auch zu das eine Reboot Anforderung nicht verworfen wird. Wenn zum Beispiel eine erfolgreiche Installation zuerst eine weitere Software Installation/Deinstallation und einen Neustart erfordert, muss man das Paket zwischenzeitlich mit einem AbortReboot verlassen. Nach dem Neustart wird dann das Paket nochmals ausgeführt und die ggf. zuvor fehlenden Voraussetzungen für eine erfolgreiche Installation sind nun erfüllt.

Der Beitrag Empirum Setup.inf Skript vorzeitig verlassen erschien zuerst auf Workplace Management Blog.

Wenn man nicht weiß, in welcher Datei sich die Einstellung niederschlägt bzw. in welcher Datei die Anpassung vorgenommen werden, kann man die Änderung mittels des PackageWizards und dem Differenzanalyseverfahren (Diff) festhalten.

Variante 1 – Diff bzw. Differenzanalyseverfahren

Das bedeutet, man startet den PackageWizard und wählt den Punkt „Systemanalyse vor und nach der Installation …“ und führt den PreScan durch. Ist der PreScan abgeschlossen, führt man seine Änderung der Einstellung durch bzw. kopiert eine Datei manuell in das Benutzerverzeichnis. Anschließend führt man den PostScan durch. Ist der PostScan erfolgreich abgeschlossen, führt man den PackageWizard Assistenten bis zum Ende durch. Kopieren Sie die Datei nicht auf den EmpirumServer. Wenn man den Haken bei Datei mit dem PackageEditor öffnen wählt, kann man sich die kommenden Schritte sparen.

Nun kann man die gerade erzeugte Setup.inf Datei öffnen. Geben Sie dazu %TEMP% im Windows Explorer ein. Hiermit landet man direkt im temporären Verzeichnis. Hier sollte ein Verzeichnis mit der Herstellerbezeichnung (aus der Eingabe im PackageWizard) vorhanden sein. Darunter befindet sich ein Verzeichnis mit dem Softwarenamen, dann der Version und dann „Install„. Im „Install“ Verzeichnis befindet sich die gerade erstellte Setup.inf.
Jetzt können Sie den Kopierbefehl, als auch die dazugehörige Datei in Ihr ggf. bereits vorhandenes Paket einfügen bzw. übernehmen.

Variante 2 – Empirum Kopierflag CLIENT (pro Benutzer):

Ergänzen der Setup.inf wie folgt. Eintragen eines Sektionsaufrufes unterhalb von [Product] in der passenden Reihenfolge. Vorteilhaft ist es, wenn man den benutzerspezifischen Teil nach der eigentlichen Installation des Programmes ausführt, hier mit Set:Product symbolisiert. Zusätzlich muss die benutzerspezifische Datei (hier: Freecommander.ini) im Ordner (hier: APPDATA\Freecommander) des Programmes unter „Source“ (hier: Packages\<Hersteller>\<Softwarename>\<Version>\) abgelegt werden.

Kopierflags

Die Datei wird in diesem Falle bei einer Deinstallation auch wieder vom Computer entfernt. Ist dies nicht gewünscht, da dann Einstellungen nicht zu einer neu installierten Version übernommen werden, so kann zu den vorhandenen Flags CLIENT ALWAYS auch noch das DONTDELETE hinzugefügt werden. Ein weiterer Blog Artikel zum Kopierbefehl kann hier eingesehen werden, alle Kopierflags sind hier aufgeführt.

ALWAYS

Das Flag ALWAYS überschreibt eine gegebenenfalls existierende Datei. Bei benutzerspezifischen Einstellungen sollte man das Flag ALWAYS immer setzen, da die installierten Programme zumeist eine vordefinierte Einstellungsdatei einrichten und diese hat dann das Datum der Installation der Software und die eigene Einstellungsdatei hätte ggf. ein älteres Datum und würde im Standard nicht installiert/kopiert werden. Mit ALWAYS stellt man somit sicher, dass die eigene Datei mit Einstellungen eine gegebenenfalls vorhandene Datei überschreibt!

[Product]
...
;---Beispiel für eine Installation, diese Zeile nicht übernehmen! 
#Set:Product 
...
#Benutzereinstellungen 
...

[Benutzereinstellungen]
1:APPDATA\Freecommander\Freecommander.ini, %APPDATA%, CLIENT ALWAYS, 0

Variante 3 – Empirum Kopierbefehl copy

Ergänzen der Setup.inf wie folgt. Eintragen zweier Sektionsaufrufe unterhalb von [Product] in der passenden Reihenfolge. Vorteilhaft ist es, wenn man den benutzerspezifischen Teil nach der eigentlichen Installation des Programmes ausführt, hier mit Set:Product symbolisiert. Die Sektion „BenutzereinstellungenMachine“ kopiert die Einstellungsdatei (hier wurde eine config.xml Datei angenommen) auf den Computer zur lokalen Ablage. Die Sektion „BenutzereinstellungenClient“ kopiert die Datei dann pro Benutzer in das angegebene Verzeichnis. Zusätzlich muss die benutzerspezifische Datei im Ordner des Programmes unter „Source“ (hier: Packages\<Hersteller>\<Softwarename>\<Version>) abgelegt werden.

[Product]
...
;---Beispiel für eine Installation, diese Zeile nicht übernehmen!
#Set:Product 
...
 #BenutzereinstellungenMachine, MACHINE 
#BenutzereinstellungenClient, CLIENT 
...

[BenutzereinstellungenMachine]
;---kopiert die Einstellungsdatei im Maschinenteil auf den Computer 
-DEL "%APP%\Config.xml"
Copy "%SRC%\Config.xml" "%APP%\Config.xml"

;---Alternative für einen anderen lokalen Ablageort der Konfigurationsdatei 
;-DEL "%WINDIR%\EmPack\%DeveloperName%\%ProductName%\%Version%\Config.xml" 
;Copy "%SRC%\Config.xml" "%WINDIR%\EmPack\%DeveloperName%\%ProductName%\%Version%\Config.xml"

[BenutzereinstellungenClient] 
;---kopiert die Einstellungsdatei im Benutzerteil von der lokalen Ablage in das benutzerspezifische Verzeichnis 
Copy "%APP%\Config.xml" "%AppData%\<Hersteller>\Config.xml"

;---Bei einem alternativen lokalen Ablageort der Konfigurationsdatei 
;Copy "%WINDIR%\EmPack\%DeveloperName%\%ProductName%\%Version%\Config.xml" "%AppData%\<Hersteller>\Config.xml"

;---Falls bei einer Deinstallation auch die Einstellungen wieder entfernt werden sollen. 
;---Achtung, somit werden Einstellungen nicht in eine neue Version übernommen, da die Config.xml beim Deinstallieren gelöscht wird. 
-DEL "%AppData%\Config.xml"

Setup.exe Aufruf

Als letztes ist es wichtig, dass dem Paket beim Einbinden in das SoftwareDepot auch mitgeteilt wird, das ein Benutzertzeil ausgeführt werden muss. Dies wird auf dem Reiter „Prüfung“ im Feld „Befehl“ vorgenommen. Weitere Informationen dazu sind in diesem Artikel vermerkt.

Der Beitrag Setup.inf – Datei pro Benutzer kopieren erschien zuerst auf Workplace Management Blog.

Das einfache Importieren von *.reg Dateien mit HKCU (HKEY_CURRENT_USER) Einträgen ist dagegen schon fast „fahrlässig“. Die Einstellungen werden ggf. nur für den gerade angemeldeten Benutzer getätigt, wenn es in der Setup.inf nicht richtig eingebunden ist. Dann bekommt der „EmpirumAgent“ diese Einstellungen gesetzt, davon hat jedoch keiner etwas. Wenn nun die *.reg Datei HKCU Einträge beinhaltet, so muss diese im Benutzerteil (Sektion mit CLIENT „geflagged“) importiert werden. Dies kann jedoch bei vorhandenen Group-Policies (GPOs), die den Registry Editor verbietet, zu Problemen führen. Darüberhinaus sind die gleichen Nachteile vorhanden, wie zuvor beschrieben.

Wie bekommt man nun die *.reg Einträge zuverlässig gesetzt und somit in die REG: Sektion der Setup.inf?

Dazu gibt es zwei Methoden:
1. Erstellen der Setup.inf per Differenzmethode
2. Importieren der *.reg Datei in die Setup.inf per PackageEditor

Beides ist bereits in diesem Blogeintrag beschrieben.

Der Beitrag Registry ändern mit REG Dateien erschien zuerst auf Workplace Management Blog.

In einer Sektion die mit Reg: beginnt, dürfen jedoch auch nur Registry Veränderungen enthalten sein, da mittels dieser Sektion die Registry API angesprochen wird.

Wie erstellt man nun einen Registry Eintrag oder wie so häufig genannt – Reg Key?

• Aufzeichnung per Differenzanalyseverfahren (Diff)
• Erstellen der Einträge mittels des Package Editors
• Import von Reg Dateien mittels des Package Editors
• Erstellen der Registry Einträge von Hand
• Erstellen eines „Standard“eintrag
• Weitere Erläuterungen
• Benutzerteil

Aufzeichnung per Differenzanalyseverfahren (Diff)

Wenn man ein Paket per „Diff“ aufzeichnet, hat man die erstellten Registry Einträge auch direkt in der REG:Product und ggf. auch der Reg:OnUninstallProduct vorliegen. Hat man ein Paket mit dem MSI oder Unattended Verfahren erstellt, so kann man anschließend die weiteren Anpassungen per Diff festhalten.

Dazu startet man das installierte Programm, wechselt zu dem Menü oder ähnlich, wo man seine Änderung (z.B.: Automatische Updates, Speicherort der Einstellungen, etc.) vornehmen möchte, startet den PackageWizard, wählt die Option „Differenzanalyseverfahren“ und führt den „PreScan“ durch. Ist der „PreScan“ abgeschlossen, führt man die Veränderung, wie die Programmeinstellung durch. Hat man die Einstellungen im Programm abgeschlossen, folgt man den Schritten des PackageWizard Assistenten bis zum Ende. Falls sich die Programmeinstellungen in Registry Änderungen „niederschlagen“, so kann man die Zeilen aus der [REG:Product] Sektion der gerade erstellten Setup.inf in das vorhandene Paket zur Programminstallation übernehmen.

Erstellen der Einträge mittels des Package Editors

Der Empirum Package Editor unterstützt den Benutzer bei der Erstellung von Registry Einträgen in der „Normalen“ und in der „Erweiterten Ansicht“ auf seine Weise. In beiden Fällen muss man zuvor in „Alle Abschnitte“ die Sektion „Reg:Product“ unter „Options“ auswählen.

In der „Normalen Ansicht“ „klickt“ man sich den Eintrag zusammen, in der „Erweiterten Ansicht“ kann man die Unterstützung mittels der Tastenkombination STRG-Leertaste nutzen.

Import von Reg Dateien mittels des Package Editors

Liegt einem bereits eine *.reg Datei vor, so kann man diese mittels des Empirum Package Editors importieren. Wie das geht ist in der Empirum Hilfe beschrieben.

Erstellen der Registry Einträge von Hand

Die Syntax der Registry Änderungen in der Setup.inf sieht auf den ersten Blick „unerlernbar“ aus. Das ist es aber auf keinen Fall! Der Pfad trennt die Wurzel (HKLM, HKCU, etc.) nicht mit einem „\“ (Backslash), sondern mit einem „,“ (Komma). Die meisten Änderungen betreffen Registry Werte vom Typ REG_SZ oder REG_DWORD.

In der Setup.inf steht nicht der Typ in Form von REG_SZ oder REG_DWORD, sondern 0x00000000 bzw. 0x00010001. Hier eine kleine „Eselsbrücke“, wie ich die wichtigsten Änderungen von Hand vornehme.

REG_SZ entspricht 0x00000000 = „NULL X 8 mal die NULL“
REG_DWORD entspricht 0x00010001 = „NULL X, 3 mal NULL, EINS, 3 mal NULL, EINS“

[Reg:Product]
HKLM,"Software\Hersteller\Produkt","Eigenschaft",0x00000000,"Zeichenkette"
HKLM,"Software\Hersteller\Produkt","AutoUpdate",0x00010001,"0"

Hier geht es zur vollständigen Beschreibung.

Erstellen eines „Standard“eintrag

In der Registry gibt es auch die sogenannten (Standard) bzw. (Default) Werte. Diese werden wie folgt erstellt:

[Reg:Product]
HKCR,"Software\Adobe\Acrobat\Exe",,0x00000000,'"%ProgramFiles%\Adobe\Reader 9.0\Reader\AcroRd32.exe"'

Weitere Erläuterungen

Wird die Reg: Sektion auch bei der Deinstallation aufgerufen, so wird die aufgeführte Änderung rückgängig gemacht, was zumeist bedeutet, dass der Eintrag gelöscht wird. Soll ein Eintrag bei der Deinstallation wieder auf den Wert vor der Installation „zurückgesetzt“ werden, so ist in der Setup.inf unter Reg:OnUninstallProduct der „vor der Installations Registry Wert“ einzutragen.

Soll ein Eintrag oder Baum auch bei der Installation gelöscht werden, so ist der Zeile ein „-“ voranzustellen. Hier ein Beispiel:

[Reg:Product]
-HKLM,"Software\Hersteller\Produkt"

So kann man auch bei der Deinstallation die Registry bereinigen, indem man in  der Reg:OnUninstallProduct Sektion ein „löschen“ mittels „-HKLM,…“  durchführt. Doch hier sollte man mit Vorsicht vorgehen, nicht „zuviel“ zu bereinigen!

Benutzerteil

Hat man eine Setup.inf mit „HKCU,…“ Einträgen, so besitzt dieses Paket einen sogenannten Benutzerteil. Damit der Benutzerteil ordnungsgemäß ausgeführt wird, muss die „Command Line Options =“ ein /AW aufweisen. Viel wichtiger ist jedoch, dass das /AW auch im SoftwareDepot, wo das Paket in die Empirum Management Console eingebunden ist unter den Paketeigenschaften, auf dem Register „Prüfung“, der „Befehl“ um ein „/AW“ erweitert wird. Näheres dazu ist wiederum hier zu finden.

Der Beitrag Empirum Paket – Registry ändern erschien zuerst auf Workplace Management Blog.

[Application]
...
MachineKeyName=%DeveloperName%\%ProductName%\%Version%
UserKeyName=%DeveloperName%\%ProductName%
...

Je nach gesetztem Platform Wert (x86) unter [Setup] kann der Eintrag auch unter HKLM\Software\Wow6432Node abgelegt sein. Meines Erachtens werden mit den Standardeinstellungen die Empirum Paket Informationen verstreut in der Registry abgelegt, was ich persönlich nicht so vorteilhaft finde.

Möchte man alle Empirum Paket Informationen in der Registry unter einem Eintrag zusammengefasst haben, so müssen die angesprochenen Einträge, ähnlich wie hier angegeben, geändert werden.

[Application]
...
MachineKeyName=EmPack\%DeveloperName%\%ProductName%\%Version%
UserKeyName=EmPack\%DeveloperName%\%ProductName%
...

Der Beitrag Anpassung Paketierungsvorlage – Empirum Paket Informationen in der Registry erschien zuerst auf Workplace Management Blog.

Wichtig ist im ersten Schritt mindestens die folgenden Variablen der Setup.inf zu kennen.

• %SRC% entspricht dem Source-Directory (SrcDir=) – das Verzeichnis „auf Höhe“ des Install Verzeichnisses bzw. unter dem Versionverzeichnis. %SRC% = <Hersteller>\<Softwarename>\<Version>.
• %APP% entspricht dem %ApplicationDir% aus der Sektion [Application], zumeist das Zielverzeichnis für eine Installation.

Syntax

Hier nun die Syntax für den Kopierbefehl:
1:Quelldatei,Zielverzeichnis,Kopierflag,Größe

Beispiel

Diese Zeile:
1:WinCmd.exe, ,NORMAL, 123456
kopiert die Datei WinCmd.exe mit der Größe 123456 aus dem %SRC% Verzeichnis in das %ApplicationDir% Verzeichnis.

Quelldatei

Die Quelldatei wird am dem Verzeichnis %SRC% angegeben.

Zielverzeichnis

Ist beim Zielverzeichnis nichts angegeben, wird %ApplicationDir% gesetzt.

Kopierflag

Das einfachste Kopierflag ist NORMAL.

Dieses Kopierflag sorgt dafür, dass die aktuellste Datei im Ziel (auf dem Clientcomputer) „landet“. Ist bereits eine aktuellere Datei auf dem Computer als in der Quelle, so wird die Datei nicht vom Server (Empirum Paket) überschrieben.

Empirum bietet eine Fülle an Kopierflags.
Hier führe ich die häufigst genutzten Befehle auf. Eine komplette Übersicht ist jedoch hier wieder zu finden.

• NORMAL – Die Datei wird nur kopiert, wenn sie neuer ist als das Ziel.
• ALWAYS – Die Datei wird immer kopiert.
• CLIENT – Die Datei wird im Benutzerteil/Benutzerkontext kopiert.
• DONTDELETE – Die Datei wird beim Deinstallieren des Paketes nicht gelöscht.
• SHAREDDLL – Der Zähler bei gemeinsam genutzten DLLs auch hoch und runtergezählt.
• USEFILENAME – Die Datei wird ohne den Quellpfad in das Ziel kopiert.
• WINDOWS32 – nur bei Windows 32bit Betriebssystemen ausführen
• WINDOWS64 – nur bei Windows 64bit Betriebssystemen ausführen

Es können auch mehrere Kopierflags mit einem Leerzeichen getrennt angegeben werden.

Größe

Die Größe bestimmt, wie sich in einem Paket mit Empirum Kopierbefehlen der Fortschrittsbalken verhält. Man kann die Größe auch auf „0“ setzen, dann wird die Größe ignoriert.

Der Beitrag Empirum Kopierbefehl und Kopierflags erschien zuerst auf Workplace Management Blog.

Welche Aufgaben übernimmt der Maschinenteil?
Änderungen an C:\Programme (bzw. %ProgramFiles%).
Änderungen an C:\Windows (bzw. %WinDir%).
Änderungen an der Registry im Bereich HKEY_LOCAL_MACHINE, HKEY_CLASSES_ROOT?.

Welche Aufgabe übernimmt der Benutzerteil?
Änderungen an C:\Dokumente und Einstellungen, respektive C:\Benutzer (bzw. %UserProfile%).
Änderungen an der Registry im Bereich HKEY_CURRENT_USER.
Änderungen im Homelaufwerk.

Hinweise
Ein erstelltes Paket mit einem Benutzerteil muss bei der Einbindung bei dem Feld „Befehl“ mit dem Parameter /AW versehen werden! Wird ein Paket mit dem Parameter /AW installiert, so legt dieses in der Registry im Bereich des im Paket definierten MaschineKeys einen Eintrag MachineSetup mit dem Wert 1 an. Dieser Eintrag ist bei einem Paket ohne /AW Parameter nicht vorhanden!

Der Beitrag Wissenswertes zum Installationskontext erschien zuerst auf Workplace Management Blog.