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
- In configuration manager select Advanced tab.
- Locate Modules.
- Add a module by adding configuration shown below. Note that values must be updated according to your environment.
{
"module" : "com.phenixidentity~phenix-external-event",
"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)
}
}
}
}Save stage and save the configuration.
On reload the module should now have an id. Copy this id and add it to the "module_refs" attribute on the node configuration object.
To be able to use SMS as delivery method an account must be present at PhenixID message gateway.