[Feature-3595] VOIP Gateway Status

Has anyone got an idea on how to monitor the connection status of the notification voip gateway. I am using an ATCOM IP02. Every once in a while it crashes and needs rebooted. I would like to setup an alarm when the connection state drops to unregistered or unavailable. Any ideas?

Currently there isn’t a simple way to monitor the Voice Notification Profile status in Ignition. We have a feature request in our queue for this to create a System Tag to monitor each Voice Notification Profile’s status, which would allow you to configure an alarm on that tag, but there is no timeline for when this will be completed. Would this feature match what you’re looking for?

Yes!

63da8625.jpeg

blocked.gif

Hey Stat,

Is there a link or topic where I can read on this?

I'm sorry to say that at this time, this feature (documented under IGN-3595 internally) has not been completed and we do not have documentation for it. While it's not currently on our development roadmap, we appreciate your interest and are always looking for feedback and suggestions from users to help prioritize new features. If you have a use case for this feature that you would like to share, I encourage you to respond further in this thread. I have already linked this forum post for reference to IGN-3595, so that the developers will be able to reference this forum thread when they eventually work on this feature.

I also encourage you to create a feature post on IA's features and ideas page if there isn't one already. The upvotes on features on this page helps us prioritize new features based on community interest. If you do create one, please share the post here so that I can add a reference to it on our internal ticket.

I would like to upvote this. I have the same need here to monitor that profile status so operators know that callouts are not going to work before they just happen to notice their phone hasn't rung in a while...

This feature post is currently linked to IGN-3595 internally, so you can upvote this feature and provide a comment to further show your interest if you'd like.

While this feature is currently not on the development team's roadmap, there is a way to achieve some monitoring of the Notification Profile's status with use of the documented methods from the Ignition API and scripting.

I wrote up an example script that you could modify for your own use if you'd like. The script is expected to be run from the Gateway scope. You could apply this script in the gateway scripting project and then have it execute regularly via runScript with an Expression Tag. Then you can trigger an alarm based off the value of the expression tag like you would for a System tag. The default possible values for the profile status are in the ProfileStatus section of the Java Doc below, but there are some unique to VOIP such as "Registered with VOIP Host "

def getStatus(name):
from com.inductiveautomation.ignition.alarming.notification import AlarmNotificationManager, AlarmNotificationProfile
from com.inductiveautomation.ignition.alarming import AlarmNotificationContext
from com.inductiveautomation.ignition.gateway import IgnitionGateway

context = IgnitionGateway.get()
alarmNotificationManager = context.getModuleServicesManager().getService(AlarmNotificationContext).getAlarmNotificationManager()

return alarmNotificationManager.getProfile(name).getStatus().getMessage()

Some disclaimer about using API functions though. Since this is a script and not an official feature of Ignition like a System tag, there is a possibility that the method names and their package locations could change between Ignition versions as the Ignition API is modified, which is worth keeping in mind when upgrading. In the links below, the methods are documented under the Ignition 8.1.43 rc1 section, so the method and import statements will work in Ignition 8.1.43rc1. Please note that our Support team specializes in assisting with official features and would not be able to troubleshoot the API methods. If you have further questions about these API methods, I recommend having those conversations in the forums where members of the development team and other experienced API users can help you.

Java Doc links for the methods that I used:
https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.43-rc1/com/inductiveautomation/ignition/alarming/AlarmNotificationContext.html#[…])
https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.43-rc1/com/inductiveautoma[…]on/alarming/notification/AlarmNotificationManager.html
https://files.inductiveautomation.com/sdk/javadoc/ignition81/8.1.43-rc1/com/inductiveautoma[…]on/alarming/notification/AlarmNotificationProfile.html