Generating Documentation

Capital E/E Publisher enables the generation of standalone documentation packages.

Packages are self-contained folders that can be transferred between users for viewing without the need to install a Capital software application.

Capital E/E Publisher provides an application viewing platform for each package type to enable the viewing of the generated documentation packages.

When created, a package can contain the application files needed to run the viewing platform application, or a package can contain documentation data only, to reduce memory overhead and packaging time. A data only package can be viewed by a separately created viewing platform application for that package type.

Figure 15: Documentation Packages and Viewing Application Relationship

Data only packages are made accessible to a viewing application platform through the use of a Package Manager Application. The Package Manager Application lists documentation packages in a table style format, and provides functions to add new data repository locations for the inclusion of new data only packages, as well as editing, deleting or moving existing packages.

When you generate a documentation package, an interface appears, where you define the following items:

• Package name.

• Output directory, or Data Repository for a package.

• External resources

• The location of the folder containing external resources to include with the documentation.

            Note 
                When creating HTML files for Capital Publisher's resources
                    files, it is advisable to utilize utf-8 encoding to prevent any
                    display problems with specific characters when viewing them in the Service
                    Explorer package.
  

• Decide whether to include the application viewer executable for this package or not. Packages can be data only, to reduce memory footprint and packaging time. Packages can be opened with any previously generated viewer application for that package type.

• Scope for the harness designs, including derivatives, wiring designs or logic designs to be included in the package.

            Note 
                When defining a Scope for packagers that support linking between Logic and
                    Harness designs, E/E Publisher will look for matching UID's first and fall
                    back to the Name attribute if a match is not found.
  
                You MUST ensure proper synchronization between your
                    Logic and Harness designs before generating Publisher packages.
  

• Designs to be compared (Capital Change Explorer only.)

• Artifacts needed, for example, Lean SVG (Scalar Vector Graphics) diagrams, embedded reports, and links to 2D Location views, or 3D XML.

• Use the Configuration tab to add any pre-built vehicle configuration. This provides automatic design filtering.

• Use the Effectivity tab to choose from pre-calculated ranges or view ones that are automatically inferred by the system. This can also provide automatic design filtering. The Effectivity functionality only becomes available if the project allows effectivity (via Project Preferences project preferences.)

• Decide whether to run the package generation task in the background using the Capital Integration Server and the flexible execution model.

Procedure

1. Open a Project that you want to create documentation for.

2. Open the Publish dialog either by. Pressing Space Bar and enter Publish. then click the Publish button.

Right-click on a Build List in the Project Browser Window, and select Generate Documentation.

3. Select a package output format from the Packager drop down list. There are a number of package types available:CGM Packager - generates interactive CGM diagrams for each wiring diagram in the scope.

Capital Design Explorer - produces a licensed executable file that spawns a self-contained viewer enabling the display of, and interaction with the generated documentation for internal viewing.

Capital Service Explorer - produces a web browser based application for viewing and interacting with the generated documentation. This package is also supported on a Windows tablet device.

Mobile Packager - produces a package for viewing, and interacting with, on an Apple iPad® running iOS7 and later.

Capital Change Explorer - enables the production of harness, logical and wiring design comparison packages which include both comparison reports and graphical annotations for changes on the old and new diagrams. Results can be immediately viewed, or hosted centrally, and then linked in order to view the package from anywhere over a network.

PDF Packager - generates a PDF Package that includes wiring diagrams in a selected scope, and additional documentation such as 2D location views, connector face views, embedded reports and harness diagrams.

Smart Flow Packager - produces a web browser based package for viewing and interacting with the generated work flow documentation.

S1000D Packager - generates documentation packages that conform to the S1000D standards. The generated package includes CGM diagrams for each of the wiring schematics and XML files for each system that contains the wiring information. Note Any packages created through extensibility will also appear in the list for selection.

4. Enter a name for the relevant output package in the Package Name field. This will default to the open Project name but can be overwritten. Add a Package Description if required.

5. Specify a Package Thumbnail - the full size image of which will appear on the front of the published package. Click the ellipsis (...) to open the folder containing the required image.

6. Enter the location to export the generated package to in the Export To field. Alternatively, click on the ellipses (...) to navigate to the required location.Note Before generating a data package, selectable Export To locations can be predefined for selection. These locations, or data repositories, can be configured for each packager type (Capital Design Explorer, Capital Change Explorer, Capital Service Explorer & Smart Flow). Open the XML file present in the \publisher\server-config location of your Capital installation for your package type, uncomment the tag and set the absolute path. Multiple data repository locations are also supported. Only zipped data packages from the external data repository will be loaded in Capital E/E Publisher.

