Installation

DotNetNuke 2.x

DotNetNuke 3.x/4.x
Installing the FormView Module (XMod 4.7 and Later - all supported DNN Versions)
Installing the FormView Module
(DNN 3.0.13 and Earlier)
Installing the FormView Module
(DNN 3.1 and later)

 

DotNetNuke 2.x Installation: Please Note, XMod 4+ is not compatible with DotNetNuke 2.x. These instructions are for installing XMod 3.x on that platform. 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/4.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. When you unzipped the XMod distribution file (the "UnzipMe" file), several folders should have been created. One of those folders is called "Installation". Since XMod is designed to work on several different versions of DotNetNuke, it's important to make sure you've installed the correct version for your site. Within the "Installation" folder, you'll find several sub-folders, each contains the installation file for the listed DNN version(s). For example, you'll find the installation file for DNN 3.1 in the "DNN31" folder, the installation file for DNN 3.2x and 4.0x will be found in the DNN32_AND_DNN40 folder, the file for DNN 3.3 will be found in the DNN33 folder and the DNN 4.3+ version will be found in the DNN43 folder.

    If, for some reason, sub folders weren't created when you unzipped the file, you can still identify the file you need by its filename. For DNN 3.1, you should install the file that looks like: DNN3_XModxxx_Install.zip, where xxx is the XMod version number. For DNN 3.2x and DNN 4.0x, the filename will look like: DNN32_XModxxx_Install.zip. For DNN 3.3 and DNN 4.3, the file will be like: DNN33_XModxxx_Install.zip and DNN43_XModxxx_Install.zip, respectively.
     

  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 that contains the Install zip file you identified in Step #1.
     

  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: XMod 4.0 required you to install supporting client-script files separately. Beginning with XMod 4.0.2, those files are installed as part of the module's installation. However, if DNN runs into trouble installing these files, you may need to install them manually. In which case, you should follow these instructions...  For XMod 4.0, 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 distribution zip file (the "UnzipMe" file).  Next, Unzip the scripts.zip 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. The resulting folder structure for the scripts should look like:
    /DesktopModules
    /XMod
    /scripts
     /componentart_webui_client
     /editor
       /xmod
     /progressbar

  7. If You Are Upgrading: If you are upgrading your version of XMod from version 3 or earlier, you should re-index your data. This typically only needs to be done once but may be performed whenever you need. XMod 4 has made great strides in performance. However, in order for your site to take advantage of those enhancements, your legacy data needs to be indexed. You do this by logging in as Host and going to the XMod Administration page and clicking the Re-Index Data button on the General tab.
     

  8. 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 install it. Installation is a one-click process beginning in XMod 4.7. manually add a Module definition (see below).

 

Adding the FormView Module - XMod 4.7 and Later

  1. After you have installed XMod 4.7 or later, if you haven't already done so, login to your DNN site under the Host or SuperUser account,

  2. Locate an XMod module or add one to a page.

  3. From the module's Actions Menu, select Administration to navigate to the XMod Administration page.

  4. On the General tab, find the FormView Module section and click the Install/Update Module button.

  5. After clicking the button you should receive a success message. If you don't, you may need to configure the module manually - See the instructions below for instructions on how to do that.

  6. After your module is installed, you'll be able to place XMod FormView modules on your pages to display your XMod forms.

  7. XMod also provides a set of basic starter packages. These are collections of data-entry forms and templates to help get you started using XMod more quickly. For more information, see the XMod Starter Packages topic.

Adding the FormView Module Definition (DNN 3.0.13 and Earlier, Pre-XMod 4.7)

Note: If you have previously installed the FormView module for an earlier version of XMod, you do not need to re-install it and may safely skip this step.

  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 and later, Pre-XMod 4.7)

Note: If you have previously installed the FormView module for an earlier version of XMod, you do not need to re-install it and may safely skip this step.
 

  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). If you are running DNN 3.10, do NOT click the "Add Definition" link yet. If you are using DNN 3.11 or later you should click the Add Definition link.

  6. For DNN 3.10 users, In the "Default Cache Time" field, enter "0" (zero), again, without quotes and click the "Add Definition" link

  7. 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] or select xmod_icon.gif, if it's available.
    Help URL
    : [you can leave this blank]
     

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

  9. 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] or select xmod_icon.gif if it's available
    Help URL
    : [you can leave this blank]
     

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

  11. 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] or select xmod_icon.gif if it's available
    Help URL
    : [you can leave this blank]
     

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

  13. 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.