How to manually add a new module definition. This tutorial is recommended for experienced DotNetNuke module programmers only. It provides a manual process for undertaking custom module upload. See 'Uploading a New Module' for the typical method.

Stage One – Create the Desktop Module

This stage will add the required information to the database to display the module in the list of available modules for Administrators.

1. Navigate to Host > Module Definitions.
2. Select Create Module Definition from the module menu.
3. In the Module Name text box, enter a name for the module E.g. Announcements
4. In the Folder Name text box, enter a folder name for the location of module files. E.g.  Announcements
5. In the Friendly Name text box, enter a friendly name for the module. Announcements
6. In the Description text box, enter a new description for the module E.g. The Announcements Module renders a list of announcements and a Read More link.
7. In the Version text box, enter the version of the module (e.g. 3.00.00).
8. The following Optional settings are also available:
   • In the Compatibility text box,  A regular expression which describes the module compatibility with the host application based on version
   • In the Controller Class text box, if the module supports optional Interfaces, such as Portable, enter the class where these interfaces are implemented.
   • At Supported Features select Portable, Searchable or Ungradeable.
   • In the Premium? text box, check the check box if the module is a premium module and has a charge associated with it. To assign this module to a portal for use if a premium is to be charged, add the portal to the assigned list.
9. Click the Create link. The module will now be listed in the modules list.

Stage Two – Add the Module Definitions

Module Definitions define a complete module interface (typically a view, edit and view options set of interfaces), which will be later associated with Module Controls. Typically only one module definition is associated with a Desktop Module, although module suites can be created to add multiple interfaces when a Desktop Module is added. To add a module definition to the Desktop Module, follow the steps below.

1. In the New Definition text box, enter the module name.
2. Click the Add Definition link. This will now populate the Definitions drop down list.
3. Repeat Steps 1 to 2 as necessary.

Stage Three – Add the Module Controls

The final step in adding a module is to add the physical controls to be displayed in the module. In a typical module there will be three interfaces: the View interface, the Edit interface, and the View Options interface. To add a module control to a module, follow the steps below.

1. At Definitions, select a module definition to add a module control to.
2. Click the Add Control link.
3. In the Key text box, enter the key for the control. Typically for an edit control, enter Edit. Note: this is the field that you can pass in the query string of a URL to display this interface (e.g. www.byte.com.au/Default.aspx?tabid=1&mid=200&ctl=Edit)
4. In the Title text box, enter the name of the module as it should appear in the controls list and when the interface is displayed (e.g. Edit Announcements).
5. At Source, select the .ascx interface from the drop down box, this is the link to the physical file which defines the module interface.
6. At Type, select from the following types:
   1. Skin Object: This is the interface type for the display of a Skin defined in the .ascx format.
   2. Anonymous: This is the interface type for the display of the module if anyone with out login rights can see.
   3. View: This is the interface type for the display of information in the module.
   4. Edit: This is the interface type for the editing of information in the module.
   5. Admin: This is the interface type for a module interface only an Administrator can view.
   6. Host: This is the interface type for a module interface only a Host Administrator can view.
7. In the View Order text box, enter a view order override if desired.
8. In the Help URL text box, enter a URL to a web page with information on how to use the module/interface
9. Click the Update link.
10. Repeat Steps 2 to 9 for each Module Control to be added.