SolutionPackager-værktøj

SolutionPackager er et værktøj, der kan omdanne en Microsoft Dataverse komprimeret løsningsfil til flere XML-filer og andre filer. Du kan derefter nemt administrere disse filer ved hjælp af et kildekontrolsystem. I følgende afsnit kan du se, hvordan du kører værktøjet, og hvordan du bruger værktøjet med administrerede og ikke-administrerede løsninger.

Hvor finder du SolutionPackager-værktøjet

SolutionPackager-værktøjet distribueres som en del af NuGet-pakken Microsoft.CrmSdk.CoreTools . Følg denne fremgangsmåde for at installere programmet.

1. Download NuGet-pakken.
2. Omdøb filtypenavnet for pakken fra .nupkg til .zip.
3. Udpak indholdet i den komprimerede fil (zip).

Find den SolutionPackager.exe eksekverbare i mappen <extracted-folder-name>/contents/bin/coretools. Kør programmet fra mappen coretools, eller føj mappen til STIEN.

SolutionPackager kommandolinjeargumenter

SolutionPackager er et kommandolinjeværktøj, der kan aktiveres med de parametre, der er identificeret i følgende tabel.

Filformater for kildekontrol

SolutionPackager understøtter to mappelayout ved udpakning og pakning af løsninger.

XML-format (ældre)

Det oprindelige format. Løsningsmetadata gemmes i Other\Solution.xml og Other\Customizations.xml, og alle komponentfiler pakkes ud i et fladt mappehierarki sammen med disse filer. Dette format er standardformatet, når du udtrækker en .zip fil uden mere konfiguration.

YAML-kildekontrolformat

Dette format blev introduceret sammen med Dataverse Git-integration og gemmer løsningsmetadata som YAML-filer, der distribueres på tværs af et struktureret mappehierarki. Det er det format, der skrives, når du sender løsninger ved hjælp af oprindelig Git-integration i Power Apps.

Fordele i forhold til XML-format

• Producerer renere og mere læsbare diff'er pr. komponent i kildestyring
• Understøtter flere løsninger i en enkelt lagermappe
• Lærredsapp-filer .msapp og moderne workflows understøttes kun i dette format
• Omdøbning af plug-in-type navn er som standard aktiveret

Påkrævet mappestruktur

<rootFolder>/
├── solutions/
│   └── <SolutionUniqueName>/
│       ├── solution.yml              (solution metadata)
│       ├── solutioncomponents.yml    (paths to all component files)
│       ├── rootcomponents.yml        (root-level components)
│       └── missingdependencies.yml   (dependency info)
├── publishers/
│   └── <PublisherUniqueName>/
│       └── publisher.yml             (publisher definition)
├── entities/                         (entity components, if present)
├── workflows/                        (classic workflows, if present)
├── modernflows/                      (Power Automate cloud flows, if present)
├── canvasapps/                       (canvas app .msapp files, if present)
└── [other component folders]/

Flere oplysninger: Reference til YAML-kildekontrolformat for løsning

Formatér regler for automatisk registrering

Pakning af en YAML-formatmappe

Følgende kommando pakker en YAML-formatmappe.

SolutionPackager.exe /action:Pack /zipfile:MySolution.zip /folder:C:\repos\myrepo

Pakning fra en mappe med flere løsninger

Følgende kommando pakker en angivet løsning i en mappe med flere løsninger.

SolutionPackager.exe /action:Pack /zipfile:SolutionA.zip /folder:C:\repos\myrepo /SolutionName:SolutionA

Brug kommandoargumentet /map

Følgende diskussion beskriver brugen af argumentet /map til værktøjet SolutionPackager.

Filer, der er indbygget i et automatiseret build-system, f.eks. Silverlight .xap-filer og plug-in-assemblier, bliver typisk ikke logget på kildekontrolelementet. Webressourcer kan allerede være til stede i versionskontrolelementet på steder, ikke der er direkte kompatible med SolutionPackager-værktøjet. Ved at inkludere parameteren /map kan SolutionPackager-værktøjet dirigeres til at læse og pakke sådanne filer fra alternative placeringer og ikke inde fra Extract-mappen, som det typisk ville gøres. Parameteren /map skal angive navnet og stien til en XML-fil, der indeholder tilknytningsparameteren. Disse parametre giver SolutionPackager besked om at matche filerne efter navn og sti og at angive, hvilken alternativ placering den matchede fil skal findes på. Følgende oplysninger gælder for alle direktiver på samme måde.

• Flere direktiver kan angives, herunder de parametre, der matcher identiske filer. Parametrene, der står tidligt i filen, går forud for de parametre, der er angivet senere.

