Settings Code lists Syst. variables
This tab deals with additional system variables. More about system (unchangeable) variables:
.
+ Add system variable
Enter Title, Value (default value) and System Variable in the $value$ format.
What you have entered into the Value field can be replaced by a value related to a given client.
If you are trying to add overpayment, and see Permission denied message you have to have Main accountant rights. To set them, system administrator has to go to SettingsAdministratorsAdministrators.
No, it is not possible. You cannot set up special speed profiles for the IPTV service.
In Settings Syst. settings General in the voip_offset item, you can state that you want to issue VoIP invoices for:
Go to Settings Syst. settings Inventory. In the Description of pending items to invoice table, activate/deactivate individual items according to your needs.
ISPadmin system supports sending and receiving of SMS messages through a cell phone, connected to a server or through a SMS gateway (hardware or SMPP). Sending of SMS messages can be used in several ways. SMS gateway can be used for sending notifications from Nagios, concerning the device failure, for sending messages to technicians from the Scheduling module, to send reminders to clients for unpaid invoices, and for automatic sending of SMS messages to hardware SMS re-setters in case of a device problem.
In Other Free SMS, you can also send your own SMS messages to any phone numbers, and it is also possible to set the system so that your clients would be able to send a limited number of SMS messages from Client portal, which can be considered as an advantage over the competition. From Other Bulk SMS, you can also send bulk SMS´ to a larger number of clients (e.g. outage notifications) or you can send information SMS to a particular client from Client card.
It is possible to perform a configuration individually according to the below described instructions or you can contact our technical support and have the settings done remotely. In case of a remote installation of SMS gateway by our technical support, you only need to connect a GSM device to a server via serial port (COM1, COM2, USB, UTP) and we will take care of the rest.
The cheapest option is to use older NOKIA and SIEMENS models, which can still be purchased in second-hand shops. These devices are connected through a respective data cable to serial port (COM1, COM2 or USB) of the ISPadmin server. However, when using second-hand mobile phones it may happen that device is faulty and its initiation fails, or the device will work unreliably. For this reason, we recommend to purchase a device directly made for this purpose, and with manufacturer guarantee. We have very good experience with the products of Cinterion, which are based on the Siemens module. You can also use Ateus 2N EasyGate SMS gateway (module MC55i). Alternatively, you may use a different mobile phone, which is listed on gnokii application page as a supported device. Theoretically, it should be possible to connect any device supporting AT commands. Nevertheless, in case of using an untested type of phone, it is not possible to guarantee that this device communicates with the server correctly.
We continue testing other mobile phones and SMS gateways via USB. Due to the lack of appropriate facilities this is a longer-term quest. Presently, we support both the SMS gateway connectivity via COM, and USB interface. USB support is already included in the core in newer installations of ISPadmin based on Debian 6 Squeeze. Using a mobile phone via USB cable is not recommended for older versions of Debian due to frequent problems with USB cable linux drivers.
If you wish to use SMPP protocol for your SMS gateway, we recommend 2N VoiceBlue models. The access type must be set to SMPP (SMSC).
In Settings System Settings General, you have to fill in the values of the following parameters:
Furthermore, check whether you have this line in /etc/inittab:
pp:23:respawn:/usr/local/script/ispadmin/smpp_manager.pl # SMPP Manager
If there is no such line or if it is commented out (#), it is necessary to add it there or uncomment it, save the file and launch the command init q in the command-line interface.
SMPP after the # symbol must be written in capital letters.
Some SMPP-rendering gateways have no interface for sending feedback and they terminate the connection without giving a reason. In such cases, you may add parameters to the triggering script in /etc/inittab trying a combination of these parameters: querysm or readsms. To restart the gateway, run telinit q.
Now you can skip the 2 following paragraphs and continue with System settings for SMS messages.
We recommend: Cinterion (SIEMENS MC35i, MC52i, MC55i, TC35i Terminal)
| Tested models | Not working |
| NOKIA 3310, 5110, 6010, 6210, 6230i (DKU2, CA-53), 6310 | NOKIA E51 (MiniUSB) |
| SIEMENS MC35, MC39i, TC35i, MC75i, ES75 | |
| Cinterion MC35i, MC52i, MC55i, TC35i Terminal, Cinterion TC65i | |
| GSM 2N Ateus-EasyGate with SIEMENS MC55i module | |
|
WM Cinterion EHS5T-E Rel.3 (USB connection, internal memory type for incoming SMS, parameter -b SM: */4 * * * * root killall smsd; sleep 5; /usr/sbin/smsd -u ispadmin -p database_password -c localhost -d ispadmin -m mysql -b SM gnokii parameters: port = /dev/ttyACM0, model = AT, connection = serial |
|
|
WM Cinterion BGS5T (USB or RS-232 connection, internal memory type for incoming SMS, parameter -b SM: */4 * * * * root killall smsd; sleep 5; /usr/sbin/smsd -u ispadmin -p database_password -c localhost -d ispadmin -m mysql -b SM gnokii parameters: port = /dev/ttyACM0 (USB) or /dev/ttyS0 (RS232), serial_baudrate = 115200 # when connected over ttyS0, speed according to the settings in BIOSu, model = AT, connection = serial |
After the connection of a GSM device via a relevant cable to the server, it is necessary to have the access to the server command line, either locally or remotely via SSH. After logging you will perform adjustments of two configuration files and verify the settings functionality. Lastly, enable SMS messages in ISPadmin, and you can perform other related settings. For more see the below listed settings of SMS messages in the system.
Gnokii application ensures communication with mobile phone. The configuration file is located in /etc/gnokiirc. To enable communication between the server and SMS gateway, use already used configuration files or adjust this configuration file manually according to specific settings. In case you run ISPadmin in Vmware you have to map COM port.
You have to copy gnokii app template configuration files for respective models of GSM devices into /etc/. If your phone is correctly connected it should respond to gnokii ---identify command. If not, it is very likely that the phone is connected via gnokii unsupported cable, or the COM port might be faulty. Make sure it is not disabled in BIOS.
Use the following command to simply download configuration file, and just replace the URL to required file:
|
Example of correct listing for Cinterion MC35i SMS gateway: GNOKII Version 0.6.26 |
Example of correct listing for NOKIA 5110 phone: GNOKII Version 0.6.26 |
If the identification was carried out correctly, you can send an sms message from a command line:
echo "text of test sms" | gnokii --sendsms "your phone number”
If the device does not communicate, you can perform a manual adjustment of configuration file of gnokii application. While modifying /etc/gnokiirc, you have to define a few parameters needed for a correct communication with GSM device:
pico -w /etc/gnokiirc
|
port |
model model = 5110 NOKIA Models model = AT SIEMENS and others |
| connection connection = serial Alternatively, modify if you use different connection. |
serial_baudrate serial_baudrate = 19200 Serial port speed. You will need to set different speed for some phones: 9600, 19200, 38400, 57600, 115200. |
| debug debug=on Debugging information is displayed on screen. Enable only when troubleshooting. |
Save the configuration file. If the following command is used, the phone, if properly configured, will respond:
gnokii --identify
Examples of correct listings - see above. In case of failure the server does not communicate correctly with the phone. The error may be in the device itself, faulty or unsupported data cable, or in damaged COM / USB port.
Test the functionality by sending an SMS from command line:
echo "test SMS text" | gnokii --sendsms "phone number”
Service communicating with ISPadmin database. So if the SMS gateway already sends messages from the command line, you can proceed to smsd service activation. First, write down database password with this command:
cat /data/support/ispadmin/config/config.php | grep DBPASS
Then display a file which enables the service to start and search the following line:
pico -w /etc/inittab
#sm:3:respawn:/usr/sbin/smsd -u ispadmin -p DBPASS -c localhost -d ispadmin -m mysql
Uncomment this line and modify runlevel number to 2. Then fill in system database password instead of DBPASS.
Note: Only SMS sending works when using SIEMENS SMS gateway with previously mentioned settings. To enable reception of SMS, add -b MT parameter at the end of the line. This represents internal memory type of Siemens phones. Tested for SIEMENS ES75, MC75i a TC35i models. -b ME memory type must be used for MC39i model. Add -b IN parameter at the end of the line for NOKIA 6310. Again, it is specification of internal memory type for SMS´.
When configuration file is modified apply changes into the system using the following command:
telinit q
If you are using Debian 6 Squeeze and newer, inittab doesn´t work and you have to comment it (/etc/inittab row sm:3:respawn:/usr/sbin/smsd ..). Add the line below into /etc/crontab in a modified way.
Then restart planner by /etc/init.d/cron restart.
nano /etc/crontab
*/4 * * * * root killall smsd; sleep 5; /usr/sbin/smsd -u ispadmin -p database_password -c localhost -d ispadmin -m mysql -b MT
Make sure if the application is actually running in the system:
ps ax | grep smsd
If smsd is running and locking is correctly on in configuration file, SMS can no longer be sent from command line, but from ISPadmin web interface only.
Verify sending and receiving of SMS messages in the administration interface. Follow the instructions in the following paragraph.
If the above mentioned works, proceed to the setting of ISPadmin. The last step, which you need to make before a proper operation, is entering some information and creating groups, needed for proper sending of SMS messages. Log into the system and set the variables for displaying menus and buttons concerning SMS messages. Do the set up in Settings System Settings General, ID sms_notify = 1 for hardware solution or 3 for SMPP.
An SMS notification to network administrators in case of unavailability of routers and network devices. In case of a total network failure the e-mail notification may not be fully functional, therefore it is advisable to have at your disposal a different way of reporting outages, independent from your network or the Internet.
In case of local outage only it is not always necessary to notify the chief administrator, but you can divide the network into certain parts.
First, define SMS templates in Settings Code lists Nagios Templates. You may need to use variables while creating templates. These are: IP, host name etc. In SMS section, one template is always marked as default - used as default template for sending, if no other template is defined.
Add new group for Nagios in Settings Code lists Nagios Contacts, + Add new group. You can name it after location or responsible technician. Select SMS notification type and assign a template.
Then enter phone numbers for the created group. Click on Telephone numbers to open a pane for entering new group contacts. Fill in telephone numbers and names of people to be notified on outages.
Finally, edit relevant routers, which you want to be covered by the outage reporting, and assign this newly created group to the Report outages settings. All network devices connected to this router will be included automatically. If you want to exclude them, you must do so separately for each one of them. This way you can spread the supervision of the entire network among more technicians.
In router heading, you may define Additional Contact for Nagios notification if notification group is SMS. It is an option to set a special telephone number, to which an SMS will be sent in case of an outage. In this case, SMS will be sent to contacts specified for the notification group + Additional Contact. It is a telephone number, which is represented by e.g. a HW re-setter, so in case of an outage a precisely defined SMS will be sent to this contact thus re-setting a device, for instance.
It is recommended to use the Report outages functionality only for backbone, or otherwise important connections, routers and devices. In case that you include even client routers to this settings, you might be informed very often even about minor insignificant outages of clients (for instance if a client switches off his router in order to "save" electricity). So, for client routers it is more suitable to choose just a notification via email.
Outage notifications will be sent just for the first outage and for the first subsequent case of availability. Thus you won´t be overloaded with SMS messages during entire outage period. The device is considered unavailable for responses bigger than 500ms, which already indicates possible problems on the route.
Remember, SMS messages are not appropriate for conveying contractual, or sensitive information. Use email instead. SMS messages, however, are suitable for informing users about unavailability or suspension of a service, planned outage, promotions and so on.
System during its running records various events, which you can browse in History - Statistics History, System / Messages / SMS / SMS for clients. In most cases, there will be delivery reports of sent messages or various notifications from the mobile operator. Incoming messages are sorted from the newest. If an SMS is received from a number of a client, the telephone number is replaced by his name, which you can click on to display Client card. Also, you can display SMS messages in Client card / History.
If you wish to set notifications about incoming SMS messages directly to your email, fill it into sms_notify_inbox_mail in Settings System Settings General.. You can enter numerous email addresses by separating them by a comma / semicolon. For cancelling email notifications, replace the email value with 0.
You can display incoming SMS´s in Dashboard, too.
It is recommended to turn off the delivery reports, in case you will be sending regular bulk SMS´s, thus creating a big amount of delivery reports. A lot of ISPs´ therefore deactivate this function after initial testing.
Nowadays, text messages are delivered almost in 100% of all cases and are thrown away after three or more days, when the target phone is switched off or unavailable. As a result we can say that the text message can always be considered as delivered and the delivery report has just an informative meaning. Nevertheless, it cannot guarantee in any case the reading of a particular communication itself.
You may set up limitations for sending bulk SMS messages. In Settings Syst. settings General, ID sms_minute_limitation, enter the maximum number of SMS messages that may be sent within a minute. In practice, the system monitors the number of SMS messages sent within a second. The number of SMS messages sent within any second can never exceed 1/60 of the set limit value. This function is especially important in the case of the SMPP protocol.
1.1 SettingsSyst. settingsSecurity
(i.e.disabled). If you use client portal, you have to enable it here. (HTTP 80 = 
)1.2 SettingsAdministratorsAdministrators
1.3 SettingsSyst. settingsBackups
Get API key
You have to get an API key in order to be able to start using Google Maps in ISPadmin.
You have to have a Google account to get an API key.
You have to access ISPadmin using the entered domain/IP address for correct key verification.
Enter API key into ISPadmin
Enter the API key in the google_maps_api_key item in Settings Syst. settings General.
You can define a default GPS position to be displayed while editing a client, router, etc. To define it, use the google_maps_default_gps item.
CAUTION
SNMP module is designed for general communication via SNMP protocol with any device supporting Simple Network Management Protokol (SNMP), version 1 or 2.
ISPadmin is able to read data from these devices and generate graphs according to defined SNMP OID templates from the data.
The system enables creation of own SNMP OID template which is used for communication.
Create templates in Settings Other SNMP OID.
If you have created the template including all SNMP OIDs, settings of graph type, value calculation, and colours, you need to assign it to a certain device type (snmp-device).
You can do that in Hardware Settings Device type.
It is possible to add device to each router in router heading in Hardware Routers All - Add - Add device.
Select device type and exact device type which are individual devices in selected group which have a certain template for SNMP communication.
You can select SNMP password for communication with device. If everything is correctly set up you can test the funcionality by clicking on 
Test connection for the router in question. A communication test with Mikrotik is carried out, and also with all the devices defined for SNMP communication. Current values acquired from devices including end calculated values which will be shown in graphs are displayed for tested devices.
This way you can easily debug SNMP template so that values in the graph are displayed correctly.
A special case for using OID template is reading of data from controllable switches supporting SNMP protocol. For such cases, a default template is defined in ISPadmin which you cannot edit; you can copy it and modify a new one for your needs. This template type, however, has a bit different understanding of OID keys. Whereas original templates always use OID key to direct to a certain numeric value, templates for “smart” switches contain table OID keys with mainly several other OID related to one characteristics, e.g. 1.3.6.1.2.1.2.2.1.2 is OID called ifDescr describing all ports on switch; it includes a file of individual OID´s and their values for all ports on switch). OID key column is an important parameter of these templates. Its name is an identifier and it must remain unchanged for this specific purpose. A situation may occur where a certain switch type does not support defined OID for specific purpose, and it is replaced by another one with the same result. For such cases you can change OID and keep reading data functionality. Description of individual OID goes beyond this documentation. Use OID name and key as source for further study.
Add/control administrator accounts in Settings Administrators. We recommend you create various administrator accounts with different access rights for ISPadmin.
A correct adding and using of admin accounts is important mainly for logging of events in changes history which can be accessed via Client card / History for individual contacts, or via Statistics History for the entire system.
ISPadmin multiplies speeds defined in tariff setup by rate_exponent.
You can define the value in Settings System Settings General, ID rate_exponent.
Rate_exponent determines real speed which is given to a client. The default value after the installation is 1.2, so at the speed of 1024 kbit/s, the final speed assigned will be 1228 kbit/s. This increase of tariff speed basically "covers" client´s protocol overhead and potential packet loss, which may occur on WiFi. The client will be satisfied because of higher speed than is actually agreed in the contract. It is not always possible to explain to the client that if they have 1 Mbit/s, there will never be shown 128kB/s during measuring the speed due to the protocol overheads. Thus it is useful to slightly increase the speed of the line and thus reach the desired optical impression.
This "rate exponent" may be used in other cases, too. E.g. for global speed increase for all tariffs in cases of promotional events, or on the contrary to temporarily lower the speed to all clients because of insufficient data transfer efficiency during an unexpected failure or missing connectivity.
You can create your own contract templates in Settings Contracts My templates by clicking on + New template.
A contract template is basically a normal contract in RTF, DOC or DOCX format that you have on your PC (created, for example, by MS Word, Libre Office or Open Office). Create it to your liking (including images, logos and stamps). Make sure that the images included are not too big (because the template size as well as the contract size will increase accordingly).
However, instead of using concrete client or service data, you make use of so-called system variables, which are then replaced with them. Once you are done, you can save your creation to the system as “Own template”. If you have set the pdf_automatic_convert key to 1 in Settings Syst. settings General, then contracts will be automatically converted to PDF once you save them.
Contracts can also be divided into types - e.g. Internet contract, IPTV contract. Contract types can be set up in Settings Contracts Types. Afterwards you can filter according to them in the Client card.
If you have saved a template to the system, you can use it to create new contracts. Go to the Client card and click on Contracts / New contract. If there are any system variables linked to an active service in the template (for example: $IP$ or $C_SMLOUVY$), it is necessary to choose the active service from which data are to be read. It stems from this that a contract in the ISPadmin system can contain the details of only one single active service.
Fixed-term contracts only
