agalue / OpenNMS-Ionic-UI

A mobile application for OpenNMS made with Ionic 3

OpenNMS-Ionic-UI

A mobile application for OpenNMS made with Ionic 3

This project has been created for the merely purpose of learning TypeScript, Angular 4 and Ionic 3. It also takes advantages of the async/await available on newer TypeScript thanks to ES7.

It was designed based on the current state of OpenNMS Horizon 19, but it could work on older versions of Horizon as well as Meridian.

It requires to enable CORS on your OpenNMS server, in order to access the data through the ReST API.

On your web.xml, make sure the following section is enabled:

<filter-mapping>
    <filter-name>CORS Filter</filter-name>
    <url-pattern>/rest/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>CORS Filter</filter-name>
    <url-pattern>/nrt/*</url-pattern>
</filter-mapping>

It might be possible that the following section should be added:

<filter-mapping>
    <filter-name>CORS Filter</filter-name>
    <url-pattern>/api/*</url-pattern>
</filter-mapping>

First, install NodeJS on your system (tested against 6.x LTS, and 7.x or greater):

https://nodejs.org

Then, Ionic should be installed on your system as well, in order to compile and use this project locally or on your device:

sudo npm install -g cordova ionic

To test the application using your browser, clone the project and then execute the following commands from the application directory:

npm install
ionic build
ionic serve

For IOS deployemnt, you need a Mac with XCode. For Android deployment, you need Android Studio. The following link provides more information:

https://ionicframework.com/docs/guide/testing.html

Features Implemented

• Add multiple OpenNMS servers to your app. This information will be stored locally on your device.
• Visualize a summary of your server, by displaying the SLM View, the Alarms Summary, and the Outage Summary.
• Visualize the list of events, alarms, outages and notifications, using infinite-scroll with server side fetch for paging.
• Searching capabilities for events, alarms, outages and notifications.
• Ack, Unack, Clear or Escalate alarms, if the user has the appropriate permissions.
• Visualize the Regional Status Map based on alarms or outages (for geo-located nodes).
• Visualize the Nodes Map (for geo-located nodes).
• Visualize the nodes and its SNMP settings, IP interfaces, SNMP interfaces, Service Availability, Assets and Resources.
• Visualize graphs using the available templates per resource type.
• Set the node's location based on your device's current geo-location, or pick one from the map.
• Visualize the Reginal Status Map (based on either alarms or outages, as it is available on Horizon 19. Older versions won't support this feature).
• Configure SNMP Settings (if the user has the appropriate permissions).
• Configure Requisitions and Foreign Source definitions, with the ability to view the whole content of the requisitioned inventory.

Screenshots

Future Enhancements

• Add support for configuring scheduled outages per node (requires API changes).
• Modify sticky and journal notes for alarms (requires API changes).
• Hide unsupported features based on the version of the target OpenNMS server.
• [Native Component] Copy alarms, notifications or outages to the clipboard.
• [Native Component] Share alarms, notifications or outages (email, sms, whatsapp, etc.).
• [Native Component] use pin-dialog or touch-id to protect the access to the app.