• Hvis en fil er matchet med et direktiv, skal den findes på mindst én alternativ placering. Hvis der ikke findes nogen tilsvarende alternativer, udsender SolutionPackager en fejl.

• Mappe- og filstier kan være absolutte eller relative. Relative stier evalueres altid fra den mappe, der er angivet af parameteren /folder.

• Miljøvariabler kan angives ved hjælp af en %variable% syntaks.

• Et mappe jokertegn "**" kan bruges til at betyde "i en hvilken som helst undermappe". Den kan kun bruges som den sidste del af en sti, f.eks.: "c:\folderA\**".

• Filnavnets jokertegn må kun bruges i formularerne "*.ext" eller "*.*". Der understøttes ikke andet mønster.

  De tre typer direktivtilknytninger er beskrevet her sammen med et eksempel, der viser, hvordan du bruger dem.

Mappetilknytning

Følgende oplysninger indeholder detaljerede oplysninger om mappetilknytning.

XML-format

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

Beskrivelse

Filstier, der svarer til "folderA", ændres til "folderB".

• Hierarkiet af undermapper under hver mappe skal være identisk.

• Mappejokertegn understøttes ikke.

• Der må ikke angives filnavne.

  Eksempler

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

Fil til fil-tilknytning

Følgende oplysninger indeholder flere detaljer om fil til fil-tilknytning.

XML-format

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

Beskrivelse

Enhver fil, der svarer til map-parameteren, læses fra navnet og stien, der er angivet i to-parameteren.

Angående parameteren map :

• Der skal angives et filnavn. Stien er valgfri. Hvis der ikke er angivet en sti, kan filer fra en hvilken som helst mappe matches.

• Jokertegn understøttes ikke i filnavne.

• Mappejokertegn understøttes.

  Angående parameteren to :

• Der skal angives et filnavn og en sti.

• Filnavnet kan afvige fra navnet i parameteren map .

• Jokertegn understøttes ikke i filnavne.

• Mappejokertegn understøttes.

Eksempler

  <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" /> 

I eksemplet ovenfor med NuGet-pakke overskrives cr886_PluginPackageTest.nupkg ikke, hvis filen allerede findes på den angivne placering.

Tilknytning mellem fil og sti

Følgende indeholder detaljerede oplysninger om fil-til-sti-tilknytning.

XML-format

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

Beskrivelse

Alle filer, der matcher parameteren map , læses fra den sti, der er angivet i parameteren to .

Angående parameteren map :

• Der skal angives et filnavn. Stien er valgfri. Hvis der ikke er angivet en sti, kan filer fra en hvilken som helst mappe matches.

• Jokertegn til filnavne understøttes.

• Mappejokertegn understøttes.

Angående parameteren to :

• Der skal angives en sti.

• Mappejokertegn understøttes.

• Der må ikke angives et filnavn.

  Eksempler

  <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" />  

Eksempel på kortlægning

Følgende XML-kodeeksempel viser en komplet tilknytningsfil, der gør det muligt for SolutionPackager-værktøjet at læse en hvilken som helst webressource og de to standardgenererede assemblies fra et Developer Toolkit-projekt med navnet CRMDevTookitSample.

<?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 subfolders -->  
       <FileToPath map="WebResources\*.*" to="..\..\CrmPackage\WebResources\**" />  
       <FileToPath map="WebResources\**\*.*" to="..\..\CrmPackage\WebResources\**" />  
</Mapping>  

Administrerede og ikke-administrerede løsninger

En Dataverse-komprimeret løsningsfil (.zip) kan eksporteres i en af to typer, som vist her.

Administreret løsning
En færdig løsning, der er klar til at blive importeret til en organisation. Når komponenterne er importeret, kan de ikke tilføjes eller fjernes, selvom de eventuelt kan tillade yderligere tilpasning. Dette anbefales, når udviklingen af løsningen er færdig.

Ikke-administreret løsning
En åben løsning uden begrænsninger for, hvad der kan tilføjes, fjernes eller ændres. Dette anbefales under udvikling af en løsning.

Formatet på en komprimeret løsningsfil vil være forskelligt afhængigt af dens type, enten administreret eller ikke-administreret. SolutionPackager kan behandle komprimerede løsningsfiler af begge typer. Værktøjet kan dog ikke konvertere én type til en anden. Den eneste måde at konvertere løsningsfiler til en anden type, for eksempel fra ikke-administreret til administreret, er ved at importere den ikke-administrerede løsnings-.zip-fil til en Dataverse-server og derefter eksportere løsningen som en administreret løsning.

