Cover sheet SIMATIC Technical Support Diagnostic tools June 2014 Service & Support Answers for industry.
This entry is from the Siemens Industry Online Support. The general terms of use (http://www.siemens.com/terms_of_use) apply. Security information Siemens provides products and solutions with industrial security functions that support the secure operation of plants, solutions, machines, equipment and/or networks. They are important components in a holistic industrial security concept. With this in mind, Siemens products and solutions undergo continuous development. Siemens recommends strongly that you regularly check for product updates. For the secure operation of Siemens products and solutions, it is necessary to take suitable preventive action (e.g. cell protection concept) and integrate each component into a holistic, state-of-the-art industrial security concept. Third-party products that may be in use should also be considered. For more information about industrial security, visit http://www.siemens.com/industrialsecurity. To stay informed about product updates as they occur, sign up for a productspecific newsletter. For more information, visit http://support.automation.siemens.com. 2 V 2.6 Entry ID: 48698507
Contents Contents 1 Overview... 4 1.1 Motivation... 4 1.2 Overview of Diagnostics Options... 4 1.3 Requirements for Extended Diagnostics of PCS 7 and WinCC Plants... 6 1.3.1 Software Components... 6 2 Configuration of Diagnostics... 8 2.1 Dr. Watson... 8 2.2 User Mode Process... 9 2.2.1 Processes to be monitored... 14 2.3 Script Diagnostics (APDIAG)... 16 2.4 Windows Performance Monitor... 18 2.5 SIMATIC Batch Trace... 26 3 Tools... 30 3.1 SIMATIC Diagnostics Tool... 30 3.2 Windows Problem Steps Recorder (PSR)... 31 3.2.1 Start the Windows Problem Steps Recorder... 31 3.2.2 Make recordings... 32 4 Archiving the Diagnostics... 33 4.1 Acquisition of Local Diagnostics Data... 33 5 Literature... 35 5.1 Bibliography... 35 5.2 Internet Links... 35 6 History... 36 6.1 Version Overview... 36 V 2.6, Entry ID:48698507 3
1 Overview 1 Overview 1.1 Motivation Proper evaluation of qualified status data is necessary for successful diagnostics and resulting actions. The aim is to improve the quality diagnostics results and therefore their comparability by applying automatic, uniform diagnostics. The advantages of this diagnostics concept are the following: Standardized and automatic acquisition of diagnostics data Permanent and comprehensive diagnostics Integration of the diagnostics tool without causing interference of production operations The diagnostics data is available as soon as an event occurs Diagnostics of the Windows process level 1.2 Overview of Diagnostics Options The following figure shows an overview of the tools to be configured. Figure 1-1 4 V 2.6 Entry ID: 48698507
1 Overview Dr. Watson Dr. Watson logs data after a program error. Creating a log file Creating a crash memory dump User Mode Process The "User Mode Process Dumper" monitors the processes set and creates a memory dump in the event of an error. Script Diagnostics (APDIAG) Diagnostics tool for in-depth and effective analysis of script errors. Windows Performance Monitor SIMATIC Batch Trace Runtime monitoring for determining script errors. Support in analyzing errors and performance problems. The system monitor (performance monitor) integrated in the Windows operating system is designed to detect resource bottlenecks in the system. Detailed monitoring of the operating system resources used. Cyclic recording of system resources. After activation, a log of the batch processes is stored continuously. SIMATIC Diagnostics Tool The "SIMATIC Diagnostics Tool" acquires diagnostics and system data for service, support and maintenance. The tool can be run locally on a computer, but can also acquire diagnostics data from other computers via remote access in distributed systems. Acquisition of diagnostics data. Acquisition of system data. Archiving of acquired data sorted according to computer in the ZIP format. Transfer of central data via the integrated ftp service. Windows Problem Steps Recorder (PSR) With "Windows Problem Steps Recorder" you can record your procedure which led to a fault. A recording includes the following components: Text describing the elements that you click with the mouse Screenshots at the time of each click V 2.6, Entry ID:48698507 5
1 Overview 1.3 Requirements for Extended Diagnostics of PCS 7 and WinCC Plants 1.3.1 Software Components Standard software components Table 1-1 Windows 2000 Windows XP Windows Server 2003 Components Version Note PCS 7 V6 V 6.x Includes WinCC V 6.0 PCS 7 V7.0 V 7.0 Includes WinCC V 6.2 PCS 7 V7.1 V 7.1 Includes WinCC V 7.0 WinCC V6 V 6.x WinCC V7 V 7.x Tools and diagnostics software Table 1-2 Components Version Note User Mode Process Dumper 8.1 Link: User Mode Process Dumper APDIAG Performance Monitor Templates (Performance Monitor) Trace Configuration Editor..\Siemens\WinCC\utools\apdiag.exe..\Windows\system32\perfmon.exe "DiagAllCountersClient.htm" "DiagAllCountersServer.htm" "CPUPeakCheck.htm"..\Program Files\ SIEMENS\Common\bin\ pcs7commontracecontrolx.exe SIMATIC Diagnostics Tool DVD SIMATIC PCS 7..\Additional_Products\SDT_ Version \ or Link: SIMATIC Diagnostics Tool 6 V 2.6 Entry ID: 48698507
1 Overview User rights and releases Hard disk space The user requires administrator rights on the target system for installation and setting up. At least 3 GB of memory are required on your hard disk for the diagnostics data. The storage path is defined as "D:\Siemens\Diagnostics". This storage path is used by the "User Mode Process" and "Windows Performance Monitor" tools and the "SIMATIC Diagnostics Tool". Limitation This diagnostics concept does not include a description of the Engineering tools PCS 7 and WinCC Basic knowledge of these topics is prerequisite. V 2.6, Entry ID:48698507 7
2 Configuration of Diagnostics To fulfill the requirements for comprehensive diagnostics it is recommended to make all the settings described in this chapter. 2.1 Dr. Watson Below we describe how to set "Dr. Watson" as the default debugger. Table 2-1 No. Procedure 1. Execute Start > Run... Enter DRwtsn32 -i and start the procedure with OK. 2. Again select Start > Run... and again enter DRwtsn32 and again start the procedure with OK. 3. Set the crash dump to Full. 8 V 2.6 Entry ID: 48698507
2.2 User Mode Process The instructions below are for installing and using the User Mode Process Dumper in WinCC and PCS 7. After activation, a memory dump of a process is made in the event of an error. Table 2-2 No. Procedure 1. Download the User Mode Process Dumper version V8.1 from the Microsoft internet site and install the user dump tool in "C:\kktools\userdump8.1". 2. Switch to the "C:\kktools\userdump8.1" directory. Start the "setup.exe" of the User Mode Process Dumper from the folder corresponding to your operating system (ia64, x64 or x86). In the next window you click the "Next" button. V 2.6, Entry ID:48698507 9
3. In the "Terminate Mode" window you select the option "Disable "Dump on Process Termination" feature" and confirm with the "Next" button. 4. Now, in the "Confirmation" window you click the "Finish" button to complete the installation. 5. Acknowledge the next message with "Yes" to open the configuration of the "User Mode Process Dumper". 10 V 2.6 Entry ID: 48698507
6. In the "User Mode Process Dumper Properties" window you open the default rules and requirements window with the "Default Settings " button. V 2.6, Entry ID:48698507 11
7. In the "Default Exception Rules" window you set the rules as shown in the screenshot below and define the storage path of the dump as "D:\Siemens\Diagnose\Dumps". It might be necessary to create a new directory. Close the window with "OK". Note: These settings are used for all processes in which no "Custom Rules" are activated. The "dump files" are acquired by the "SIMATIC Diagnose Tool" from this predefined storage path. 12 V 2.6 Entry ID: 48698507
8. In the "User Mode Process Dumper Properties" window you use the "New" button to add a new item. 9. In the "Add Application to Monitor for Excepti " window you enter the process name of the application in Table 2-3 respectively 2-4 that you wish to monitor in the Application name: field. Close the window with OK. 10. Continue likewise with all the processes listed in Table 2-3 respectively 2-4. Here, a difference is made as to whether the configuration is made on the OS server or OS client. 11. Once you have defined all the processes, you quite the User Mode Process Dumper with OK. 12. You must restart the process concerned in each case for the settings to become effective. For this you restart the PC. V 2.6, Entry ID:48698507 13
2.2.1 Processes to be monitored When selecting the processes, a difference is made between OS server and OS client. OS server With the OS server you add the following processes to the User Dump Tool. Table 2-3 Process CCAgent.exe CCAlgRtServer.exe CCArchiveManager.exe CCDeltaLoader.exe CCEClient.exe CCEServer.exe CCLicenseService.exe CCProjectMgr.exe CCPtmRTServer.exe CCRtsLoader.exe CCSsmRTServer.exe CCTextServer.exe CCTlgServer.exe CCWriteArchiveServer.exe Gscrt.exe PdlRt.exe Rebootx.exe RedundancyControl.exe RedundancyState.exe script.exe Description Monitors the network in which the WinCC station is located. Used by NetCC. WinCC Alarm Logging Runtime Server WinCC Archive Manager Logs the changes made in a project. Central communication. Central communication. License monitoring Project Manager Picture Tree Manager Loader for WinCC Data Manager Base data management for Runtime Text Server WinCC Tag Logging Runtime Server Archive Server called at least three times for ALG, TLG fast and TLG2 slow archiving. Global Script - Runtime Graphics - Runtime PCS7 Reboot Box WinCC Redundancy Control WinCC Redundancy State Background processing of actions / functions WARNING In the case of blocking, manual dumps of the processes PdlRt.exe and script.exe must be made before restarting the computer. More information on generating manual dumps is available in our Entry ID: http://support.automation.siemens.com/ww/view/en/45020870 14 V 2.6 Entry ID: 48698507
OS client With the OS server you add the following processes to the User Dump Tool. Table 2-4 Process CCDmIVarProxyServer.exe CCEClient.exe CCEServer.exe CCNSInfo2Provider.exe CCPtmRTServer.exe CCSsmRTServer.exe gscrt.exe PassDBRT.exe PdlRt.exe RedundancyState.exe script.exe SFCRT.exe Sopcsrvrwincc.exe Description Ivar2 Proxy data manager access Central communication. Central communication. Picture Tree Manager Base data management for Runtime Global Script - Runtime User Administrator - Runtime Graphics - Runtime WinCC Redundancy State Background processing of actions / functions Visualization of SFCs SIMATIC OPC Server WARNING In the case of blocking, manual dumps of the processes PdlRt.exe and script.exe must be made before restarting the computer. More information on generating manual dumps is available in our Entry ID: http://support.automation.siemens.com/ww/view/en/45020870 Note Using the User Mode Process described does not affect the normal operation of the software and hardware. However, when using a dump event, might lead to temporary loss of performance and changes to the system timing. V 2.6, Entry ID:48698507 15
2.3 Script Diagnostics (APDIAG) The instructions below are for installing and using ApDiag.exe in WinCC and PCS 7. After activation, in the event of an error the diagnostics data is stored in a file via a default function of WinCC. Table 2-5 No. Procedure 1. Open Apdiag.exe in the..\siemens\wincc\utools folder. 2. In the menu bar click Diagnostics, and then in the drop-down menu click Start. Enable the option Start automatically with start of WinCC and then select LEVEL_3. In this way diagnostics is started each time you open a project. Close the window with OK. 16 V 2.6 Entry ID: 48698507
3. In the menu bar you click Diagnostics, and then in the drop-down menu click OnFile. Make the settings as below. With the OnErrorExecute -> Error in File parameter you set that the output of an OnErrorExecute is made in the OnErrorN.txt file in the..\siemens\wincc\diagnose directory. Close the window with OK. V 2.6, Entry ID:48698507 17
2.4 Windows Performance Monitor The instructions below are for installing and using the Performance Monitor in WinCC and PCS 7. After activation, a performance log is stored continuously. Here, the storage, handle and CPU time of the performance indicators defined in the templates DiagAllCountersClient.htm and DiagAllCountersServer.htm are used. The incorporation of the CPUPeakCheck.htm template generates an event entry when the CPU load of 95% is exceeded. Table 2-6 No. Action Remark 1. Start the Performance Monitor with Start > Run. Enter perfmon and start the procedure with OK. 2. Open the menu item New Log Settings From in the Counter Logs submenu. 3. Use the appropriate templates (*.htm files) for the log settings in Table 1-2. 18 V 2.6 Entry ID: 48698507
No. Action Remark 4. Select the profile concerned from the prepared templates in accordance with the type of computer. DiagAllCountersClient.htm for a WinCC client. DiagAllCountersServer.htm for a WinCC server. Close the dialog box with Open. 5. Accept the specified name for the setting. DiagAllCountersServer DiagAllCountersClient Confirm the entry with OK. V 2.6, Entry ID:48698507 19
No. Action Remark 6. The import makes the basic settings below. Storage path for the log file: D:\Siemens\Diagnostics\DiagAllCountersServ ermmddmmhh.blg Tab: General The log files are acquired by the SIMATIC Diagnose Tool from this predefined storage path. 20 V 2.6 Entry ID: 48698507
No. Action Remark Tab: Log Files 7. In the Configure Log Files dialog the limit of the log files is set to 1024 MB. Click OK to close the settings. V 2.6, Entry ID:48698507 21
No. Action Remark 8. In the Schedule tab the Start log time is to be set in the past and the Stop log time is to be set in the future. Click OK to close the settings. 9. The performance log is started automatically. The icon changes to green. 22 V 2.6 Entry ID: 48698507
Event log entries How to parameterize the settings of an event log entry is described below. Table 2-7 No. Action Remark 1. Open the menu item New Alert Settings From in the Alerts submenu. 2. Open the menu item New Alert Settings From. 3. Accept the specified name for the setting. Use the template CPUPeakCheck.htm for the log settings in Table 1-2. CPUPeakCheck Confirm the entry with OK. V 2.6, Entry ID:48698507 23
No. Action Remark 4. Accept the settings with OK. 5. The alarm configuration starts automatically, the icon changes to green. The icon changes to green. 6. Close the Performance Monitor. 24 V 2.6 Entry ID: 48698507
WARNING The performance log and the alarm configuration are restarted automatically when the PC is restarted. A new log file is created. Note that this occupies additional hard disk space. You can delete log files that are no longer needed in D:\Siemens\Diagnostics. If you terminate the performance log or alarm configuration manually with the STOP button, the preset times for logging are set to Manual. Then you must the times again as in Table 2-6 No. 8, otherwise the logging is not restarted automatically. V 2.6, Entry ID:48698507 25
2.5 SIMATIC Batch Trace The instructions below are for installing and using SIMATIC Batch Trace in WinCC and PCS 7 with the SIMATIC Batch option. Depending on the installation, the Trace Configuration Editor is in one of the program paths below...\program Files\CommonFiles\SIEMENS\bin..\Program Files\SIEMENS\Common\bin Table 2-8 No. Action Remark 1. In the Windows Explorer double-click pcs7commontracecontrolx.exe to start the Trace Configuration Editor. The Trace Control Panel opens. 26 V 2.6 Entry ID: 48698507
No. Action Remark 2. Activate Enable Log and click Switches. The Trace Configuration Editor opens. 3. Select the API Batch Api item >> right-click >> Modify Selection (recursive). Now the Trace Source Settings box opens. V 2.6, Entry ID:48698507 27
No. Action Remark 4. Activate the option Enable, E, W, I, C, D. Close the dialog with OK. 5. Save the settings in the Trace Configurator with Store. Acknowledge the message with OK. 28 V 2.6 Entry ID: 48698507
No. Action Remark 6. Close the Trace Control Panel with OK. 7. V 2.6, Entry ID:48698507 29
3 Tools 3 Tools 3.1 SIMATIC Diagnostics Tool The SIMATIC Diagnostics Tool presented here is to be stored on the PC and so that it can be activated as required. The latest versions and configuration instructions are available here: http://support.automation.siemens.com/ww/view/en/65976201 30 V 2.6 Entry ID: 48698507
3 Tools 3.2 Windows Problem Steps Recorder (PSR) WARNING Only the clicks you have made are recorded. If you make essential inputs during the recording, you must add these via the Comments function. This Windows function is supported by Windows 7 onwards. 3.2.1 Start the Windows Problem Steps Recorder Table 3-1 No. Procedure 1. Click the "Start" button and enter "psr" in the Search Bar. 2. Click "psr.exe" in the list of results. The "Windows Problem Steps Recorder" opens. V 2.6, Entry ID:48698507 31
3 Tools 3.2.2 Make recordings Table 3-2 No. 1. Click "Start Record". Procedure 2. Perform the steps which you want to record. You can use "Pause Record" at any time to stop the recording and "Resume Record" to complete the recording later. 3. Additional information about recording inputs: Click "Add Comment". Mark the area in which you are making the input. Describe your procedure in the Comment field. Click "OK and continue your recording. 4. Click "Stop Record" when your recording is complete. The "Save as" dialog opens. 5. Select the directory and a name. 6. Click "Save" to save the recording. 32 V 2.6 Entry ID: 48698507
4 Archiving the Diagnostics 4 Archiving the Diagnostics 4.1 Acquisition of Local Diagnostics Data Below we describe how to use the SIMATIC Diagnostics Tool to acquire data. Data acquisition can be done locally on a single system. Table 4-1 No. Procedure 1. Start the SIMATIC Diagnostics Tool by double-clicking SimaticDiagnosticsTool.exe in..\program Files\Siemens\WinCC\uTools\SDT_2010_1 2. Use the Open File button to download the configuration created in Chapter 3. 3. Click the Get Information button to start acquiring all the configured data. The acquisition procedure starts and the status is displayed. V 2.6, Entry ID:48698507 33
4 Archiving the Diagnostics No. Procedure 4. The message below indicates that the acquisition procedure has been completed successfully. 5. The data packets are located in the storage path D:\Siemens\. 34 V 2.6 Entry ID: 48698507
5 Literature 5 Literature 5.1 Bibliography This list is by no means complete and is only a selection of relevant literature. Table Error! Use the Home tab to apply Überschrift 1 to the text that you want to appear here.-1 Subject area /1/ PCS 7 Diagnostics /2/ 5.2 Internet Links Title SIMATIC Process Control System PCS 7 V7.0 PCS 7 Service Support and Diagnostics This list is by no means complete and is only a selection of relevant information. Table Error! Use the Home tab to apply Überschrift 1 to the text that you want to appear here.-2 Subject area \1\ Reference to entry \2\ Siemens Customer Support \3\ SIMATIC Diagnostics Tool Title http://support.automation.siemens.com/ww/view/en/22089969 http://support.automation.siemens.com/ww/view/en/23486418 http://support.automation.siemens.com http://support.automation.siemens.com/ww/view/en/44029135 V 2.6, Entry ID:48698507 35
6 History 6 History 6.1 Version Overview Table Error! Use the Home tab to apply Überschrift 1 to the text that you want to appear here.-1 Version Date Change V2.0 07.12.2010 Second edition V2.1 19.01.2011 Maintenance in compliance with system test V2.2 28.01.2011 Inclusion of review comments V2.3 01.02.2011 Section 2.2.1 changed V2.4 01.04.2011 Redundancy Control removed V2.5 15.04.2011 Chapter 2.2.1 added with link on entry 45020870 V2.5.1 25.05.2011 English screenshots added.net component deselected for the SIMATIC Diagnose Tool xml profiles changed V2.6 12.06.2014 Security Note added New chapter about Windows Problem Step Recorder Content on SIMATIC Diagnostics Tool updated 36 V 2.6 Entry ID: 48698507