Monitoring events

PhenixID server has the ability to notify administrators based on system generated events. Depending on configuration a SMS or e-mail is sent with event information. This article describes how to configure system notifications.

List of available events can be found here: Event ID's.

Installing and configuring module

Open the phenix-store.json file with texteditor.

Locate the node id/hostname in the file onto witch you intend to install the module. Install the module by  adding:

Configuration 

{
      "module" : "com.phenixidentity~phenix-external-event~1.5.0", //To be replaced with your version
      "enabled" : "true",
      "config" : {
        "events_sms" : {
          "eventid" : [ "<EVENT ID>", "<EVENT ID>" ], //Events to monitor
          "recipients" : [ "<MOBILE NUMBER>", "<MOBILE NUMBER>" ],//List of recipients. Leave empty to disable
          "connectionsettings" : {
            "username" : "", // PhenixID sms gateway account to use to send sms
            "password" : ""// Password for PhenixID sms gateway account
          }
        },
        "notify_sms" : {
          "connectionsettings" : {
            "username" : "", // PhenixID sms gateway account to use to send sms
            "password" : "" // Password for PhenixID sms gateway account
          }
        },
        "notify_email" : {
          "connectionsettings" : {
            "host" : "",// hostname of SMTP-server
            "port" : "",//Port to be used when connecting to SMTP-server
            "username" : "",//Username when sending with authenticated relay.
            "password" : "",//Password when sending with authenticated relay.
            "sourceaddress" : ""//Sending address
          }
        },
        "events_email" : {
          "eventid" : [ "<EVENT ID>", "<EVENT ID>" ], //Events to monitor
          "recipients" : [ "<MAIL TO ADDRESS>","<MAIL TO ADDRESS>" ],//List of recipients
          "connectionsettings" : {
            "host" : "",// hostname of SMTP-server
            "port" : "",//Port to be used when connecting to SMTP-server
            "username" : "",//Username when sending with authenticated relay. 
            "password" : "",//Password when sending with authenticated relay. 
            "sourceaddress" : "",//Sending address
            "tlsenabled": "<true/false>", //optional (default true)
            "sslenabled": "<true/false>", //optional (default false)
            "subject": "<custom subject>", //optional
            "verifyserveridentity": "<true/false>" //optional (default false)

          }
        }
      }
    }

To be able to use SMS as delivery method an account must be present at PhenixID message gateway.