SolutionPackager kan behandle ikke-administrerede og administrerede løsningsfiler .zip som et kombineret sæt via parameteren /PackageType:Both. For at udføre denne handling er det nødvendigt at eksportere din løsning to gange som hver type og navngive de .zip filer som følger.

Værktøjet antager, at den administrerede zip-fil er til stede i den samme mappe som den ikke-administrerede fil, og udpakker begge filer i en enkelt mappe, og bevarer forskellene, hvor der findes administrerede og ikke-administrerede komponenter.

Når en løsning er blevet udtrukket som både ikke-administreret og administreret, er det muligt at pakke begge eller hver type individuelt fra den enkelte mappe ved hjælp af parameteren /PackageType til at angive, hvilken type der skal oprettes. Når du angiver dem begge filer, bliver to .zip-filer produceret ved hjælp af navngivningskonventionen ovenfor. Hvis parameteren /PackageType mangler, når du pakker fra en dobbeltadministreret og ikke-administreret mappe, er standarden at oprette en enkelt ikke-administreret .zip fil.

Fejlfinding

Meddelelse, der vises, når du bruger Visual Studio til at redigere ressourcefiler

Hvis du bruger Visual Studio til at redigere ressourcefsiles, der er oprettet af løsningspakkeren, modtager du muligvis en meddelelse, når du pakker igen i stil med dette: "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." Dette sker, fordi Visual Studio erstatter ressourcefilens metadatakoder med datakoder.

Løsning

1. Åbn ressourcefilen i din foretrukne teksteditor, og find og opdater følgende 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. Skift nodenavnet fra <data> til <metadata>.

   For eksempel denne streng:

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

   Ændringer til:

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

   Dette gør det muligt for løsningspakkeren at læse og importere ressourcefilen. Dette problem er kun blevet observeret ved brug af Visual Studio Resource Editor.

Fejl! "Den nødvendige fil ...\Other\Customizations.xml" blev ikke fundet med en YAML-mappe

Denne fejl vises, når du kører SolutionPackager (eller pac solution pack) mod en mappe, der indeholder YAML-filer, f.eks solution.yml. , men disse filer placeres i roden af mappen i stedet for i den påkrævede solutions/<SolutionUniqueName>/ undermappe.

Forårsage: Værktøjet registrerer YAML-kildekontrolformatet ved at søge efter en solutions/ undermappe, der indeholder *solution.yml filer. Når mappen ikke findes, går værktøjet automatisk tilbage til XML-formatet (ældre) og forventer Other\Customizations.xml. Den resulterende fejlmeddelelse henviser til en XML-fil og nævner ikke YAML, hvilket er vildledende.

Lave: Omorganiser mappen, så YAML-manifestfilerne er under de korrekte stier:

<rootFolder>/
  solutions/<YourSolutionUniqueName>/   ← move solution.yml here
    solution.yml
    solutioncomponents.yml
    rootcomponents.yml
    missingdependencies.yml
  publishers/<YourPublisherUniqueName>/
    publisher.yml

Hvis du har hentet mappen fra en Git-integrations-bekræftelse eller pac solution clone, skal mappestrukturen allerede være korrekt. En mappe, der kun indeholder YAML-filer på øverste niveau uden solutions/ undermappen, repræsenterer en ufuldstændig udtrækning og kan ikke pakkes direkte.

Advarsel! Komponenten, der er erklæret i rootcomponents.yml, har ingen kildefiler

Denne advarsel vises, når en komponent, f.eks. en lærredsapp, er angivet i rootcomponents.yml , men der ikke findes tilsvarende kildefiler i den forventede komponentmappe (f.eks. canvasapps/<schema-name>/).

Effekt: Værktøjet lykkes stadig (afslutningskode 0) og opretter en gyldig .zip fil, men den angivne komponent udelades fra den pakkede løsning.

Forårsage: Mappen blev oprettet ved en delvis udtrækning, eller komponentens kildefiler blev ikke inkluderet i lageret. Det er f.eks. kun løsningsmanifestfilerne, der blev bekræftet, og ikke selve lærredsappen.

Lave: Kontrollér, at alle komponenter, der er erklæret i rootcomponents.yml , har tilsvarende kildefiler i mappen. Filen .msapp skal findes under canvasapps/<schema-name>/ for lærredsapps. Hvis der mangler filer, skal du eksportere hele løsningen fra Dataverse igen og pakke den ud igen eller bruge pac solution clone til at få et komplet uddrag.

Se også

• Brug af kildekontrol med løsningsfiler
• sLøsningsbegreber