SolutionPackager-Tool

  • Artikel

SolutionPackager ist ein Tool, das eine Microsoft Dataverse komprimierte Lösungsdatei umkehrbar in mehrere XML-Dateien oder andere Dateien zerlegen kann. Sie können diese Dateienproblemlos mithilfe von einem Versionsverwaltungssystem verwalten. Die folgenden Abschnitte zeigen, wie Sie das Tool ausführen und es mit verwalteten und nicht verwalteten Lösungen verwenden.

Wo Sie das SolutionPackager-Tool finden

Das SolutionPackager-Tool wird als Bestandteil des Microsoft.CrmSdk.CoreTools NuGet Pakets verteilt. Um das Programm zu installieren, führen Sie diese Schritte aus.

  1. Laden Sie das NuGet-Paket herunter.
  2. Benennen Sie die Dateinamenerweiterung des Pakets von .nupkg in .zip um.
  3. Extrahieren Sie den Inhalt der komprimierten (Zip)-Datei.

Sie finden die ausführbare Datei „SolutionPackager.exe“ im Ordner <Name des extrahierten Ordners>/contents/bin/coretools. Führen Sie das Programm aus dem Coretools-Ordner aus oder fügen Sie diesen Ordner zu Ihrem PATH hinzu.

SolutionPackager-Befehlszeilenargumente

SolutionPackager ist ein Befehlszeilentool, das mit den Parametern aufgerufen werden kann, die in der folgenden Tabelle identifiziert sind.

Argument Beschreibung des Dataflows
/Aktion: {Extract|Paket} Erforderlich. Die auszuführende Aktion. Die Aktion kann das Extrahieren einer Lösungs-ZIP-Datei in einen Ordner oder das Packen eines Ordners in eine ZIP-Datei sein.
/zipfile: <Dateipfad> Erforderlich. Der Pfad und der Name einer Lösungs-ZIP-Datei. Beim Extrahieren muss die Datei vorhanden und lesbar sein. Beim Packen wird die Datei ersetzt.
/Ordner: <Ordnerpfad> Erforderlich. Der Pfad zu einem Ordner. Beim Extrahieren wird dieser Ordner erstellt und mit Komponentendateien aufgefüllt. Beim Packen muss dieser Ordner bereits vorhanden sein und vorher extrahierte Komponentendateien enthalten.
/Pakettyp: {Unmanaged|Managed|Beide} Optional. Der Typ des zu verarbeitenden Pakets. Der Standardwert ist "Nicht verwaltet". Dieses Argument kann in den meisten Fällen weggelassen werden, da der Pakettyp aus der ZIP-Datei oder den Komponentendateien gelesen werden kann. Beim Extrahieren, wenn der Pfad angegeben sind, müssen verwaltete und nicht verwaltete ZIP-Lösungsdateien vorhanden sein und werden in einem einzelnen Ordner verarbeitet. Beim Packen, wenn der Pfad angegeben ist, werden verwaltete und nicht verwaltete ZIP-Dateien aus demselben Ordner hergestellt. Weitere Informationen finden Sie im Abschnitt zur Arbeit mit verwaltete und nicht verwalteten Lösungen weiter unten in diesem Thema.
/allowWrite:{Yes|Nein} Optional. Der Standardwert ist Ja. Dieses Argument wird nur während einer Extraktion verwendet. Wenn /allowWrite:No angegeben ist, führt das Tool alle Vorgänge aus, kann aber keine Dateien schreiben oder löschen. Der Extrahierungsvorgang kann sicher geprüft werden, ohne dass vorhandene Dateien überschrieben oder gelöscht werden.
/allowDelete:Ja{Yes|No|Prompt} Optional. Der Standardwert ist Prompt. Dieses Argument wird nur während einer Extraktion verwendet. Wenn /allowDelete:Yes angegeben ist, werden alle Dateien, die im vom /folder-Parameter angegebenen Ordner vorhanden sind und die nicht erwartet werden, automatisch gelöscht. Wenn /allowDelete:No angegeben ist, wird nichts gelöscht. Wenn /allowDelete:Prompt angegeben ist, wird der Benutzer von der Konsole aufgefordert, alle Operationen zuzulassen oder abzulehnen. Wenn /allowWrite:No angegeben ist, finden keine Löschungen statt, auch wenn /allowDelete:Yes ebenfalls angegeben ist.
/clobber (Optional). Dieses Argument wird nur während einer Extraktion verwendet. Wenn /clobber angegeben ist, werden Dateien, für die das Schreibschutzattribut gesetzt ist, überschrieben oder gelöscht. Wenn dies nicht der Fall ist, geschieht dies nicht.
/errorlevel: {Off|Error|Warning|Info|Verbose} Optional. Der Standardwert ist Info. Dieses Argument zeigt die Ebene der auszugebenden Protokollierungsinformationen an.
/map: <Dateipfad> Optional. Der Pfad und der Name einer XML-Datei, die Dateizuordnungsdirektiven enthält. Bei Verwendung während einer Extrahierung werden Dateien, die typischerweise aus einem Ordner, der vom /folder-Parameterer angegeben wurde, von anderen Orten aus gelesen, die in der Zuordnungsdatei angegeben sind. Während eines Verpackungsvorgangs werden Dateien, die den Direktiven entsprechen, nicht geschrieben.
/nologo Optional. Das Banner zur Laufzeit unterdrücken.
/log: <Dateipfad> Optional. Ein Pfad und ein Name einer Protokolldatei. Wenn die Datei bereits vorhanden ist, werden der Datei neue Protokollierungsinformationen angehängt.
@ <Dateipfad> Optional. Ein Pfad und ein Name einer Datei, die die Befehlszeilenargumente für das Tool enthält.
/sourceLoc: <Zeichenfolge> Optional. Dieses Argument generiert eine Vorlagenressourcendatei und ist nur bei Extrahierungen gültig.

