Skip to main content

Install and verify

This page is for the person who looks after the Ignition gateway.

What you need​

You needDetails
Ignition8.1.33 or later in the 8.1 line (tested on 8.1.53), or 8.3.3 or later in the 8.3 line (tested on 8.3.10)
Gateway accessAn administrator login to the gateway
The module fileThe file for your Ignition line, from the releases page: Arifa-SMS-Notification-0.10.0-ignition-8.1.modl or Arifa-SMS-Notification-0.10.0-ignition-8.3.modl

Back up the gateway first​

Download a gateway backup from the gateway's backup page. On Ignition 8.1, go to Config > System > Backup/Restore and choose Download Backup. On Ignition 8.3, the backup page is at <gateway address>/app/platform/system/backup-restore/backup. Keep the file safe.

warning

Once Arifa is configured, a gateway backup contains the stored Africa's Talking API key. Protect backups as you would any file that holds a live key.

Download​

Download the .modl file of the latest release from the releases page. There is one file for each Ignition line. Choose the one that matches your gateway, because the two are not interchangeable. Only the latest release is supported.

Install the module​

Both module files are signed with the same certificate. While you install, Ignition shows the certificate's Thumbprint, and it must read:

65 83 84 55 22 06 7C CC F9 C6 9B C6 F3 C6 41 98 3A 28 BD 20

  1. Go to Config > System > Modules and choose Install or Upgrade a Module.

  2. Select the ...-ignition-8.1.modl file.

  3. Ignition shows the module's certificate, with the warnings "This certificate is self-signed" and "This module was not written by Inductive Automation". Both are expected. See why it says self-signed.

  4. Compare the Thumbprint Ignition shows with the one above. If they differ, stop and do not install the file.

    Ignition's Module Certificate Information dialog with the warning This certificate is self-signed. Subject Name and Issuer Name are both Nedama Integrated Solutions, and the Thumbprint reads 65 83 84 55 22 06 7C CC F9 C6 9B C6 F3 C6 41 98 3A 28 BD 20.
    The certificate dialog. The Thumbprint on the last line must match the one above.

  5. Accept. Arifa SMS Notification is listed under Nedama Integrated Solutions as Running, with a Free licence and no trial countdown.

    Ignition's module list showing Arifa SMS Notification, licence Free, state Running, under Nedama Integrated Solutions with a self-signed certificate.
    Arifa installed and running on Ignition 8.1.

If you ever installed an unsigned test build, uninstall it, restart the Ignition service, and then install the signed module.

Why it says "self-signed"​

Ignition checks the signature of every module when it is installed, and refuses a file that has been changed since it was signed.

Arifa is signed with a certificate issued by Nedama Integrated Solutions to itself, not by a certificate authority. That is what "self-signed" means, and it is why Ignition shows the warning. The thumbprint is how you check that the certificate is ours: the same thumbprint is published in the arifa-sms README.

Check the file before installing (optional)​

To check a downloaded file before you install it, use tools/VerifyModule.java from the arifa-sms repository, on any machine with a JDK:

java tools/VerifyModule.java Arifa-SMS-Notification-0.10.0-ignition-8.3.modl

It ends with RESULT: OK and prints the certificate thumbprint, which must match the one above.

Upgrade​

These steps install a newer Arifa release on the same Ignition line. To move a gateway from Ignition 8.1 to 8.3, see Upgrading from 8.1 to 8.3.

  1. Write down the settings of each Arifa profile, or take a screenshot of them.
  2. On the Modules page (Config > System > Modules on 8.1, Platform > System > Modules on 8.3), choose Install or Upgrade a Module (on 8.3, Install or Upgrade Module +), and select the new .modl file. If the gateway refuses it, uninstall Arifa first (below), restart the Ignition service, and install the new file.
  3. Compare the thumbprint, as for a new install, and accept.
  4. Check that each Arifa profile still has its settings and shows Running. If a profile is missing, create it again from your notes, and choose it again on the pipeline's Notification block.

Uninstall​

  1. Write down the settings of each Arifa profile, in case you install Arifa again later.
  2. To stop real SMS straight away, untick Enabled on the profile.
  3. On the Modules page (Config > System > Modules on 8.1, Platform > System > Modules on 8.3), uninstall Arifa SMS Notification.

Done when: Arifa SMS Notification is listed as Running on 8.1, or Active on 8.3, and the thumbprint you checked matches the one on this page.