Views

Difference between revisions of "optiPoint 410/420 S handle internal phone traces"

The Wiki of Unify contains information on clients and devices, communications systems and unified communications. - Unify GmbH & Co. KG is a Trademark Licensee of Siemens AG.

Jump to: navigation, search
(Deactivate internal phone traces)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div class="breadcrumb">
+
{{Breadcrumb|0|0|{{dev-en}}|optiPoint|optiPoint 410/420 S}}
{{up}} [[How To]]
+
 
</div>
+
[[Image:op420adv-p.jpg|250px|right|optiPoint SIP telephone]]
 +
 
 +
This article describes '''how to handle internal phone traces''' on [[optiPoint 410/420 S]] telephones.
  
 
Sometimes development is not able to pinpoint a problem with network traces only. It could happen that the message flow is correct but the phone behavior is not as it should be. For those cases the phones are able to trace internal processes that show the development what is going wrong.
 
Sometimes development is not able to pinpoint a problem with network traces only. It could happen that the message flow is correct but the phone behavior is not as it should be. For those cases the phones are able to trace internal processes that show the development what is going wrong.
Line 16: Line 18:
 
If it is asked to deliver the internal phone traces in combination with some other traces (e.g. Wireshark) it is necessary that the trace-pc has configured the same SNTP server as the phone.
 
If it is asked to deliver the internal phone traces in combination with some other traces (e.g. Wireshark) it is necessary that the trace-pc has configured the same SNTP server as the phone.
  
* If no SNTP server is available, ensure that you’ve configured the same time on all tracing devices.
+
* If no SNTP server is available, ensure that you've configured the same time on all tracing devices.
  
 
== Activate internal phone traces ==
 
== Activate internal phone traces ==
  
Log-in to the WBM as administrator.
+
* Log-in to the [[WBM]] as administrator.
  
[[Image:oPSIP-IntlPhnTrc_FaultInvestigation.jpg]]
+
: [[Image:oPSIP-IntlPhnTrc_FaultInvestigation.jpg|none|thumb|WBM menu]]
  
Select the Fault Investigation menu.
+
* Select the '''Fault Investigation''' menu.
  
[[Image:oPSIP-IntlPhnTrc_TraceConfiguration.jpg]]
+
: [[Image:oPSIP-IntlPhnTrc_TraceConfiguration.jpg|none|thumb|Fault Investigation menu]]
  
Select Trace Configuration.
+
* Select '''Trace Configuration'''.
  
[[Image:oPSIP-IntlPhnTrc_Tracing.jpg]]
+
: [[Image:oPSIP-IntlPhnTrc_Tracing.jpg|none|thumb|450px|Trace Configuration]]
  
Choose '''File''' as Trace Output.
+
* Choose '''File''' as Trace Output.
 +
* Set the timeout to '''9999''' minutes (max).
 +
* '''Activate''' the checkbox for “Automatic clear before start”.
  
Set the timeout to '''9999''' minutes (max).
+
: [[Image:oPSIP-IntlPhnTrc_ApplicationStreams.jpg|none|thumb|450px|Application streams table]]
  
'''Activate''' the checkbox for “Automatic clear before start”.
+
* Choose / set the parameter as seen on the picture above if nothing else has been requested.
 +
* Click on the '''Submit''' button.
  
