Available Artifacts

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 will be produced on a per design basis.

The following artifacts are available:

• 2D Location Views

• JT 3D Model Viewer

• RapidAuthor 3D Catalog Model Viewer

• External Reports

• Assembly BOM - Report

• Attributes and Properties

• CATIA 3D Models

• CGM Diagrams

• Smart Flow Links and Content

• Links

• Diagram Generation

• Connector Views

• Fault Code Data Generator

• Information

• Multicore List - Report

• Net List - Report

• Lean SVG Diagrams

• Wire List - Report

• Ground Report

• Ground and Power Signal

• Troubleshooting with What’s In Common Note Any collateral within the introduction folder, of the external Resources folder of the Capital installation, will be automatically included in the package within the Information section of the Capital Service Explorer. This can include documents and supporting material in any format your web browser can understand including Word documents, PDF files, or additional HTML-based content.

2D Location Views

The TwoDviews sub-folder within the external Resources folder of the Capital installation can be populated with SVG diagrams. During package generation within Capital E/E Publisher, these SVG diagrams are scanned for references to Publisher design objects of types wires, backshells, connectors, ring terminals and devices. Any text within the SVG that matches to an Object name belonging to these types is automatically tagged, and then made available within the package.

To allow the exploitation of pre-existing PDF illustrations PDF documents that contain location information can also be added to the TwoDviews sub-folder within the external Resources folder alongside SVG files. Again automatic linking is provided, as well as standard PDF interactivity such as interrogate, navigate, pan, zoom, search and print. During package generation, the system searches the PDF text for any matching object names and automatically creates links to them.

These views appear on the navigation panel within the Capital Service Explorer, Capital Design Explorer, on a mobile tablet device, or in the PDF package, and can be opened directly from there. They are also available directly from the wiring diagram objects.

2D views are fully interactive, and support cross-highlighting. They can be used as a starting point to find an object on a wiring diagram.

Thumbnails

The SVG files can also be accompanied by a thumbnail image file. This file must use the same name as the SVG, with _thumb appended to the end of the filename. These thumbnails appear alongside the name of the 2D view in both the Navigation panel, and in the object pop‑overs within the HTML application.

Adding clickable hotspots and custom links

Links can be manually added to an existing 2D SVG file, by modifying the file to include a tag around a set of graphic elements. The 2D SVG file can be edited in any text editor.

The following tag can be added to any location within the SVG:

Copy

<hotspot>DEVICE_NAME</hotspot>

The text within the hotspot tag will be used as a data point during package generation to determine links to design objects.

See Figure 47. A hotspot link is added around the AUDIO UNIT component:

1. Open the SVG file in any text editor.

2. In the SVG, locate the correct shape; in Figure 47, this shape is a line.

3. Insert the hotspot link above this shape. Figure 47: Audio Unit hotspot text

The area on the SVG that becomes “active”' or selected will be determined by the tag defining the hotspot.

JT

3D Model Viewer

A 3D viewer for JT format is seamlessly integrated with Capital Service Explorer and Capital Design Explorer packages allowing for faster fault diagnoses using JT format 3D models. Also many MCAD products and converters are capable of exchanging models in the JT format. The integration requires no additional installation and works with all common web browsers. It enables two-way communication so you can highlight an object in your 3D model and navigate to other views such as Connector View, 2D Location View, Face View and so on. Additionally starting from one of these views you can easily navigate to view the 3d counterpart in the JT viewer.

Note

JT integration to Capital Service Explorer and Capital Design Explorer packages is available for Windows operating systems, iPads and also laptops and devices running MacOS.

To utilize the 3D JT viewer functionality create a JT folder at the top level of the Resources folder of your Capital installation, where you should store any JT models.

The JT mapping properties are set by right-clicking on a schematic object and setting its JT_MAPPING property value to be the same as the object’s name in the 3D model you have copied into the Resources/JT folder in order to establish a link. When cross-highlighting between views, the system first uses the JT_MAPPING property value, if it exists. If it does not then name matching objects across your design is used.

For cases where matching requires further refinement you can set both the and the to explicitly state what will match between both tools. This is required in flows where the JT object names are not considered as the unique identifier of the object, but some other 3D property. In Figure 48 below a link is established if the value in “JT_MAPPING” property on the Capital side matches the value in the“CAD_PARTNAME” property on the JT side”.

Note

This setting needs to be explicitly added into publisher/config.xml. In its absence the tool will default to existing behavior of matching JT_MAPPING property (or Name, as a fall back) to the Name of a JT object

Figure 48: JT Mapping Settings

