Generate Documentation Dialog

Access this dialog in the following ways: Press Space Bar and enter Publish, or right-click on a Harness or Logic Build List in the Project Browser Window, and select Publish.

Use this dialog to specify options for generating documentation.

Objects

Field	Description
Packager	Select from the dropdown list what type of documentation package will be generated.The list contains CGM Packager Capital Design Explorer Capital Change Explorer Load Analyzer Packager Capital Service Explorer Mobile Packager PDF Packager S1000D Packager Smart Flow Packager Mandatory.
Package Name	The name of the package. This field defaults to the name of the currently open project. It can also be user defined. Mandatory. Note Do not use Windows/Linux reserved file names when creating user defined package names. For a full list of reserved names, refer to the Windows or Linux documentation.
Export To	The location of the folder to export the generated documentation to. Click on the ellipses (...) to browse to a location. Mandatory.
Resources	The location of the folder containing external resources to include with the documentation. Click on the ellipses (...) to browse to a location. See Example Resources Folder. Optional.
Wiring Styleset	Dropdown list containing all available wiring stylesets. The selected style set will be applied to the package being created. Optional. Not available for Capital Change Explorer packages..
Wiring Border	The button enables changes to a wiring diagram border during publishing. See Changing a Diagram Border During Publishing for further information. Note Cannot be applied in conjunction with style set changes.
Harness Styleset	Dropdown list containing all available harness stylesets. The selected style set will be applied to the package being created. Optional. Only available for CGM packages, Capital Design Explorer packages and Capital Service Explorer packages..
Harness Border	The button enables changes to a harness diagram border during publishing. See Changing a Diagram Border During Publishing for further information. Note Cannot be applied in conjunction with style set changes.
General Tab
Scope	Displays all the Logic designs and build lists for the currently open Project. Use the check boxes to select the designs and or build lists to be included in the output documentation package.
Includes	Displays all the artifacts available for the selected Packager. Use the checkboxes to select required artifacts to be included in the output documentation package.
Application Files	Include a viewer executable, based on the packager type chosen, in this package. If not selected a data only package will be created.
Filter	Allows you to filter the available design displayed in the Scope between Show all designs, Show all designs (No active build list), Show only Logic designs or Show only Harness designs.
Configurations Tab
Configurations	Displays all the option configurations available for the selected Project. These are pre-defined based on the options available in Capital Project Manager. Move all configurations to be included on the output package to the Selected panel. Optional.
Create Package	Click to generate the documentation package. The button will become enabled when all mandatory fields and selections are complete.
Secure Package	The Secure Package checkbox in Capital E/E Publisher enables TLS security for generated packages, ensuring a secure connection between the client and server. By default, this checkbox is selected per user. It is essential to define a valid keystore certificate in the /publisher/server-config/. Failure to do so will trigger a warning message in the browser indicating an insecure connection. The secure package checkbox is recommended for external or remote access, transmission of sensitive data, or communication over public or untrusted networks. For testing purposes, or communication within local or isolated networks with non-sensitive data, it is advisable to disable the Secure package checkbox.
Run in the Background	Run in the Background is only displayed at the bottom of the dialog only if a Capital Integration Server web service is configured in the capitalintegrationserverconfiguration.xml file of your installation. 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 also “Running Capital Tasks in the Background” in the Capital Design Tools - Common Functions User Guide.

Parent Topic:

Generate Documentation Help

Capital E/E Publisher User Guide, 2512.2606

Unpublished work. © 2026 Siemens