Generating Documentation in Capital E/E Publisher > Diagnostic Procedures

Creating Diagnostic Procedures

The Publisher Configuration Editor enables you to author diagnostic processes including fault finding procedures, required actions and expected results. It also allows you to set interactive links for diagnostic navigation within Capital Service Explorer packages.

You can also organize service and diagnostic procedures hierarchically into folders and sub-folders, for example by ECU types. This reduces visual complexity for service technicians, particularly where a procedure may differ according to the specific ECU vendor.

Procedure

Open the Publisher Configuration Editor dialog box: Pressing Space Bar and enter Diagnostics. then click the Diagnostics button.

Select Automate

Diagnostics.

Click the plus button () in the Diagnostic Panel to create a new Diagnostic procedure. The number of available procedures is shown in the top right hand side of this panel. You can delete obsolete procedure by clicking the minus button ().
If required, define a folder path for the diagnostic procedures by specifying a Folder name. If sub-folders are required use a delimiter (default character is “\”) to define the hierarchy of the folder path.You can change the delimiter character to one of your choosing by editing the <diagnostic-hierarchy-level-delimiter value=”\” in the \publisher\config.xml file. Tip You can display diagnostic procedures in a tree view, using the folder structure specified by setting the <showDiagnosticsAsTree value=”true” in the \publisher\config.xml file.
Add a Diagnostic Trouble Code in the Name field and a relevant description, if required. Both fields are editable free text.
Create diagnostic procedures for your technician to follow in the Diagnostic Steps panel by clicking the plus button (). Additional steps are added in the same manner. Give each step an appropriate description by editing the free text description field.Tip Clicking the plus button () adds a new step to your procedure. The minus button () enables you to remove a step. The up and down arrows () and () allow you to change the position of the step within the sequence. This functionality is also applicable in the Details and Decisions panels below.
In the Details panel add Instructions to be followed by the service technician. Each procedure can contain multiple actions for the technician to follow. You can specify whether these are actions or explanatory notes by clicking in the Type box and selecting the required option.
In the decisions panel specify the expected result. If further action is required following the result click in the Go To field and select a diagnostic sequence to follow by selecting from the available options. Note The Go To field is linked to the procedure. Any changes to the order of the procedures will automatically update the goto sequence number.
Click the Save button () to save the procedure.Tip Adding procedure, action, component or object names in square brackets, for example [battery], automatically creates links within the Capital E/E Publisher package. You can add an external link to Diagnostics procedures by adding snippets such as: <a href=" target="_blank">Go To Siemens site

Results

The diagnostic procedure can be selected as an artifact for inclusion during package generation for the Capital Service Explorer and Capital Design Explorer. The resultant files are then viewable when accessed in a web browser.

Parent Topic:

Diagnostic Procedures