Accessing the JT Viewer

Where an object has an associated 3D JT model, a 3D Location Views entry appears on its pop-over when it is selected, as shown in Figure 49.

Figure 49: 3D Location Views Option

Once you select this option the JT Viewer opens in its own separate pane within the client.

There is also an entry on the Navigation Panel called JT 3D Model which allows you to initiate your workflow directly from the 3d model.

The viewer has its own set of icons that enable additional functionality and interaction with the selected 3D model. In addition you can use the mouse wheel, with or without, the middle-button to pan, zoom and 3D rotate objects in the viewer. Right-clicking in free space or on a selected object allows you access further controls from where you can change material and view settings.

• opens the model tree to show or hide specific parts.

• shows product manufacturing information and any notes users may have appended to this object.

• alters the pane view to fit all.

• allows you to configure the camera view settings. You can choose between Perspective View which jumps the viewer to the next visible object as you move through your 3D model. Alternatively you can select the Orthographic view which offers a tomographic (CT) scan of the object, essentially penetrating through the layers to explore more of the hidden parts of the 3D structure, taking cross sections as you fly through the model, as shown in Figure 50.

Figure 50: Orthographic View - Example Tomographic Scan

• the cross-section view selection enables a number of different view options. You can look at a cross-sectional view in the X, Y or Z direction; choosing which sides are visible when you take the cross-section and adjusting the position, as well as incrementally adjusting the sectioning location. Figure 51 shows a pop-over in 3D together with a cross-highlight in 2D.

Figure 51: View Selection Options

• use on-screen measurements to establish dimensions and distances between objects.

opens the Markup tools, enabling you to add annotations to your service diagrams.

enables you to expand and interact with any exploded views you have saved in your service documentation package.

Using the JT Viewer on Touch Devices

Capital E/E Publisher also supports a Capital Service Explorer (HTML and Capital Design Explorer service package) - JT viewer integration. This enables the use of markup and annotation tools on touch screen devices, as well as the ability to expand and interact with any exploded views saved in your packages.

This integration is automatically available on touch screen and MacOS devices.

RapidAuthor 3D Catalog Model

Viewer

In this artifact, a 3D viewer and service DPL (Digital Product List or BoM table) for the RapidAuthor product RapidCatalog from Cortona3D is seamlessly integrated with Capital Service Explorer and Capital Design Explorer packages. It allows you to quickly identify faulty components, locate them, and even order replacement parts.

The integration shows a 3D model view, service DPL and associated wiring diagram all linked in one single integrated view. All views are enabled with bi-directional cross-linking, so you can highlight an object in the 3D model, wiring diagram or service DPL, and the object is highlighted across all 3 views. This integration requires no additional installation and works with all common web browsers.

Figure 52: Cross-linked Viewing and Highlighting of Components Across Wiring Diagram, 3D Model, and Service DPL Views

RapidAuthor allows for the integration of 3D models from a variety of MCAD platforms. See supported_cad_formats.pdf for a list of supported MCAD platforms.

Note

The RapidAuthor 3D Catalog Model Viewer integration to Capital Service Explorer and Capital Design Explorer packages is available for Windows operating systems, iPads and also laptops and devices running MacOS.

The behavior of the RapidAuthor viewer shipped with Service Explorer/Design Explorer differs from a default RapidAuthor viewer. Some functionality may not be available such as the shopping cart.

Preparing RapidAuthor Output For Use

To utilize the RapidAuthor 3D Catalog Model viewer functionality, create folders called /RapidAuthor/ipc/ at the top level of the Resources folder in your Capital installation (\data\xml\Publisher\auto resources). All package files generated from RapidCatalog should be placed in the ipc folder and referenced in the Resources field when creating a documentation package.

A RapidCatalog generated package contains the following files:

• Interactivity XML – Defines all the meta data about the 3D objects

• WRL – 3D model

The RapidCatalog mapping properties are set by right-clicking on a schematic object and setting its RA_MAPPING property value to be the same as the object’s name in the 3D model you have copied into the Resources/RA folder in order to establish a link. When cross-linking between views, the system first uses the RA_MAPPING property value, if it exists. If it does not exist, then name matching objects across your design is used.

For cases where matching requires further refinement you can set both the and the in the \publisher\config.xml file to explicitly state what will match between both tools. This is required in flows where the RA object names are not considered as the unique identifier of the object, but some other 3D property.

In Figure 53 below a link is established if the value in the RA_MAPPING property on the Capital side matches the value in the ComponentID property on the RA side.

Figure 53: RA Mapping Settings