Mögliche Werte lauten auto oder ein LCID-/ISOcode für die Sprache, die Sie exportieren möchten. Wenn dieses Argument verwendet wird, werden die Zeichenfolgenressourcen des gegebenen Gebietsschemas als neutrale .resx-Datei extrahiert. Wenn auto oder nur die Lang- oder Kurzform des Switches angegeben ist, wird das Basisgebietsschema oder die Lösung verwendet. Sie können die Kurzform des Befehls verwenden: /src.
/localize Optional Extrahieren Sie alle Zeichenfolgenressourcen in .resx-Dateien, oder führen Sie sie zusammen. Sie können die Kurzform des Befehls verwenden: /loc. Die Lokalisierungsoption unterstützt freigegebene Komponenten für resx-Dateien. Weitere Information: Verwenden von RESX-Webressourcen

Verwenden des Befehlsarguments /map

Nachfolgend wird die Verwendung des /map-Arguments für das SolutionPackager-Tool erläutert.

Dateien, die in einem automatischen System erstellt werden, wie etwa .xap Silverlight-Dateien und Plug-in-Assemblys, werden normalerweise nicht in das Quellcodeverwaltungssystem eingecheckt. Webressourcen können sich bereits in der Quellcodeverwaltung an Orten befinden, die nicht direkt kompatibel mit dem SolutionPackager-Tool sind. Durch das Einschließen des /map-Parameters kann das SolutionPackager-Tool angewiesen werden, solche Dateien von anderen Orten zu lesen und zu packen, und nicht aus dem Extrahierungs-Ordner wie sonst. Der Parameter /map muss den Namen und den Pfad zu einer XML-Datei angeben, die Zuordnungsanweisungen enthält. Diese Anweisungen weisen den SolutionPackager an, Dateien anhand ihres Namens und Pfads abzugleichen, und geben den alternativen Speicherort an, um die abgeglichene Datei zu finden. Die folgenden Informationen gelten gleichermaßen für alle Direktiven.

  • Es können mehrere Direktivenaufgeführt werden, einschließlich Direktiven, die identische Dateien zuordnen. Früh in der Datei aufgeführte Direktiven haben Vorrang gegenüber den später aufgeführten Direktiven.

  • Wenn eine Datei einer Direktove zugeordnet wird, muss sie sich an mindestens einem alternativen Ort befinden. Wenn keine entsprechenden Alternativen gefunden werden, gibt der SolutionPackager einen Fehler aus.

  • Ordner- und Dateipfade können absolut oder relativ sein. Relative Pfade werden immer von dem im /folder-Parameter angegebenen Ordner evaluiert.

  • Umgebungsvariablen können mit einer %variable% Syntax angegeben werden.

  • Ein „**“-Ordnerplatzhalter kann mit der Bedeutung „in beliebigem Ordner“ verwendet werden. Dieser kann nur als letzter Teil eines Pfads verwendet werden, beispielsweise: „c:\folderA\**“.

  • Dateinamenplatzhalter können nur in den Formularen „*.ext” oder „*.*” verwendet werden. Kein anderes Muster wird unterstützt.

    Die drei Typen von Direktivenzuordnungen werden hier beschrieben, zusammen mit einem Beispiel für ihre Verwendung.

Ordnerzuordnung

Nachfolgend sind Informationen zur Ordnerzuordnung bereitgestellt.

