You can help by commenting or suggesting your edit directly into the transcript. We'll review any changes before posting them. All comments are completely anonymous. For any comments that need a reply, consider emailing docs@inductiveautomation.com.
Version:
LESSON LIST
-
3:41Installing Ignition on Windows
-
6:13Upgrading Ignition
-
3:32Installing or Upgrading a Module
Supplemental Videos
LESSON
Installing or Upgrading a Module
Description
Learn how to install, upgrade, or uninstall a module after Ignition is installed.
Video recorded using: Ignition 8.3
Transcript
(open in window)[00:00] Modules are a special combo of code and resources that extend the functionality of the Ignition platform. They come packaged up in a structured .modl file that we can install and run inside our Ignition Gateway. If you're ready to add a new module to your Ignition Gateway or maybe just update an existing module to get the latest fix, it's easy to do both right from the Ignition Gateway webpage. In addition, we'll take a quick look at the tools to help you disable an existing module or uninstall a module you don't need anymore. Let's head over to the side menu and navigate to platform, then system, then modules. Here we get a list of all the modules installed within our Gateway To explore module management, we can click on the install or upgrade module button and bring up the installation modal. Next, we need to click on the choose file button. I've already downloaded some module files for us to play with. Let's try upgrading an existing module first.
[01:03] Right now, I've got a bit of a mess in my Gateway modules page. I have an old copy of the alarm notification module installed. Without the latest version, though, it and several related notification modules are faulted. I'll click on the install or upgrade module button, and we can remedy that. I'll choose the updated alarm notification. .modl file I downloaded earlier and click install module. You'll notice that we got a success message, but nothing really changed for our faulted modules. Before our new module installation takes effect, we'll need to restart the Gateway to save our pending changes. The prompt that appears at the bottom of the page will make that process easy, and we'll get to that restart soon, but we still have some exploring to do. There are several other useful tools available for managing your modules. In the three dots menu, we can also disable or uninstall a module if we want. For example, I don't need to use this Legacy DNP3 driver anymore, so I'm gonna disable it.
[02:04] Now, let's look at installing a new module. I really wanna add Twilio voice notifications to my next project, so I need to make sure I've got the Twilio Integration and Alarm Notification module installed on my Gateway. We can choose that file as the module for our fresh install. Once we're done making our changes, we need to kick off a Gateway restart to persist them. At this point, you may wanna create a Gateway backup before restarting, so you have a reference point if needed. I've already done that, so we'll restart the Gateway and wait for everything to reload. In this process, depending on which module you're installing or updating, you may need to accept a new certificate. If that's necessary, you'll see a popup window like this. It'll list the certificate needed, and you can follow a link to a page where you can add the module certificate to your list of trusted certificates. The module might also have a new software module license agreement. If so, you'll just need to accept the terms in the license agreement and accept the license.
[03:05] Now, let's log into the Gateway with our credentials and head back to the modules page to make sure everything works. Our modules are in place, active, and good to go. With these simple steps to install, update, disable, and uninstall modules, you can effectively extend and manage the functionality of your Ignition platform.