5.4.1 Event Reporter

Find the Event reporter in the Network – Supervision services – Event reporter menu. Here you can set the basic rules for sending info SMS on system parts. This function is subject to licence!

  • Event – set the event type to be SMS-reported. Choose one of the following options:
    • PBX restart – PBX restart notification.
    • PBX keepalive – sending of KeepAlive messages for PBX operation check. Set the KeepAlive sending period in the Scheduled events in the Global data menu.
    • Port ready – notification of virtual port function reactivation.
    • Port busy – notification of virtual port occupation. The BRI and PRI ports are considered busy whenever all channels have been occupied. This function cannot be used for the SIP or SMTP port.
    • Port error – virtual port error notification.
    • Storage error – notification of a functionless physical storage (due to network failure, e.g.).
    • Storage full – notification of a functionless logical storage due to overfilling.
    • No call port credit – low credit notification for a defined virtual port.
    • No call SIM credit – low credit notification for a defined SIM card.
    • No call terminal credit – not implemented yet.
    • No call user credit – low credit notification for a defined user.
    • No SMS port credit – notification of SMS limit exhaustion for a defined port.
    • No SMS SIM credit – notification of SMS limit exhaustion for a defined SIM card.
    • No SMS terminal credit – not implemented yet.
    • No SMS user credit – low credit notification for a defined user.
    • State of status control object Error – notification of the status control object transition to the Error state.
    • State of status control object OK – notification of the status control object transition to the OK state .

Set the report sending hysteresis to avoid excessive report [s] – set the report sending hysteresis to avoid excessive report sending due to repeated port changes. The states to which a hysteresis timeout applies are reported at once (within one report) after the timeout.

Report on Active Notification

Define how to report an active event:

  • Message – specify the SMS text to be sent whenever the selected event occurs (Port error, Storage full, etc.), i.e. when the event is active. If the Message field is not completed, the SMS will not be sent. In addition to standard texts, the following dynamic strings can be entered:
    • %n – name – enter the name of the event reporter that recorded the event.
    • %d – date – enter the PBX date and time valid at the instant of event recording.
    • %k – key – enter the name of the port to which the event relates.
    • %v – value – enter the event value. At present, there is no event to meet this parameter.
  • Relay action – this option is not available until the port is selected in the Used relay block. Choose the required relay action: 
    • Switch on – close the relay of the below-specified port whenever some of the conditions defined in the Event parameters is met.
    • Switch off – open the relay of the below-specified port whenever some of the conditions defined in the Event parameters is met.
    • Positive pulse – close the relay of the below specified port for a period defined in the Relay pulse width parameter whenever some of the conditions defined in the Event parameters is met.
    • Negative pulse – open the relay of the below specified port for a period defined in the Relay pulse width  parameter  whenever some of the conditions defined in the Event parameters is met.
  • Relay pulse width – if  Positive pulse/ Negative pulse above is enabled, set the pulse width in milliseconds.

Report on Inactive Notification

Define how to report an inactive event:

  • Message – specify the SMS text to be sent whenever the selected event ceases to exist (Port error, Storage full, etc.), i.e. when the event is inactive. If the Message field is not completed, the SMS will not be sent. In addition to standard texts, dynamic strings can be entered (see above).
  • Relay action – this option is not available until the port is selected in the Used relay block. Choose the required relay action.
  • Relay pulse width – if Positive pulse/ Negative pulse in the above mentioned parameter is enabled, set the pulse width in miliseconds.

Parameter Evaluation

  • Active notify evaluation – specify under which conditions the message shall be sent. The following options are available:
    • Independent of parameter – messages on active/inactive events are sent for each parameter separately, independently of the states of the other parameters.
    • At least one parameter active – messages are sent for each parameter with active event separately, independently of the states of the other parameters. If the %k string is used in the SMS text, the SMS always contains a list of parameters with active event. The inactive event message is not sent until the event ceases to exist for all the parameters.
    • All parameters active – this selection represents a logical AND of all the selected parameters. The message is sent only if the event condition is met for all of the selected parameters. Messages on inactive events are sent for each parameter separately, independently of the states of the other parameters. If the  %k  string is used in the SMS text, the SMS always contains a list of parameters with active event.
  • Deglitch active change shorter than [s] – restrict the evaluation of active events in the case of abrupt changes. If the selected event exists for a time period shorter than as defined here, the event will not be evaluated as active.
  • Deglitch inactive change shorter than [s] – restrict the evaluation of inactive events in the case of abrupt changes. If the selected event stops for a time period shorter than as defined here, the event will not be evaluated as inactive.

Figure: View of Event Reporter Settings

Send as User

  • User – define the user to be presented as the message author.

Send to User

  • User – define the user to which the message shall be sent.
  • Save to User – enable/disable saving messages to the user regardless of the user settings, or respecting the user settings.
  • SIP extensions – enable/disable resending messages to user SIP extensions regardless of the user settings, or respecting the user settings (According to stations).
  • Email extensions – enable/disable resending messages to user email extensions regardless of the user settings, or respecting the user settings (According to stations).
  • Mobility Extensions – enable/disable resending messages to user external extensions regardless of the user settings, or respecting the user settings (According to stations).

SNMP

  • Notification – specify the SNMP user for notifications. The SNMP block is not available yet.

Used Relay

  • Port – specify the port whose relay is to be closed whenever some of the conditions defined in the Event parameters is met.

Event Parameters

The block is accessible if one of the above mentioned options (PBX restart, Port ready, Port error, etc.) is selected in the Event parameters. A survey of available objects related to the event is to the left and a list of objects currently monitored by the given Event reporter is to the right. Use the arrows to move the objects from one side to the other.

Example

Refer to Figure 1 for GSM port trunk occupation. If all the GSM ports are occupied, the addressee is sent an "All ports occupied" SMS. When some of the GSM ports get released (the selected event is inactive), the addressee is sent the "Port %k is free" SMS, where %k represents the list of available ports.

HTTP Commands

2N® NetStar allows you to close/open the defined relay via the HTTP commands on default port 8088. Change the port in the Network – Network settings – API menu. Enter the HTTP command as follows:

http://ns_address:port/httpAPI.xml?port=1&relay=ON&pulselen=1000

where

  • port is the port ID BIO
  • relay can be ON (closed) or OFF (open)
  • pulselen defines the closing/opening pulse time in milliseconds. The parameter is optional.

Example:

Close relay:

http://192.168.100.100:8088/httpAPI.xml?port=1&relay=ON

Open relay:

http://192.168.100.100:8088/httpAPI.xml?port=1&relay=OFF

Close relay for 3 seconds:

http://192.168.100.100:8088/httpAPI.xml?port=1&relay=ON&pulselen=3000

Caution

  • The HTTP command is Lower/Upper Case sensitive. Keep the format to avoid the HTTP command failure.