Using the RapidAuthor 3D Catalog Model Viewer

After launching a generated package that includes RapidCatalog data, the RapidAuthor 3D Catalog Model Viewer will be available in the Navigation Panel on the left-hand side of the Capital Design Explorer or Capital Service Explorer:

Figure 54: Launching the RapidAuthor 3D Catalog Model Viewer

Click on ‘RapidAuthor 3D Catalog Model’ to open a drop-down list of available models. By selecting a model the RapidAuthor 3D Catalog Model Viewer will launch.

Figure 55: RapidAuthor 3D Catalog Model Viewer Default View

The user interface consists of two views: 3D Viewer and Service DPL (BoM) table. Each view is fully interactive and has its own control elements. For help understanding the interface controls, right-click over either view and select Help from the popup menu, or select the help icon in the top right corner of the DPL view.

The below video shows the bi-directional cross-linking in use:

Customizing the Rapid Author 3D Catalog Model Title

If you wish to change the Rapid Author 3D Catalog Model title within a Capital Service Explorer package to one meeting your organization’s requirements, you should navigate to the \publisher\i18n\resources\resources.properties file and add a configuration item in the Navigation Panel Display section as shown in the following example:

Copy

RapidAuthor3DCatalogModel = My 3D Model Title

External

Reports

Capital Change Explorer contains functionality that allows you to include existing change reports, of .html and .pdf format, within your generated Capital Change Explorer packages when running diagram comparisons.

The system mines the existing reports for names (reference designators) to create links to before and after diagrams. These inferred hyper-links allow zooming and cross-highlighting to applicable locations.

To enable the functionality create an Capital Change Explorer folder at the top level of the Resources folder in your Capital E/E Publisher installation and copy in any the existing, external .html or .pdf format reports that you wish to reference. When you run Package Generation the system will include these reports in the output, mine them and link applicable text from them to the respective diagrams.

Once a package is generated, the reports will appear in the list in the Navigation panel, just like default reports, as shown below. The original HTML/PDF file names are used as an identifier in the panel. Different reports are displayed in separate tabs when a package is saved as an Excel file.

Clicking on objects in the reports zooms to the relevant object on the diagram, be this on the old, new or on both. This can be seen in Figure 56 below, where Clip 4 (as indicated) has been selected in the external report and is then shown in situ on both the old and new diagrams.

Figure 56: External Report Displaying Mined Content Linking

If you subsequently save the package to Microsoft Excel (or other spreadsheet package) and you have Excel files corresponding to the HTML or PDF files then these are saved as corresponding tabs on the Excel saved version of the package. If you do not have an original version of the Excel file the system creates an embedded version in its own tab so it can be opened and viewed within Excel. A warning message is also displayed in the output window if the original Excel file is not available

Configuring Report Content

To enable hyper-linking between PDF external reports and the before and after diagrams, Capital Change Explorer produces HTML representations of PDF external reports. The result is that external reports displayed in Capital Change Explorer are all in the HTML format, regardless of whether the original external report was a PDF file or an HTML file.

Note

The structure of the HTML representation of a PDF external report will vary depending on the structure of the PDF external report. The structure of the PDF external report will depend on the structure of the original document that was used to generate the PDF and also on the method that was used to generate the PDF. For example, in Microsoft Word, for the same .docx document, using the Export > Create PDF/XPS Document functionality is very likely to produce a different PDF structure than printing the document using the “Microsoft Print to PDF” printer. Using Adobe Acrobat or a server-side PDF generation API could also result in different PDF structures, depending on the exact PDF generation settings that are used. As described below, the structure of an HTML representation of a PDF external report will affect what hyper-links to diagram objects are created when the contents of the external report is scanned.

Capital Change Explorer scans the external reports (either original HTML external reports or HTML representations of PDF external reports) and creates hyper-links to diagram objects where the names of diagram objects are found. HTML elements displayed on the same line are scanned using the following steps until a match with a diagram object name is found:

1. The text in the first

   element is scanned.

2. The combined text of all the

   elements is scanned.

3. The combined text of the first and second

   elements is scanned.

4. The text of subsequent

   elements is incrementally added to the text of the first and second

   elements and the combined content is scanned.

Finally, if no match with a diagram object name is found, no hyper-link is created. Where matches are found, the text is colored to indicate it is hyper-linked, as shown in Figure 57. The hyper-link will encompass all the text in the element where the match was found.

Figure 57: Hyper-linked Text

Note

You can specify delimiters in elements in the \publisher\changeExplorer\config.xml file. The effect of specifying a delimiter is that, within each