[[Image:oPSIP-IntlPhnTrc_ApplicationStreams.jpg]]
+
Trace logging is now activated and all relevant activities of the phone will be saved (untill the trace file is full – oldest messages will be overwritten.
 
 
Choose / set the parameter as seen on the picture above if nothing else has been requested.
 
 
 
Click on the '''Submit''' button.
 
 
 
Trace logging is now activated and all relevant activities of the phone will be saved (till the trace file is full – oldest messages will be overwritten.
 
  
 
== Read out the internal phone traces ==
 
== Read out the internal phone traces ==
Line 50: Line 49:
 
It is recommended to wait ~3 minutes before you read out the phone internal traces. This will ensure that all log messages are written to the file and no messages are lost.
 
It is recommended to wait ~3 minutes before you read out the phone internal traces. This will ensure that all log messages are written to the file and no messages are lost.
  
Log-in to the WBM as administrator.
+
* Log-in to the [[WBM]] as administrator.
  
[[Image:oPSIP-IntlPhnTrc_FaultInvestigation.jpg]]
+
: [[Image:oPSIP-IntlPhnTrc_FaultInvestigation.jpg|none|thumb|WBM menu]]
  
Select the Fault Investigation menu.
+
* Select the '''Fault Investigation''' menu.
  
[[Image:oPSIP-IntlPhnTrc_TraceView.jpg]]
+
: [[Image:oPSIP-IntlPhnTrc_TraceView.jpg|none|thumb|Fault Investigation menu]]
  
Select Trace View.
+
* Select '''Trace View'''.
  
[[Image:oPSIP-IntlPhnTrc_TraceFileStream.jpg]]
+
: [[Image:oPSIP-IntlPhnTrc_TraceFileStream.jpg|none|thumb|Trace View]]
  
Select '''File''' as Trace Source.
+
* Select '''File''' as Trace Source.
  
Choose '''one''' of the activated traces (usually Error, SIP UI, SIP Call Control and SIP Signalling).
+
* Choose ''one'' of the activated traces (usually Error, SIP UI, SIP Call Control and SIP Signalling).
 +
* Click on '''Submit'''.
 +
* The selected stream is now displayed in your browser:
  
Click on '''Submit'''.
+
: [[Image:oPSIP-IntlPhnTrc_LogFile.jpg|none|thumb|600px|Log File]]
  
The selected stream is now displayed in your browser.
+
* Copy all content between the grey Buttons into a text-file.
 
+
* Save it to your computer, using a clear name (e.g. for each stream a separate file: Error.txt; SIP UI.txt …).
[[Image:oPSIP-IntlPhnTrc_LogFile.jpg]]
 
 
 
Copy all content between the grey Buttons into a text-file.
 
 
 
Save it to your computer, using a clear name (e.g. for each stream a separate file: Error.txt; SIP UI.txt …).
 
  
 
Repeat the steps above till you have copied all traces to separate files.
 
Repeat the steps above till you have copied all traces to separate files.
Line 80: Line 76:
 
== Deactivate internal phone traces ==
 
== Deactivate internal phone traces ==
  
Log-in to the WBM as administrator.
+
* Log-in to the [[WBM]] as administrator.
 
 
[[Image:oPSIP-IntlPhnTrc_FaultInvestigation.jpg]]
 
  
Select the Fault Investigation menu.
+
: [[Image:oPSIP-IntlPhnTrc_FaultInvestigation.jpg|none|thumb|WBM menu]]
  
[[Image:oPSIP-IntlPhnTrc_TraceView.jpg]]
+
* Select the '''Fault Investigation''' menu.
  
Select '''Trace View'''.
+
: [[Image:oPSIP-IntlPhnTrc_TraceView.jpg|none|thumb|Fault Investigation menu]]
  
[[Image:oPSIP-IntlPhnTrc_Submit.jpg]]
+
* Select '''Trace View'''.
  
Just click on the Submit button (It doesn’t matter which stream you select).
+
: [[Image:oPSIP-IntlPhnTrc_Submit.jpg|none|thumb|Trace View]]
  
The selected stream is now displayed in your browser.
+
* Just click on the '''Submit''' button. It doesn’t matter which stream you select.
 +
* The selected stream is now displayed in your browser.
  
[[Image:oPSIP-IntlPhnTrc_StopTracing.jpg]]
+
: [[Image:oPSIP-IntlPhnTrc_StopTracing.jpg|none|thumb|450px|Log File]]
  
Push the '''Stop tracing''' button.
+
* Push the '''Stop tracing''' button.
  
By clicking this button all activated traces will automatically be deactivated. The SIP UDP Trace is a separate trace and will not be deactivated.
+
By clicking this button all activated traces will automatically be deactivated. The [[optiPoint SIP UDP Trace|SIP UDP Trace]] is a separate trace and will not be deactivated.
  
 
It is recommended to deactivate the traces after they have been saved to disburden the phone as much as possible.
 
It is recommended to deactivate the traces after they have been saved to disburden the phone as much as possible.

Latest revision as of 08:40, 11 August 2011

optiPoint SIP telephone

This article describes how to handle internal phone traces on optiPoint 410/420 S telephones.

Sometimes development is not able to pinpoint a problem with network traces only. It could happen that the message flow is correct but the phone behavior is not as it should be. For those cases the phones are able to trace internal processes that show the development what is going wrong.

The steps for activating / reading out / deactivating those traces are mostly the same. With this HowTo in hands the requester must only define which traces he needs.

Pre-Conditions

Ensure that the phone is configured with a working SNTP server to have the correct time available in the traces.

  • If no SNTP server is available, ensure that the correct time is configured manually.

If it is asked to deliver the internal phone traces in combination with some other traces (e.g. Wireshark) it is necessary that the trace-pc has configured the same SNTP server as the phone.

  • If no SNTP server is available, ensure that you've configured the same time on all tracing devices.

Activate internal phone traces

  • Log-in to the WBM as administrator.
WBM menu
  • Select the Fault Investigation menu.
Fault Investigation menu
  • Select Trace Configuration.
Trace Configuration
  • Choose File as Trace Output.
  • Set the timeout to 9999 minutes (max).
  • Activate the checkbox for “Automatic clear before start”.
Application streams table
  • Choose / set the parameter as seen on the picture above if nothing else has been requested.
  • Click on the Submit button.

Trace logging is now activated and all relevant activities of the phone will be saved (untill the trace file is full – oldest messages will be overwritten.

Read out the internal phone traces

It is recommended to wait ~3 minutes before you read out the phone internal traces. This will ensure that all log messages are written to the file and no messages are lost.

  • Log-in to the WBM as administrator.
WBM menu
  • Select the Fault Investigation menu.
Fault Investigation menu
  • Select Trace View.
Trace View
  • Select File as Trace Source.
  • Choose one of the activated traces (usually Error, SIP UI, SIP Call Control and SIP Signalling).
  • Click on Submit.
  • The selected stream is now displayed in your browser:
Log File
  • Copy all content between the grey Buttons into a text-file.
  • Save it to your computer, using a clear name (e.g. for each stream a separate file: Error.txt; SIP UI.txt …).

Repeat the steps above till you have copied all traces to separate files.

Deactivate internal phone traces

  • Log-in to the WBM as administrator.
WBM menu
  • Select the Fault Investigation menu.
Fault Investigation menu
  • Select Trace View.
Trace View
  • Just click on the Submit button. It doesn’t matter which stream you select.
  • The selected stream is now displayed in your browser.
Log File
  • Push the Stop tracing button.

By clicking this button all activated traces will automatically be deactivated. The SIP UDP Trace is a separate trace and will not be deactivated.

It is recommended to deactivate the traces after they have been saved to disburden the phone as much as possible.