This guide covers the functionality of Autotrace feature and how it can simplify the process of log/data collection.
Created: April 2024
How to access
To access the functionality, go to WMS -> press Autotrace on the left side menu:
Autotrace opens in a separate browser tab
Autotrace includes the following sections:
Dashboard
Utilities
Autotrace
Autotrace Files
Reports
Support Bible
See detailed description of each of the sections below.
Dashboard
Dashboard provides an overview of the PBX: public IP, disk space usage, CPU & RAM usage, number of active calls, number of registered users.
Dashboard is live and gets refreshed every 30 seconds.
Utilities
The Utilities tab provides access to different tools which help you maintain and support your PBX:
Utilities include the following tools:
Authorization Data: displays all available information about successful / failed authorizations on the PBX for users and admin.
First, you need to select authorization type:
A table opens. Clicking on the Export to CSV button, you can export data in a .csv file for further usage within Excel or Google Spreadsheets, etc.
Authorization Data function works based on the log file “authorization.log” that is created only after enabling “Authorization logging” in Autotrace menu.
Voicemail Audit: provides information about the current status of all mailboxes created on the system. The provided data includes read, unread voicemails, the total number of voicemail messages per user, information about recorded name, unavailable, and busy messages by each user on the system. The button Export to CSV allows to export table data into a .csv file for further usage within Excel or Google Spreadsheets, etc.
“Unassigned” user name in the table means that such voicemail box does exist physically on the system but there is no such user associated with this mailbox.
Callweaver Errors: displays all errors found in callweaver log, specifically 4XX and 5XX messages that can point out a specific problem at the time of the incident report.
Not EVERY entry means that there is a problem on the system; make sure to check with your customer if they had a problem at specific timeframe first before calling support.
Callweaver Errors function works based on the log file “cw.log” that is created only after enabling “Callweaver logging” in Autotrace menu.
Active Device: API request to get the “active device” that is used for calling out at this moment/device that will receive a ringing sound in case “Ring only active device” is enabled.
Push Subscription: displays all users with registered mobile apps (both iOS and Android) and allows you to delete their “Push subscription”.
“Push subscription” is a service that is responsible for sending notifications to mobile phones with Collaboration or x-bees installed to notify about the calls, and chats when the application is “sleeping” in the background.Call Group Membership: this utility displays all DYNAMIC users found in call groups on the PBX and allows removing them if found.
Email Test: allows you to send a test mail to the specified email destination. Just enter the email address, email body and click Send test email:
This feature works only with default Wildix SMTP; it doesn’t work with 3-rd party SMTP servers because of availability of sending a test email function within WMS in such case.
DID Generator: allows to create an inbound Dialplan with multiple DIDs from a .csv file. The .csv file should contain only 2 columns with data:
the first column is reserved for DIDs (dial-in numbers)
the second column is used to assign the user’s extension to this DID.
Example of .csv file:
By default, if the extension is not assigned to the DID → Dial the phone → (called number) is used.
Currently, the only available application is “Dial the phone” as a template application for usage.
After the .csv file with DIDs is uploaded, click Copy to Clipboard:
Then, go to WMS -> Dialplan -> select the desired Dialplan that will be used for inbound calls from the trunk -> select Developer mode and paste the code and click Save:
Be sure to remove square brackets [] before pasting the code. If there are existing DIDs in this Dialplan, it is recommended to remove them and add them via .csv file to avoid breaking the code.
Voicemails: Increase number of files per user: allows to increase/decrease the number of voicemails per mailbox on the PBX. Enter the value and click Update Config:
Delete Voicemails / Recordings after X days: allows to setup deletion of voicemails or recordings within X days instead of months, provided via WMS. This feature will delete files that are older than the number of days specified in the application.
Display Custom Configs: displays all custom configuration files with current settings.
Autotrace
Autotrace menu allows you to set up specific logging on your system and enable additional tools.
The following options are available:
PCAP trace: click Enable and specify the type of pcap trace capture that will be installed on the system:
SIP only → capture of SIP signaling on port 5060 and syslog data on port 514.
SIP + RTP → capture of SIP signaling + RTP ( audio ) and syslog data.
PCAP trace will be restarted upon reboot of the system with the mode that was previously selected.
Callweaver logging: callweaver log that is captured into a separate file “cw.log”.
Callweaver logging is required to be enabled for the work of “Callweaver Errors” option on the Utilities tab.
Authorization logging: logs every successful and failed authorization attempt for PBX users and also logs successful authorization as “admin”. Data is stored in “authorization.log” file in non-formatted view.
Authorization logging is required to be enabled for the work of “Authorization Data” utility on the Utilities tab and displays log information in the table.
Presence logging: this feature allows to collect log information about users' subscriptions to events (e.g. voicemail, park orbit, etc ).
Please, Do NOT enable this feature unless there is a real problem reported on the system, to avoid unnecessary disk space usage on the system.
MTR: set up MTR (aka traceroute) to single or multiple IP addresses for every X minutes.
To set up MTR for multiple IP addresses → use comma as separator. E.g. 8.8.8.8, 4.4.4.4
Ping utility: set up a ping to single or multiple IP addresses for X seconds.
To set up ping to multiple IP addresses → use comma as separator. E.g. 8.8.8.8, 4.4.4.4
Dialplan report: allows to setup Dialplan reporting via deskphones and is installed with a single button click (after enabling Dialplan report, Autotrace_WEB Dialplan rule is automatically added to the Dialpan tab in WMS). No need to change anything in audio files unless PBX has no “Premium” licenses, which is required for TTS generation of sound files. If there are no Premium licenses -> need to create a sound file for steps 2 in the dialplan “Autotrace_WEB”.
Once Dialplan report is installed, perform the following actions:
Go to WMS -> Dialplan -> select Dialplan that is used for outbound calling for regular users.
Create a pilot code ( e.g. 2222 ) that will be dialed to generate the report.
Add Dialplan application for this pilot code -> "Jump to" and in this app select "Jump to" -> "Autotrace_WEB", the dialed number should be "report".
NOTE: If your system doesn't have at least 1 Premium license, you'll have to record an audio file and replace it in step 2 of the Autotrace_WEB Dialplan
This feature supports the following languages: English, English-US, French, Italian, German, Spanish, and Spanish-US.
IP checker: allows to monitor IP change of the PBX, sends email notification if IP was changed (only upon reboot).
Email notification is sent out only to the Admin email.
Autotraces Files
On the Autotrace Files tab you can find all autotrace files related to the Autotrace 3.0, with possibility to download or delete them:
Reports
The Reports section stores all user reports created within Autotrace:
To create a report, click on the Create Report button at the bottom of the screen:
Enter user extension, provide necessary details of the issue and click Submit Report:
The report is sent to Partner’s email, who can then escalate the issue to Customer Care if required.
To create a report from a WP phone, user should dial the pilot code set up in Dialplan (see the section Dialplan report) and follow audio instructions to report the issue.
Support Bible
Support Bible includes the list of commands for Linux, Callweaver, Dialplan and Manuals section with most popular links to Wildix Documentation.
