Installation

DotNetNuke 2.x

DotNetNuke 3.x
Installing the FormView Module
(DNN 3.0.13 and Earlier)
Installing the FormView Module
(DNN 3.1)

 

DotNetNuke 2.x Installation: XMod is installed using the standard procedure for installing private assemblies (PA's). In addition to the standard installation procedure, you will need to perform a couple of additional steps. Complete installation instructions follow:

 

  1. The file you downloaded contained a version of XMod that runs on DotNetNuke (DNN) 2  and one that runs on DNN 3. For DNN2, look for and, to temporary directory, unzip the file "DNN2_XModXXX_Download.zip" where XXX is XMod's version number (i.e. DNN2_XMod320_Download.zip). Inside this file is "DNN2_XModXXX_UnzipMe.zip" which contains this help file along with additional support files and the installation file: "DNN2_XModXXX_Install.zip"

  2. Make sure you are logged in as "host" and navigate to DNN's File Manager tab.

  3. From the File Manager's Actions menu (the yellow pencil), choose Add New File(s)

  4. Select the "Custom Module" option.

  5. Browse to the directory where you unzipped "DNN2_XModXXX_Download.zip" and select "DNN2_XModXXX_Install.zip" where XXX is the XMod version number.

  6. Click "Add"  and then "Upload File(s)". This will install XMod on your site. If you encounter any errors they will be highlighted in red. Please save these messages for future support calls.

  7. If you are running 2.0.4: You need to unzip and upload the contents of "XMod_Resources.zip" to XMod's directory on your sever. This should be (DNN Root)/DesktopModules/XMod/

  8. If you are running 2.1.2: The resources file should have been unzipped into the proper directory. If you find that images are missing, follow the process in step #7.

  9. NOTE: All versions: XMod contains two separate modules - the main interface which is installed by DNN, and the "Form View" interface which provides a means of creating customized feedback-type forms. The Form View is optional but greatly enhances XMod's functionality. To use the Form View, you'll need to manually add a Module definition (see below).

 

DotNetNuke 3.x Installation: XMod is installed using the standard procedure for installing private assemblies (PA's). In addition to the standard installation procedure, you will need to perform a couple of additional steps. Complete installation instructions follow:

 

  1. The file you downloaded contained a version of XMod that runs on DotNetNuke (DNN) 2  and one that runs on DNN 3. For DNN3, look for and, to temporary directory, unzip the file "DNN3_XModXXX_Download.zip" where XXX is XMod's version number (i.e. DNN3_XMod320_Download.zip). Inside this file is "DNN3_XModXXX_UnzipMe.zip" which contains this help file along with additional support files and the installation file: "DNN3_XModXXX_Install.zip"

  2. Make sure you are logged in as "host" and navigate to DNN's Module Definitions tab.

  3. From the Module Definition's Actions menu (the little "down" arrow next to the icon and the words "Module Definitions"), choose "Upload New Module")

  4. Browse to the directory where you unzipped "DNN3_XModXXX_Download.zip" and select "DNN3_XModXXX_Install.zip" where XXX is the XMod version number.

  5. Click "Add"  and then "Upload New File". This will install XMod on your site. If you encounter any errors they will be highlighted in red. Please save these messages for future support calls.

  6. Install Supporting Scripts: For XMod 4+, you need to install additional files that support a number of its user interface features. To do this, locate the "scripts.zip" file in the "DNN3_XModXXX_Download.zip" file. Next, Unzip this file directly into XMod's program directory (typically this will be: /DesktopModules/XMod/) making sure to preserve the folder structure within the zip file. If you cannot unzip the file directly to your web site, unzip the files locally and upload them to the /DesktopModules/XMod/ folder.

  7. NOTE: All versions: XMod contains two separate modules - the main interface which is installed by DNN, and the "Form View" interface which provides a means of creating customized feedback-type forms. The Form View is optional but greatly enhances XMod's functionality. To use the Form View, you'll need to manually add a Module definition (see below).

 

Adding the FormView Module Definition (DNN 3.0.13 and Earlier)

 

  1. Navigate to the "Module Definitions" tab in DNN.

  2. From the Actions menu, select Add New Module Definition.

  3. Enter the following information:

    Module Name:
    XMod FormView
    Description:
    Enables the use of XMod's form-creation abilities to create custom "feedback" or input forms.
     

  4. Click "Update"

  5. In the "New Definition" field, type "XMod FormView" and click "Add Definition"

  6. Next, you'll add three controls. Click the "Add Control" link and enter the following information on the form that appears:

    Source
    : DesktopModules/XMod/XModFeedback.ascx
    Type
    : View

    You can leave the other fields as-is.
    Click the "Update" link
     

  7. Click "Add Control" again and enter the following information:

    Key
    : Forms
    Title
    : Manage Forms
    Source
    : DesktopModules/XMod/ManageForms.ascx
    Type
    : Admin

    The other fields can be left as-is.
    Click the "Update" link.
     

  8. Click "Add Control" again and enter the following information:

    Key
    : Configure
    Title
    : Configure XMod Module
    Source
    : DesktopModules/XMod/ConfigureModule.ascx
    Type
    : Admin

    The other fields can be left as-is.
    Click the "Update" link.

    Your screen should look similar to this:


     It is important that the values in the Control column and values in the Source column match what you see above.
     

  9. Installation is complete. You should now be able to select either "XMod" or "XMod FormView" from the list of available modules and add them to a tab.
     

Adding the FormView Module Definition (DNN 3.1)

  1. Navigate to the Module Definitions tab in DNN

  2. From the Actions menu, select "Add New Module Definition".

  3. On the resulting Edit Module Definitions page, enter the following information (notice there are no spaces in the Module Name value):

    Module Name
    : XModFormView  
    Folder Name
    : XMod
    Friendly Name
    : XMod FormView
    Description
    : Enables the use of XMod's form-creation abilities to create custom "feedback" or input forms.
    Version
    : 01.00.00
    Controller Class
    : [leave this field blank]
    Premium?
    : You can check/uncheck this field depending on whether you want the FormView module to be a premium module.
     

  4. Click the "Update" link

  5. In the "New Definition" field, type "XMod FormView" (without the quotes). Do NOT click the "Add Definition" link yet.

  6. In the "Default Cache Time" field, enter "0" (zero), again, without quotes.

  7. Click the "Add Definition" link

  8. Next you'll add three controls. Click the "Add Control" link and enter the following information on the form that appears:

    Key
    : [leave this field blank]
    Title
    : XMod FormView (this value is optional)
    Source
    : DesktopModules/XMod/XModFeedback.ascx
    Type
    : View
    View Order
    : [you can leave this blank]
    Icon
    : [you can leave this blank]
    Help URL
    : [you can leave this blank]
     

  9. Click the "Update" link to save your changes and return to the Edit Module Definitions form.

  10. Next you'll add the control used to configure the settings for the FormView module. Click the "Add Control" link and enter the following information on the form that appears:

    Key
    : Configure
    Title
    : Configure XMod FormView
    Source
    : DesktopModules/XMod/ConfigureModule.ascx
    Type
    : Admin
    View Order
    : [you can leave this blank]
    Icon
    : [you can leave this blank]
    Help URL
    : [you can leave this blank]
     

  11. Click the "Update" link to save your changes and return to the Edit Module Definitions form.

  12. Finally you'll add the control used to manage the data-entry forms. Click the "Add Control" link and enter the following information on the form that appears:

    Key
    : Forms
    Title
    : Manage Forms
    Source
    : DesktopModules/XMod/ManageForms.ascx
    Type
    : Admin
    View Order
    : [you can leave this blank]
    Icon
    : [you can leave this blank]
    Help URL
    : [you can leave this blank]
     

  13. Click the "Update" link to save your changes and return to the Edit Module Definitions form.
     

  14. Installation Is Complete: Your screen should look similar to this:

     It is important that the values in the Control column and values in the Source column match what you see above.