Tip Packages can be set to generate to either local or network drives. If a network drive is selected there may be an increase in generation time caused by the system zipping and unzipping files over a network connection. To minimize any disruption when generating packages to a network location you can set the true flag to true in the \publisher\config.xml file. This will generate a temporary copy of the package locally before moving it to your desired network location.

7. Enter the location of the folder containing any external resource files you want to include with the output package into the Resources text box, or click on the ellipses (...) to navigate to the folder. The folder can contain any supporting collateral required to appear alongside the generated content from Capital E/E Publisher, together with artifacts such as 3DXML, and 2D Location diagrams (which can be linked directly with objects in the wiring diagram).

8. Select a style set, from the Style Set drop down list.

9. Alternatively if you only wish to update the diagram border symbol during publishing, the Border button enables you apply a different border symbol to your selected diagram. You may also specify that no border be applied, or confirm that the existing border be used. For further information see Changing a Diagram Border During Publishing.
   Note Change border functionality is not available for Capital Change Explorer. The use of the Border button is mutually exclusive to the Style Set drop-down menu. If you select any style set then it becomes grayed out and is not available for selection.

10. If you want to include the package viewer executable in this package, select the Application Files option in the Includes plane.Figure 16: Setting to Include Application Files in Documentation Package
    Note If you choose not to include a package viewer executable, your package will only contain data. See the Package Manager Application for more details on managing and viewing data only packages.

11. (For all packages except Capital Change Explorer.) Select the designs and diagrams to be included in the package by checking the required boxes in from the tree view in the Scope panel on the General tab. The tree shows all relevant designs together with any harness or logic build lists within the current project. Selecting the build list includes all build list designs within the selected scope.Note Write access to certain designs or build lists maybe unavailable due to domain restrictions. If this is the case a message is displayed. If you require access then please contact your system administrator. For further information on access restrictions due to Domain settings see Domains in the Capital Access Manager user guide.

Tip The filter at the bottom of the panel allows you to filter between Show all designs and Show all designs (No active build list).

Note Opening the Generate Documentation dialog from a build list automatically selects the designs and diagrams from that build list to be used as the scope.

12. Select the required artifacts to be generated for the package from the list on the Includes panel on the General tab. Each artifact produces a different set of outputs for each design. See Available Artifacts for a full list of the standard available artifacts. The list includes any embedded reports, such as the Wire List or Component BOM.Note All artifacts are configurable, so you can control content such as table columns for the netlists and style sets for the diagrams. By default, each artifact is produced on a per design basis.

13. Select any required Configurations on the Configuration tab by moving them from the Available list, to the Selected list.

14. Select any required Effectivity ranges on the Effectivity tab by moving them from the Available list, to the Selected list. Only the data belonging to the selected ranges/effectivities will be added into the package. See “Effectivity Aware Capital Service Explorers”. (Capital Service Explorer and Capital Design Explorer only)Note If a Dynamic build list(s) is selected then effectivity is inferred. In this scenario read-only effectivity values (not ranges) are stated in both 'start' and 'end' fields.

15. When the Capital Change Explorer package is selected, the Comparison panel is displayed. Select the old and new designs that you wish to compare.Tip The filter at the bottom of each pane allows you to filter between Show all designs, Show all designs (No active build list), Show only Logic designs or Show only Harness designs.

16. Select the Reports to be included in the package from the Includes pane. These vary depending on whether you are comparing a harness, a logical or a wiring design, as displayed in Figure 17. Artifacts available for comparison could include Bundles, Electrical Components, Modules and so on. The report content is fully configurable, see Configuring the Comparison Engine for further details on how to add or remove artifacts for comparison. If the designs to be compared have more than one diagram, then the Diagrams button is displayed in the browser to allow you to navigate between them. Links will automatically open the correct target diagram.Figure 17: Available Artifacts for Different Design Types

17. If you wish to generate the package immediately click Create Package to generate the documentation package.

18. For large packages, or ones that need to be produced frequently you may decide to schedule a regular automated task utilizing FEM (Flexible Execution Model) by selecting the Run in the Backgound checkbox. If this is not selected, the package generation task will run locally. If it is selected, the tasks are sent to a Capital Integration Server to be run in the background. See both Background Package Generation Using FEM and the “Running Capital Tasks in the Background” section of the Capital Design Tools - Common Functions User Guide for further information.Note: “Run in the Backgound” is only displayed at the bottom of the dialog only if a Capital Integration Server web service is configured in the clientprops.xml file of your installation.

Results

The new documentation package generates, and is exported to the location specified in the Export To text box. The package is now viewable in the appropriate browsing medium.

Parent Topic:

Generating Documentation in Capital E/E Publisher

Capital E/E Publisher User Guide, 2512.2606

Unpublished work. © 2026 Siemens