Xml-Format

<Folder map="folderA" to="folderB" />

Beschreibung des Dataflows

Dateipfade, die „folderA“ entsprechen, werden auf „folderB“ geändert.

  • Die Hierarchie der Unterordner muss exakt übereinstimmen.

  • Ordnerplatzhalter werden nicht unterstützt.

  • Es können keine Dateinamen angegeben werden.

    Beispiele

    <Folder map="folderA" to="folderB" />  
<Folder map="folderA\folderB" to="..\..\folderC\" />  
<Folder map="WebResources\subFolder" to="%base%\WebResources" />

Datei-zu-Datei-Zuordnung

Nachfolgende Informationen sind detaillierte Informationen zur Datei-zu-Datei-Zuordnung.

Xml-Format

<FileToFile map="path\filename.ext" to="path\filename.ext" />

Beschreibung des Dataflows

Jede beliebige Datei, die dem Parameter map entspricht, wird von dem im Parameter to angegebenen Namen und Pfad gelesen.

Für den Parameter map:

  • Ein Dateiname muss angegeben werden. Der Pfad ist optional. Falls kein Pfad angegeben wird, können Dateien aus allen Ordnern zugeordnet werden.

  • Dateinamenplatzhalter werden nicht unterstützt.

  • Der Ordnerplatzhalter wird unterstützt.

    Für den Parameter to:

  • Ein Dateiname und ein Pfad muss angegeben werden.

  • Der Dateiname weicht möglicherweise von dem Namen im Parameter map ab.

  • Dateinamenplatzhalter werden nicht unterstützt.

  • Der Ordnerplatzhalter wird unterstützt.

Beispiele

  <FileToFile map="assembly.dll" to="c:\path\folder\assembly.dll" />  
  <FileToFile map="PluginAssemblies\**\this.dll" to="..\..\Plugins\**\that.dll" />  
  <FileToFile map="Webresrouces\ardvark.jpg" to="%SRCBASE%\CrmPackage\WebResources\JPG format\aardvark.jpg" />  

  <FileToFile
    map="pluginpackages\cr886_PluginPackageTest\package\cr886_PluginPackageTest.nupkg"
    to="myplg\bin\Debug\myplg.1.0.0.nupkg" />

Beachten Sie, das im NuGet-Beispielpaket oben: cr886_PluginPackageTest.nupkg nicht überschrieben wird, wenn die Datei bereits am angegebenen Speicherort vorhanden ist.

Datei-zu-Pfad-Zuordnung

Nachfolgend sind detaillierte Informationen zur Datei-zu-Pfad-Zuordnung.

Xml-Format

<FileToPath map="path\filename.ext" to="path" />

Beschreibung

Jede beliebige Datei, die dem Parameter map entspricht, wird von dem im Parameter to angegebenen Pfad gelesen.

Für den Parameter map:

  • Ein Dateiname muss angegeben werden. Der Pfad ist optional. Falls kein Pfad angegeben wird, können Dateien aus allen Ordnern zugeordnet werden.

  • Dateinamenplatzhalter werden unterstützt.

  • Der Ordnerplatzhalter wird unterstützt.

Für den Parameter to:

  • Ein Pfad muss angegeben werden.

  • Der Ordnerplatzhalter wird unterstützt.

  • Ein Dateiname darf nicht angegeben werden.

    Beispiele

  <FileToPath map="assembly.dll" to="c:\path\folder" />  
  <FileToPath map="PluginAssemblies\**\this.dll" to="..\..\Plugins\bin\**" />  
  <FileToPath map="*.jpg" to="%SRCBASE%\CrmPackage\WebResources\JPG format\" />  
  <FileToPath map="*.*" to="..\..\%ARCH%\%TYPE%\drop" />

Zuordnungsbeispiel

Das folgende XML-Codebeispiel zeigt eine vollständige Zuordnungsdatei, die das SolutionPackager-Tool in die Lage versetzt, jede Webressource und die beiden generierten Standardassemblys aus einem Developer Toolkit-Projekt mit dem Namen CRMDevTookitSample zu lesen.

<?xml version="1.0" encoding="utf-8"?>  
<Mapping>  
       <!-- Match specific named files to an alternate folder -->  
       <FileToFile map="CRMDevTookitSamplePlugins.dll" to="..\..\Plugins\bin\**\CRMDevTookitSample.plugins.dll" />  
       <FileToFile map="CRMDevTookitSampleWorkflow.dll" to="..\..\Workflow\bin\**\CRMDevTookitSample.Workflow.dll" />  
       <!-- Match any file in and under WebResources to an alternate set of sub-folders -->  
       <FileToPath map="WebResources\*.*" to="..\..\CrmPackage\WebResources\**" />  
       <FileToPath map="WebResources\**\*.*" to="..\..\CrmPackage\WebResources\**" />  
