DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact community@dnnsoftware.com.

 


The New Extension Installer Manifest – Part 1, Introduction

In previous blogs I have introduced the new "Unified Extension/Package Installer", particularly with respect to how it is used.  In this blog I will start to introduce developers to the new system.

The concept of the new Installer can be summed up as follows:

  • Provide a manifest driven installation - in this case configuration over convention
  • Provide a single "unified" manifest applicable to all extension types - modules/skins/languages
  • Provide a "component" based installer - a files component for modules can be reused in installing skins or languages files
  • Provide extension points for developers to take advantage of the new system.

So lets dive in to the new manifest and see what is going on.

This is the basic outline of an extension manifest.  In this example we see the outline for the manifest for the Broadcast Polling Caching Provider.

The first line identifies this as a "Package" manifest, and it is a version 5.0 manifest.  This is used by the Installer to identify it as a "new" manifest, and process it accordingly.  The installer, will also recognize legacy manifests, and translate the manifests to the new system.

The architecture of the installer (and the manifest) allows for the installation of multiple packages in one zip archive and this is shown by the use of the packages and package nodes.  A package node has a number of attributes and child nodes.  While these may be fairly obvious, I will briefly explain each one:

  • package - the parent node for a "package"
    • name - a Unique name for the package
    • type - the type of package/extension - eg Module, Skin, Container, Provider, SkinObject etc
    • version - the version of the package
  • friendlyName - a friendly name for the package
  • description - a description of the package
  • owner - the owner of the package
    • name - the name of the owner
    • organization - the organization that owns/created the package
    • url - A url to the owner's website
    • email - A support email address for communicating with the owner
  • license - the license for the package - the license text can either be embedded in the manifest - or in an external file
    • src - the location of the license text - if in an external file
  • releaseNotes - release Notes for this version of the package (as with the license the text can be embedded in the manifest - or in an external file)
    • src - the location of the release notes - if in an external file
  • dependencies - this section describes dependencies that the package expects - I will go into more detain on this in a future blog - but dependencies can be core version, another package (for example a German Language Pack for the Links module has a dependency on the Links module being installed AND a depenency on the German core language being installed)
  • components - a list of components that are in this package.  As with dependenices I will go into this in a future blog - but as an example this package actually contains 5 components - An assembly component, a files component, a database script comonent, a config component for updating web.config and a file cleanup component.

The benefit of this common approach is that all extensions can benefit from the same kind of features we have come to expect from modules.  In addition, we have added a number of new features, definition of the owner/author of the package, inclusion of a license - that the user must explicitly agree to on installation, inclusion of release notes, an extensible dependency framework and an extensible component architecture.

In my next blog on this subject I will delve into the common "components" that make up an Extension package.

Comments

Comment Form

Only registered users may post comments.

NewsArchives


Aderson Oliveira (3)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (13)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (3)
Bill Walker (36)
Bob Kruger (5)
Brice Snow (1)
Bruce Chapman (9)
Bryan Andrews (1)
cathal connolly (52)
Charles Nurse (157)
Chris Hammond (197)
Chris Paterra (55)
Clinton Patterson (25)
Cuong Dang (21)
Daniel Bartholomew (2)
Daniel Mettler (19)
Dave Buckner (2)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (66)
Geoff Barlow (2)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (1)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (234)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (3)
Jordan Coopersmith (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (1)
Michael Washington (202)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Patrick Santry (3)
Peter Donker (50)
Philip Beadle (135)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Willhite (97)
Sebastian Leupold (76)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Torsten Weggen (1)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (36)
Will Strohl (140)
William Severance (5)

Copyright 2014 by DNN Corp | Terms of Use | Privacy | Design by Parker Moore Design