Packaging DNN extensions
Download as ODP, PDF0 likes2,063 views
The document discusses the packaging of DNN modules, led by Brian Dukes of Engage Software, detailing the evolution of packaging from DNN versions 3 to 5. It highlights significant changes in manifest structure, common pitfalls during installation, upgrades, and file management, along with powerful tools for configuration and cleanup. The document serves as a guide for developers in the DNN ecosystem to navigate complexities in module development and deployment.
![Pitfalls - IUpgradeable <desktopModule> <supportedFeatures> <supportedFeature Type="Searchable" /> </supportedFeatures> ... </desktopModule> <eventMessage> <processorType>DotNetNuke.Entities.Modules.EventMessageProcessor, DotNetNuke</processorType> <processorCommand>UpgradeModule</processorCommand> <attributes> <businessControllerClass>...</businessControllerClass> <desktopModuleID>[DESKTOPMODULEID]</desktopModuleID> <upgradeVersionsList>01.00.00</upgradeVersionsList> </attributes> </eventMessage> </component>](https://image.slidesharecdn.com/packagingdnnextensionswithnotes-101009152132-phpapp01/85/Packaging-DNN-extensions-8-320.jpg)
Packaging DNN extensions
- 1. Packaging DNN Modules Brian Dukes, Engage Software
- 3. Brian Dukes Engage Software since 2006 Chief Software Architect in charge of Module Development Microsoft Certified Professional Developer
- 4. Agenda Brief History & Context Pitfalls Templates & Automation Great tools
- 5. History DNN 3 & 4 - Modules come in .zip files with 3.0 manifest - 3.0 manifest is very convention-based - Skins & containers come in .zip files without manifest DNN 5 - Extensions come in .zip files with 5.0 manifest - 5.0 manifest is extremely declarative - Old packages can still be installed - New system has concept of Package above an Extension
- 6. Types of Installation Components Dashboard Control Widget Core/Extension Language Provider Authentication System Skin Object Module Skin Container Config Script File Assembly ResourceFile Cleanup Custom
- 7. Pitfall - Packages with Same Name Install successful Uninstall - unsuccessful Upgrade - unsuccessful Repair - unsuccessful
- 8. Pitfalls - IUpgradeable <desktopModule> <supportedFeatures> <supportedFeature Type="Searchable" /> </supportedFeatures> ... </desktopModule> <eventMessage> <processorType>DotNetNuke.Entities.Modules.EventMessageProcessor, DotNetNuke</processorType> <processorCommand>UpgradeModule</processorCommand> <attributes> <businessControllerClass>...</businessControllerClass> <desktopModuleID>[DESKTOPMODULEID]</desktopModuleID> <upgradeVersionsList>01.00.00</upgradeVersionsList> </attributes> </eventMessage> </component>
- 9. Pitfalls - Missing files Resource File Component (for content files) <component type="ResourceFile"> <resourceFiles> <basePath>DesktopModules/ModuleName</basePath> <resourceFile> <name>Resources.zip</name> </resourceFile> </resourceFiles> </component>
- 10. Pitfalls - Assembly Paths <component type="Assembly"> <assemblies> <!--basePath>bin</basePath--> <assembly> <name>Company.Module.dll</name> <sourceFileName>Company.Module.dll</sourceFileName <version>1.0.0</version> </assembly> </assemblies> </component>
- 11. Pitfalls - Assembly Versions Install DNN 4 module in DNN 5 site Assembly Version = Package Version
- 12. Templates Code Endeavors - http://codeendeavortemplate.codeplex.com - MSBuild Community Tasks Christoc - http://christoctemplate.codeplex.com - NAnt
- 13. Powerful Tools - Config <component type="Config"> <config> <configFile>web.config</configFile> <install> <configuration> <nodes> <node path="/configuration/system.web/httpHandlers" action="update" key="path" collision="overwrite"> <add verb="*" path="Telerik.Web.UI.WebResource.axd" validate="false" type="Telerik.Web.UI.WebResource, Telerik.Web.UI" /> </node> </nodes> </configuration> </install> <uninstall> <configuration> <nodes /> </configuration> </uninstall> </config> </component>
- 14. Powerful Tools - Cleanup <component type="Cleanup" version="05.01.03"> <files> <file> <path>bin</path> <name>DotNetNuke.Caching.FileBasedCachingProvider.dll</name> </file> </files> </component> <component type="Cleanup" version="05.01.02" fileName ="05.01.02.txt" /> 05.01.02.txt 'remove App_code files App_Code\HTML\HtmlTextInfo.vb App_Code\HTML\ 'remove code behind files DesktopModules\HTML\EditHtml.ascx.vb
- 15. Powerful Tools - Dependencies - CoreVersion - Package - Type - Permission - WebPermission (external web services) - ReflectionPermission - AspNetHostingPermission <dependencies> <dependency type="CoreVersion">05.04.00</dependency> </dependencies>
- 16. Powerful Tools - Assembly Versions <component type="Assembly"> <assemblies> <assembly> <path>bin</path> <name>DotNetNuke.SqlDataProvider.dll</name> <version>05.00.00</version> </assembly> <assembly> <path>bin</path> <name>Microsoft.ApplicationBlocks.Data.dll</name> <version>02.00.00</version> </assembly> </assemblies> </component>
- 17. Tips - .dnn5 extension introduced in DNN 5.2 - HTML in release notes/license
- 18. Questions? Commit to DotNetNuke's Stack Exchange: http://bit.ly/dnn-se
Editor's Notes
- #2: Extension packaging is a powerful tool that extension creators have at their disposal to create a rich, consistent, safe experience for their users. Learn how you can take advantage of all of the tools that DNN provides for the installation experience, and how to avoid some of the more common pitfalls when creating installable extensions for DotNetNuke.
- #7: Left side: extensions Right side: other types of installer components
- #8: Packages with the same name (e.g. maybe related Skin & Container packages) will install correctly, but then you can't update or repair them.
- #9: DNN 5 doesn't automatically check your Business Controller Class for its supported features, as it did in DNN 4. You can specify Searchable and Portable in the supportedFeatures element in the manifest, but you have to specify that eventMessage section to get IUpgradeable to work (and it only runs for the versions in the updateVersionsList node).
- #10: In order to not have to specify every file in your manifest, you can use the ResoureFile component to reference a .zip of those files, instead. This doesn't work, however, for files that the installer needs to reference (i.e. SQL scripts, assemblies, cleanup files, license files, etc)
- #11: The files in the assembly component are implicitly rooted to the bin directory (so you don't need to specify that in a basePath or path element). You can use the sourceFileName element to tell the installer the path to that assembly in your package (i.e. just tell it the name of the assembly if the assembly is in the root of your package)
- #12: If you install a DNN 4 module in a DNN 5 site, all of its assemblies will be marked with the version of the module. If the module's version is higher than the actual version of that assembly, you'll have trouble overwriting the older assembly once your package is using the DNN 5 manifest (or if you have a different module that uses a DNN 5 manifest with that same assembly)
- #13: You can use these to get started with automated packaging
- #14: Looking in the Install folder of a DNN site before it has been installed will give you a great number of examples of packages, as well as examples in the Install/Config folder of the types of config changes you can make. . The Config component lets you update an XML file (usually web.config), removing the need to tell your customers to muck around in there. Remember to also include an uninstall script, as necessary, so you don't break their site upon uninstall.
- #15: You can use a cleanup component to delete old files, either through the manifest or an external file. The external file specifies one file per line, using ticks for comments.
- #16: You can specify that your package is dependent on a specific version of DNN (or higher), or another package, type, or that it requires a certain permission.
- #17: If you put correct version numbers for your assemblies, DNN will manage making sure that the latest version of a shared component is used.
- #18: You can use the .dnn5 file extension to create a package that both DNN 4 and DNN 5 can process (DNN 5 uses the .dnn5 manifest, DNN 4 uses the .dnn manifest). You can provide HTML in the release notes, license, and other fields that show in the install wizard, to provide a richer experience to your customers.
- #19: If you're interested in an excellent platform for DNN Q&A, consider committing to being a part of the DotNetNuke Stack Exchange proposal. I honestly believe it will revolutionize how we help each other and get helped when developing, integrating, and maintaining DNN sites.