CapitalKnowledge

Generating Documentation in Capital E/E Publisher > Packagers

Capital Design Explorer

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. Various artifacts are available as standard with Capital Design Explorer.

Note

Capital Design Explorer requires a valid license to enable its functionality. Contact Siemens Customer Support to obtain this license.

Restriction

For Capital X deployments, Capital Design Explorer package generation is supported; however, running it in the environment is not. To run Capital Design Explorer, you must export the package to a system where the license is hosted on Capital License Server.

  • 2D Location Views

  • Assembly BOM - Report

  • Attributes and Properties

  • CATIA 3D Models

  • Component BOM - Report

  • Cross References

  • Diagram Generation

  • Connector Views

  • Ground Report

  • Ground and Power Signal

  • Links

  • Multicore List - Report

  • Net List - Report

  • Project Level Wire Report Based on Harness Filtering

  • Lean SVG Diagrams

  • Wire List - Report

Configuring Capital Design Explorer

Package configuration only needs to be performed once after the Capital E/E Publisher installation. However, you can edit the configuration to change how your generated Capital Design Explorer package looks and operates.

You can configure various aspects of the Capital Design Explorer package, such as the attributes and properties, available languages, and the order and content of navigation sections and popovers. The publisher folder in the Capital installation directory contains the following editable files:

  • attributeList.xml

  • config.xml

  • NavigationPanel.xml

  • popup.xml

  • publisher_report.xsl

The following aspects of the Capital Design Explorer application are configurable:

  • Attributes and Properties

  • Language Support

  • Invoking Greyscale Printing in the CGM Packager

  • Configuring Ports for Capital Design Explorer

  • Navigation Panel Configuration

  • Popup Configuration

  • Hotspot Configuration

  • Reports Caution Capital Design Explorer configuration should only be performed by a system administrator or an experienced Web designer.

Attributes

and Properties

Each object within a design has its own set of attributes and properties. The Attributes and Properties artifact will export those values and make them available on selection of that object within Capital Design Explorer.

The set of attributes and properties to be included are specified in the attributeList.xml, located in the publisher folder in the Capital application installation directory. The attributeList.xml can be configured as follows:

Each attribute or property is made up of a triplet of text elements that define how it is identified on an object and how it is displayed to the user.

The tag refers to either an attribute or a property:

name='PartNumber' refers to the Part Number attribute on any object.

displayName='PartNumber' refers to the text that is displayed in Capital Design Explorer for that attribute.

Note

The class attribute for an object can be used with the API JavaDoc to identify the correct attribute names for any object. This list will be included in the appendix but can also be found with any install of a Capital application.

Language

Support

The i18n folder found in the publisher folder in the Capital installation directory, contains several resources.properties files. Each file contains all of the text that appears in the user interface of Capital Design Explorer. This can be used as the basis to provide support for different languages.

Each language can have its own copy of the file where the text is translated. Several language files are already provided and users can edit these directly or create their own from scratch. The correct file will be loaded by the application based upon the locale of the operating system from which it is invoked.

Configuring

Ports for Capital Design Explorer

Capital Design Explorer uses a port to start the application. The port is read from the following files:

  • Capital Design Explorer: \publisher\capital-explorer-runtime\app\config.xml

Copy

<explorer-config>
    <port-range start="8383" count="10"/>

<!-- Timeouts are declared in seconds. Minimum is 5s. -->
    <ping timeout="10"/>
    <idling timeout="600"/>
</explorer-config>

The configuration file specifies the range of ports, for example, the configuration above specifies a port range that starts from 8383 and ends at 8393 (start + count). Capital Design Explorer will try to acquire a port from this range.

It tries to start the application with the first port specified (8383 in the above example). If Capital Design Explorer fails to acquire the port, it moves on to next port in the range.

License

Consumption and Timeouts

Viewing a package in a web browser consumes a license. To avoid situations where sessions may not have been closed correctly— locking a license that may be required by another user—you can configure runtime timeouts. Edit the config.xml file contained in the publisher/capital-explorer-runtime\app folder to amend the relevant settings. The sets the maximum time limit (in seconds) allowed for communications between the server and browser, while the sets the limit on user interaction with the browser. In both cases, if no response is received within the specified limit, the session is automatically closed, and the license is released. Figure 23 shows a scenario where the is set to 25 seconds, while the is set for 600 seconds.

Figure 23: Example Timeout Configuration File

Invoking

Greyscale Printing in Capital Design Explorer

To invoke greyscale printing in the Capital Design Explorer packager, see Invoking Greyscale Printing.

Navigation Panel

Configuration

Use the NavigationPanel.xml file to configure how the content is displayed:

  • Order that the sections display.

  • Content displayed on the items within each section.

  • Tooltips.

The sections of the Navigation panel will appear in Capital Design Explorer in the order they appear in the file.

You can define up to four attributes (properties for objects) for each section, all will appear in the tooltip:

  • The first attribute is the primary text for objects within that section.

  • The second attribute is used as the subtext for all objects.

  • The third and fourth attributes will appear only in the tooltip.

All four attributes and properties are used in the Filter at the base of the panel to determine applicability.

If no attribute or property is defined for a section, the name is used as the default.

Note

If you define more than four attributes / properties, the system uses the first four it locates for any object.

Systems

and Harness Diagrams Display Configuration

Use the following parameters in the config.xml file to configure how designs are displayed on the List Panel.

Copy

<showSystemsAsTree value="false"/>
<showHarnessAsTree value="false"/>

Specify false to display a single list of designs, or true to display a folder tree that reflects the structure of the design browser in the Capital design applications, containing all the designs included in the open package. The default is false.

Note

Packages generated prior to the availability of the parameters will not display the folder trees on the List panel.

Figure 24: Example List Configurations

Popup

Configuration

Use the popup.xml file to configure the popup / popover windows that appear when you select any object within Capital Design Explorer.

Each object type has its own section that can be configured independently of the others.

You can open popups from reports, cavity chart tables, harnesses, and fault codes.

You can configure whether the sections in the popovers are expanded (true) or collapsed (false) by default, enabling a more flexible and efficient viewing of the package that requires fewer clicks to access information. Edit the config.xml file to set the flag as required, as shown below.

Hotspot Configuration

Clickable hotspots can be added to any 2D Location SVG. When you click on a hotspot you will be presented with a popup showing the links to systems diagrams.

Figure 25: Hotspot Example 1

On a connector face view, if a Connector Pin datum were provided per pin, the packager tool would generate an intelligent Lean SVG. Each datum would be a clickable hotspot displaying a popover with information including cross-references, and the ability to render the signal path for any wires that terminate at that connector pin. See also “Adding Datums” in the Capital Symbol Designer User Guide.

Figure 26: Connector Face example 1

Reports

The following reports are available to be included in Capital Design Explorer. The reports are in the default Capital format and can be additionally customized by amending the publisher_report.xsl stylesheet found in the publisher folder in the Capital installation directory.

  • Assembly BOM - Report

  • Component BOM - Report

  • Multicore List - Report

  • Net List - Report

  • Project Level Wire Report Based on Harness Filtering

  • Wire List - Report

Parent Topic:

Packagers

Capital E/E Publisher User Guide, 2512.2606

Unpublished work. © 2026 Siemens

Source: https://docs.sw.siemens.com/en-US/doc/861057055/202511026.capital_ep_user/id91e63c85-b52d-44ce-93e9-fd1070aafbb8 · retrieved 2026-07-18