</Mapping>

Verwaltete und nicht verwaltete Lösungen

Eine Dataverse komprimierte Lösungs-ZIP-Datei kann auf eine von zwei Weisen exportiert werden.

Verwaltete Lösung
Eine abgeschlossene Lösung, die bereit ist, in eine Organisation importiert zu werden. Nach dem Importieren können keine Komponenten hinzugefügt oder entfernt werden, aber sie können optional weitere Anpassung erlauben. Dies wird empfohlen, nachdem die Entwicklung der Lösung abgeschlossen ist.

Nicht verwaltete Lösung
Eine offene Lösung ohne Einschränkungen dahingehend, was hinzugefügt, entfernt oder geändert werden kann. Dieses wird während der Entwicklung einer Lösung empfohlen.

Das Format einer komprimierten Lösungsdatei basiert auf dem Typ,verwaltet oder nicht verwaltet. Der SolutionPackager kann komprimierte Lösungsdateien beider Typen verarbeiten. Das Tool kann jedoch nicht einen Typ mzu einem anderen konvertieren. Die einzige Möglichkeit, Lösungsdateien zu einem anderen Typs zu konvertieren, etwa von verwaltete zu nicht verwaltete, besteht im Import der nicht verwalteten Lösungs-ZIP-Datei in einen Dataverse-Server und dem anschließenden Export der Lösung als verwaltete Lösung.

Der SolutionPackager kann verwaltete und nicht verwaltete Lösungs-ZIP-Dateien als kombinierten Satz über den /PackageType:Both-Parameter verarbeiten. Dazu ist es erforderlich, Ihre Lösung zweimal in jedem Typ zu exportieren, wobei die ZIP-Dateien wie folgt benannt werden.
Nicht verwaltete ZIP-Datei: AnyName.zip Verwaltete ZIP-Datei: AnyName_managed.zip

Das Tool nimmt das Vorhandensein der verwalteten ZIP-Datei im gleichen Ordner wie die nicht verwaltete Datei an und extrahiert beide Dateien in einen einzelnen Ordner, wobei die Unterschiede beibehalten werden, wo verwaltete und nicht verwaltete Komponenten vorhanden sind.

Nachdem eine Lösung als nicht verwaltet und verwaltet extrahiert wurde, ist es möglich, beide aus diesem Ordner zu verpacken (oder beide einzeln), indem der /PackageType-Parameter für die Angabe verwendet wird, welcher Typ erstellt werden soll. Wenn beide Dateien angegeben werden, werden zwei ZIP-Dateien mit der gleichen Namenskonvention wie oben erstellt. Wenn der /PackageType-Parameter bei Packen von einem dualen Ordner (verwaltet und nicht verwaltet) fehlt, ist das Standardvorgehen die Erstellung einer einzelnen nicht verwalteten ZIP-Datei.

Problembehandlung

Wenn Sie Visual Studio verwenden, um die Ressourcendateien zu bearbeiten, die vom Lösungspacker erstellt werden, wird möglicherweise eine Meldung angezeigt, wenn Sie ähnlich erneut einpacken werden: “Failed to determine version id of the resource file <filename>.resx the resource file must be exported from the solutionpackager.exe tool in order to be used as part of the pack process.” Dies tritt auf, weil Visual Studio die Metadatentags der Ressourcendatei mit Datenentags ersetzt.

Problemumgehung

  1. Öffnen Sie die Ressourcendatei in einem Texteditor Ihrer Wahl, und suchen und aktualisieren Sie die folgenden Tags:

    <data name="Source LCID" xml:space="preserve">  
<data name="Source file" xml:space="preserve">  
<data name="Source package type" xml:space="preserve">  
<data name="SolutionPackager Version" mimetype="application/x-microsoft.net.object.binary.base64">

  2. Ändern Sie den Knotennamen von <data> zu <metadata>.

    Zum Beispiel: Die Zeichenfolge:

    <data name="Source LCID" xml:space="preserve">  
  <value>1033</value>  
</data>

    wird geändert zu:

    <metadata name="Source LCID" xml:space="preserve">  
  <value>1033</value>  
</metadata>

    Dies ermöglicht dem Lösungspacker, die Ressourcendatei zu lesen und zu importieren. Dieses Problem wurde nur beobachtet, wenn der Visual Studio-Ressourceneditor verwendet wurde..

Siehe auch

Verwendung der Quellverwaltung mit Lösungsdateien

Lösungskonzepte