You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

Module Configuration

All module configuration is done from Gateway Webpage in the Config > Modules section. From here you can add, remove, and restart modules. Modules integrate their settings into the Gateway configuration tree, and therefore do not offer settings in this section.


On this page ...


Installing or Upgrading a Module



Install or Update a Module

  1.  On the Gateway Webpage, select Config  > Modules to open the Module Configuration page. 

  2. Scroll to the bottom on the list, find the blue arrow, and click the Install or Upgrade a Module link.  

  3. Click Choose File, select a .modl file that you have previously downloaded.

    Go to the Inductive Automation downloads page.  Search for the module you want and save it to your Downloads folder on your computer. 

    Third Party Modules
    All third party Ignition modules require the Ignition platform to be installed. 

    To install third party modules:
    - Install Ignition: See Installing and Upgrading Ignition
    - Once Ignition is installed, download the module and install it in the Ignition Gateway: See Installing or Upgrading a Module 


    Go back to the Install or Upgrade Module screen and browse your Downloads folder for your module, select it, and click Open. Ignition will copy the path to the module to the Browse field and all that's left for you to do is click Install.

  4. Click Install.  When the page reloads you can now see the module you installed in the list of modules.

Uninstall a Module

  1. On the Gateway Webpage, select Config > Modules to open the Module Configuration page.
  2. Scroll to the the module you want to uninstall.
  3. To the right of module name, click the More button and select uninstall. A confirmation message appears.

  4. Click Confirm. The module is no longer installed and is removed form the list.

Modules are hot-swappable, this means these actions can be performed while the system is running. The isolated nature of modules ensures that performing one of these actions only affects that particular module, and any modules which depend on it. For example, uninstalling the SQL Bridge module will not affect any running Vision module clients.

Restart a Module

Because of the isolated nature of modules, the other modules are not affected by the restart (unless they depend on that particular module).

  1. On the Gateway Webpage, select Config  > Modules to open the Module Configuration page. 
  2. Scroll to the the module you want to restart.
  3. To the right of module name, click the restart button.  

  4. Click Confirm at the confirmation message. 

    Ignition will give you a confirmation message when the module has restarted. 

Module Status

The installed module list on the Module Configuration page also provides some basic information about the State of the module. The VersionLicense, and State columns are all displayed in the list. Module licensing is performed centrally in System > Licensing, so the values here are only for information purposes.

The module State can be either Running or Loaded:

  • Running indicates the module programs are actively performing tasks, for example, the Alarm Notification modules shows as Running because it is continually checking for condition changes that need to set the alarm on or off. 
  • Loaded indicates the module program or resources are available but nothing is running, for example, the Symbol Factory module makes all the symbol images available for your use.

Related Topics ...

  • No labels