EMS NG TROUBLESHOOTING CHECKER TOOL
Contents
EMS NG Troubleshooting Checker Tool Setup
Using the EMS NG Troubleshooting Checker Software
EMS NG Troubleshooting Checker
Manually updating the config.inc file
Running the EMS NG Troubleshooting Checker Software from a Command Line
This software package contains the following items and licenses:
The license files are included at the top level of this directory for reference.
The source files for Wapache can be obtained from the website http://sourceforge.net/projects/wapache/.
The source files and Wapache distribution can be obtained from http://emsng.vdl5tech.com/.
There is NO WARRANTY for this software, it is released as is. For information on support for this tool, please contact VDL-5 Technologies at harpstert@vdl5tech.com.
The EMS NG Troubleshooting Checker Tool is designed to check troubleshooting files and find errors in the links and steps within the troubleshooting track. It also can generate a report of a simplified version of the troubleshooting track. This report can be used to trace the logic flow during the development, validation, and verification processes.
These are the minimal requirements for running this software.
The following are instructions on how to install the software once the files have been extracted from the ZIP file and how to use the EMS NG Troubleshooting Checker Tool.
1. Unzip files using any available unzipping program. It does not matter in which directory the unzipped files are stored.
2. In the directory that you just created by unzipping the file, find the “emsng_ts_checker” shortcut. Right click on the short cut and select 'Properties' (see Figure 1).
Figure 1 Change EMGNS Troubleshooting Checker Shortcut
NOTE
Step 1 may not be required. In some cases, the system will automatically set these destinations. You should check to ensure that these are set properly or set them yourself using step 1.
1. In the text box next to 'Target:' (see Figure 2) change "C:\IETM\install_version\emsng_ts_checker\bin\Wapache.exe" to "Your install directory\ emsng_ts_checker \bin\Wapache.exe" where “Your Install Directory” is the location where you unzipped the file. (Example: if you unzipped the file in the C:\My IETM Tools\ you would change the path to read "C:\My IETM Tools\ emsng_ts_checker \bin\Wapache.exe".) In the text box next to the "Start in:" change the path "C:\IETM\install_version\ emsng_ts_checker \bin" to "Your install directory\ emsng_ts_checker \bin"
Figure 2 emsng_ts_checker Shortcut Properties
2. Once you have updated the Target and Start in paths (or insured they are correct), click on the OK button to save the changes and close the window.
3. Create a short cut on your desktop for easier clean up tool access.
1. Double click on the “emsng_ts_checker” short cut to start the EMS NG Troubleshooting Checker Tool. You will see a screen as shown in Figure 3 Install Wizard Start Screen. This initial screen is used to select the directory where your IETMs files are stored and where to store the temporary files.[1] This is the directory where your working EMS NG IETM files resides. There will be a list of the directories that are found on your current C: drive. Find the folder which contains your working IETM’s and click on the folder. The folder name should be displayed next to “Current IETM Directory:”.
Figure 3 Install Wizard Start Screen
2. Once the directory has been selected, scroll down to the bottom of the page and click on the Next > button (Figure 4). The next window will display a list of the directories that are found in the folder you selected for the IETM directory.
Figure 4 Next Button at Bottom of Select Directory Screen
3. The next screen (Figure 5) shows the directories and a name to use for identifying the IETMs associated with the directory. The default name in the text box is the directory name. If you would like a different name for the IETM type the new name into the text box.
Figure 5 Initial Select IETM Screen
4. Figure 6 shows three IETM directories that are present in the folder and alternate text names entered for the IETM directories. Once all the IETM’s you want are selected (HMMEEI_IETM and Sample_IETM are shown selected in the figure) and the text name is updated, click on the Next > button.
Figure 6 Select IETM Screen W/IETM’s Selected
5. The next window (Figure 7) displays a summary of the selections you have made. Once you review your choices, you have two links to choose from:
a. “Click here to change shown above configuration settings.” - This option restarts the install wizard while saving your directory settings. Click on this link to change the settings shown. The next window will be displayed. Once the configuration matches what you want, perform step 5b.
b. “Click here to create configuration file.” – By clicking this link, a configuration file will be created and saved with your selections. Once selected, a new window will appear and will confirm once the configuration file is created.
Figure 7 Final Install Wizard Screen
6. Once step 5.b has been performed, the software will create a config.inc file and the window will change (see Figure 8). Click on the Click here to use start Clean Up Tool. button to start using the EMS NG Troubleshooting Checker Tool[2].
Figure 8 Configuration File Created.
Figure 9 EMS NG Troubleshooting Checker Tool Startup Screen
Once the software is set up, clicking on the emsng_ts_checker icon will start the software and show the IETM directories you have configured for clean up by the software. The following section gives an explanation of how to use the software.
Figure 10 EMS NG Troubleshooting Checker Start Screen
Figure 11 Start Screen with Selections Made
Figure 12 EMS NG Select Files to Check Screen
i. the wpno attribute will be compared against the file name for a match
ii. links to testwithstate blocks will be checked
iii. and the variables and links for each testwithstate block will be checked for matches.
Figure 13 EMS NG Select Files to Check Screen with Files Selected
Note: The EMS NG Troubleshooting Checker tool is designed to only check for errors in troubleshooting files that start with the <diagwp> tag. The troubleshooting directory may include XML files for the operators troubleshooting that do not contain this tag. These files are still listed in the directory and can be selected for check. If selected the checker will report a warning for the file that it does not appear to be a legitimate TS file.
Note: After selecting the Check Files button the software will start processing the files. If there are a large number of files it may be several seconds or minutes before the next screen is displayed. For a very large number of XML files or low RAM on the system the software may time out and not be able to process all of the files.
Figure 14 Results of Check Screen, 1 of 3
Figure 14 shows the top part of the report. There are links to click to recheck the current set of files, check other files or check files in another IETM. The “Click to check the same files” option should be used when the author has made corrections in the TS track and wants to verify the corrections.
Below the links for file checking there are links for the files that are included in the report. This allows the author to jump to another section of the report while doing a check. In this case only one file was checked so only one link is displayed, “T01C0E0020”.
The next section is that start of the report for this track. The name of the track is given and the results of the wpno and file name check. In this case, the both values matched. The next item is the display of test parameters from the file that can be used for a file check.
The next section is the start of the check for links to all of the testwithstate blocks within the file. In this case, a link was found to a testwithstate and the testwithstate id was also found within the file, “found testwithstate id match for TP02”.
Figure 15 Results of Check Screen, 2 of 3
Figure 15 shows the middle section of the report. The top portion of the report shows the link checks. The three shown had no linking errors.
The next section shows the check of variables and links within each testwithstate block. At this time all EMS NG troubleshooting tracks will show a warning for the very first testwithstate block within a track. In this case, the error was on TP01. Since the first testwithstate block is activated by linking to it from the menu, there are no internal links that can be found by the checker. The error message can also be displayed for testwithstate blocks that are not the first block but for which no links were found within the track.
The next section shows the check of the variables for the testwithstate blocks. In this case, in the testwithstate TP01 block a variable and variable ref do not match. The “:” is used to mark the ends of each string id for the variable and variableref. In this case, the mismatch is caused by an extra space in the variable reference. Removing the space will correct the problem.
Figure 16 Results of Check Screen, 3 of 3
Figure 16 shows the bottom portion of the report. In this instance, two of the variable and variableref pairs have errors. In one case, the text “PASSED” and “PASS” do not match (one has an “ED” at the end). In the other case, “fail_01” and “FAIL_01” do not match (one is lower case and the other is upper case). For TP98, TP99 and TP100, no errors were found in the check of variables and finding a link to the block.
Figure 17 Results Check with Errors Corrected Screen
Figure 18 Generate Track Flow Report Option
Figure 19 Select Files for Report Screen
Note: The EMS NG Generate Track Flow Report tool is designed to generate reports for troubleshooting files that start with the <diagwp> tag. The troubleshooting directory may include XML files for the operators troubleshooting that do not contain this tag. These files are still listed in the directory and can be selected for check. If selected, the checker will report a warning for the file that it does not appear to be a legitimate TS file.
Note: After selecting the Generate Report button, the software will start processing the files. If there are a large number of files, it may be several seconds or minutes before the next screen is displayed. For a very large number of XML files or low RAM on the system the software may time out and not be able to process all of the files.
Figure 20 Report Results, 1 of 3
Figure 20 shows the top part of the report. Links are displayed that allow the author to check the same file again, select other files for reports, or select files within another IETM for a report.
The next portion is the start of the report. Links are displayed for each of the selected files. The links can be clicked to move that portion of the report. In this example, only one file was selected for a report, T01C0E0020.
The next section displays the title of the track and the file name. The testwithstate block ID is displayed along with the question and the choices displayed on the page. The choices correspond to buttons, checkboxes, and other menu items displayed at the bottom of an EMS NG viewer page for troubleshooting. The choices are displayed in blue and display the text that would be seen in the viewer.
Figure 21 Report Results, 2 of 3
Figure 21 shows the detail for the menu choices that would appear in the EMS NG viewer. The green section displays the actions that will occur if the blue option is selected. In this example, if the “Code Active” option is selected the EMS NG viewer will go to the testwithstate block TP02. If the “Code Inactive” option is selected the EMS NG viewer will go to the TP98 testwithstate block. The text for the selected option is displayed along with the link target.
Figure 22 Report Results, 3 of 3
Figure 22 shows the next testwithstate block, TP02. In this block, the choices are “Connections OK” and “Connection(s) Faulty”. If the option “Connections OK” is selected, the EMS NG viewer will go to a maintenance track for ECM and Support Plate and Bracket Replacement. While in that track, the text “Replace engine control module (ECM).” will be displayed in the green bar that appears above the maintenance WP in the EMS NG viewer. When the user completes the maintenance and clicks on the “Next” link, they will be returned to the testwithstate block TP98 to check their fix.
If the option “Connection(s) Faulty” is selected, the maintenance WP for ECM Harness Replacement will be brought up in the EMS NG viewer. The Green Bar will display the text “Verify that the crankshaft sensor and camshaft sensor connectors are tight and not reversed.” When the “Next” link is selected, the EMS NG viewer will go to the testwithstate block TP98 that guides the check of the maintenance.
The report can be printed by right clicking in the window and selecting “Print…” as shown in Figure 23 Print Report.
Figure 23 Print Report
For those users who are comfortable with modifying source code, this section provides information on modifying the basic configuration of the EMS NG XML Clean Up software.
CAUTION: Modifying the software may cause it not to work as described in this help file. The software is provided as is. There is support available for correcting problems introduced by modifying files. There is no warranty provided for the software. Do so at your own risk and after backing up any files you try to clean up. If you make changes that cause the software to not work, it is recommended that you reload the software.
The config.inc file is a PHP file that can be edited in Notepad or another text editor. Modifying the file created by the setup procedure may be easier than rerunning the install wizard if new IETMs are added. However, if there are problems in using the config.inc file, the config.inc file can be deleted and re-created by running the install wizard in the software.
The config.inc file contains the following items.
The EMS NG Tropubleshooting Checker software was originally built to run from a command line. The framework for this structure still exists but has not been tested or used recently. For those wishing to dive into the PHP the structure does exist. There is one file that could be checked out for command line use. It is convert.php and it is the file that reads in the search and replace strings and performs the XML clean up. The file check_ts.bat contains an example for calling this file from the command line. If you are interested in using the software with at the command line, you will need to have PHP 5.2 installed on your system and you will need to be comfortable with modifying PHP code.
There are also some additional PHP scripts that can be used to pull data or generate reports from troubleshooting or other EMS NG XML files
[1] Currently, IETM files can only be read from the C: drive using the default installation of the software. If you are using network drives to store your IETM files, the drive can be changed in the install.php file. Find this line at the top of install.php, “$defaultDrive = "C:";” and change the “C:” to the drive letter your IETM is installed on. If the software is running, stop and restart it. You should now see that the drive letter has changed for the IETM and temporary directory.
[2] Open the ***\emsng_ts_checker\htdocs folder and find the “config.inc” file.
1. Select the file and delete it or rename it if you wish to save the settings to use later
2. Go to the CLEAN UP TOOL SETUP section about and repeat the above process to re-create the config.inc file
CAUTION: – Deleting the config.inc file will cause the install wizard to restart and you will have to re-create your settings. Only delete the config.inc file after setup if you are sure you wish to change your directory and IETM name settings.
CAUTION: The config.inc file is text and can be modified in Notepad or other text editors. This should be attempted only by users comfortable with modifying PHP source code. If the file is unreadable the software will not work.