S1000D Packager

This topic provides an overview of the options for configuring and using the S1000D package to generate a documentation package out of Capital E/E Publisher that conforms 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.

S1000D is a technical publication (data) specification to enable the production of standardized user documentation, be that user guides, maintenance manuals or training courses. It separates the creation of technical content from the production of end user documentation. Information, such as design data or training concepts, is drawn together by the S1000D Packager from discrete data modules to produce differing types of technical documentation. The data modules reside in a common source database (CSDB). The final package can be delivered either as an interactive electronic technical publication (IETP) to be viewed in a web browser, or as a paper-based manual.

Figure 45: S1000D Package

A CSDB contains a series of modules which together comprise unit of documentation. The data is commonly held as .xml files, while graphic data must always be .cgm. Each data module has an XSD (XML Schema Definition) type.

The modules are:

• Data Modules

• Graphical Objects

• for each diagram three files are created CGM (illustration) XCF (illustration index in XML) and DMC in wrngdata.xsd format

• Publication Modules

The S1000D Packager will generate a CGM file for each diagram in the scope of the selected designs and XML files for each system that contains the wiring information. The files will be exported to the location specified on the Generate Documentation Dialog in a folder structure matching that of the selected scope.

Note

Graphics for device pins, connector pins and so on, are not displayed while exporting wiring diagrams as PDF, DXF, CGM and SVG. You can indicate the presence of pins using styleset decorations such as “Pin Name."

The following artifacts are available as standard with the S1000D packager:

• Illustrations (CGM Diagrams) Tip To view CGM Packets, install any CGM Viewer. A recommended viewer can be downloaded from

Configuring a S1000D Package

This topic provides an overview of the options for configuring the S1000D package. The system is pre-populated with configuration data in four files:

• CONTROL.xml

• wireHeaderMap.xml

• wireMap.xml

• wiringDataHdr.xml

The following aspects of the S1000D generated package are configurable:

• Configuration File

• Setting S1000D Tag Values

• Developing S1000D Mappings.

• Attributes and Properties

To define the set of attributes and properties for inclusion in the CGM package, edit the attributeList.xml file. This file is found in the Publisher folder of the Capital installation directory

Configuration

File

The CONTROL.xml file contains three sections:

• Defaults A list of tags each beginning with 'S1000D.' and a value for that tag. The names of the tags are user definable - it is recommended that standard abbreviations are used, for examples as shown in Figure 46. Figure 46: Example S1000D Tags

• Pattern This defines how the system will assemble an ICN, DM or LearnCode. Each item may be a literal string constant, or a 'val' - which must be the name of one of the S1000D constants.

• Switches Control.xml also contains two switches. isCleaningFiles should be set to 'Y' in a production system - and set to 'N' when you are developing the mapping. When files are being cleaned temporary files created during the process are removed at the end of the process, in addition most mapping output is suppressed.

isAddLearnCodes should be set to 'Y' if you want to add the Learncode suffixes to the DMC's and ICN's created. Otherwise set to ‘N’.

Setting

S1000D Tag Values

S1000D tag values are user-defined. They may be entered as properties for each diagram or project. They may also be entered with default values in the configuration file. The following order of precedence is applied:

• Values entered as properties for a diagram take precedence over the same entry present in a project.

• Values entered as properties for a project take precedence over the default value set in the configuration file. Note The format used for the properties in the configuration file is the same as the XML format used by Capital.

Developing

S1000D Mappings.

Caution

S1000D package mappings should only be performed by a system administrator or an experienced S1000D designer.

This S1000D package is provided with a set of pre-defined mappings which can be reconfigured to meet your own requirements. These files are:

• wireHeaderMap.xml

• wirMap.xml

• wiringDataHdr.xml Note During mapping development the isCleaningFiles option switch must be set to ‘N’.

Once you click CreatePackage to generate, the S1000D package is created in two stages. In the first phase intermediate files are created, containing temporary data. In the second phase the pre-defined XML maps are applied to the temporary data. The new documentation package is generated, and exported to the location specified in the Export To text box.

Invoking

Greyscale Printing in the S1000D Packager

To invoke greyscale printing in the S1000D packager follow the instructions detailed in Invoking Greyscale Printing

Attributes and Properties

Each object within a design has its own set of attributes and properties. The Attributes and Propertiesartifact will export those values and make them available on selection of that object within the CGM output.

Caution

CGM package configuration should only be performed by a system administrator or an experienced CGM designer.

The set of attributes and properties to be included are specified in the attributeList.xml which is located in the Publisher directory of the Capital Application installation folder. 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 the Capital Service 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.

Parent Topic:

Packagers

Capital E/E Publisher User Guide, 2512.2606

Unpublished work. © 2026 Siemens