Document publishing

The high-level workflow for creating technical design documents typically follows these steps:

  • Create and update the document – The designer creates and updates the document using the CAD system.

  • Review and accept the document – The project leader reviews and accepts the document. This can be done in the CAD system, in a document management system (DMS), or using a manual approval process.

  • Publish the document – The approved document is published as an official deliverable for use in purchasing, manufacturing, assembly, operation, or maintenance. Publication usually involves extracting the latest approved document revision from the company's DMS.

In the CADMATIC document management process, documents are handled as static 2D files and associated BOM lists. However, as the design applications are based on 3D models, at the time of publishing the native documents reflect the current state of the 3D model.

Because the 3D model changes frequently—especially in large projects with many designers working simultaneously—new document revisions must be published to keep the documentation aligned with the latest model changes. Revisioning is managed by assigning revision IDs to published versions.

To support a controllable document acceptance and publication workflow through a DMS, CADMATIC Plant and CADMATIC Outfitting use a dedicated process for publishing their native documents, as described below.

Publishing documents

In CADMATIC design applications, the document browser's Publish command allows the designer to create publications for the selected document objects. Internally, the publishing triggers the following actions:

  • The program exports a DWG file from the drawing. During the export, the export configuration implements the desired property mappings, such as which DWG layers to use. The DWG file is stored in the publication data.

  • The program generates the data required to define links between the 3D model and drawing labels. The linking data is stored in the publication data and once published to eShare, allows eShare and eGo users to navigate between model objects and related drawings.

  • The program stores the publication data in the document repository and checks in the 'Drawing' and 'Publication' COS objects.

After publishing, opening the document for editing prompts the designer to choose whether to create a new revision for it. Choosing to create a new revision increments the revision ID, and all previously published revisions remain available. However, if the designer chooses to edit without incrementing the revision ID, the edited version will overwrite the previously published revision. This methodology allows designers to maintain full control over publication revisions, and for example, the following workflow can be used:

  • The designer creates a new drawing and eventually reaches a stage where work seems complete.

  • The designer sets the initial revision ID and publishes the first version for acceptance review.

    Tip: At this stage, the drawing sheet could display a suitable status label, such as 'Preliminary'.

  • The designer receives feedback from acceptance review, makes the required changes, and publishes a new version. The revision ID still remains unchanged.

  • The new version passes the acceptance review, and the designer publishes the document for production.

  • The designer receives feedback from production, makes the required changes, and publishes a new version—this time with a new revision ID.

This process is not meant to replace the use of a proper document management system, but it can make it easier to control the process within CADMATIC and also enables the implementation of better, automated integration between eShare and the DMS, especially in distributed projects where direct integration with eShare or a DMS server would not be possible at replica sites.

Technical Details

  • The document data is stored in files that the COS server manages by using 'Drawing' COS objects to store the control data. Users cannot access these files.

  • The document publication data is stored in files that the COS server manages by using 'Document Publication' COS objects to store the control data. Users cannot access these files.

Checking publication status

After a drawing or diagram has been published at least once, you can use the Publishing status column in the Document browser or the Manage Diagrams dialog to check whether the latest publication matches the current document version. If this column is not visible, use the column editor to add it to the dialog.

The availability of an individual status depends on the design application. Possible statuses:

  • Info not available

  • No spools

  • Spools changed

  • Spools missing

  • Not up to date

  • Up to date

When the status is not Up to date, evaluate whether the changes require increasing the revision number and/or publishing a new version.

Exporting document publications to files

The designer can export document publications in required file formats using the document browser's Export command.

The export function converts the embedded DWG file without accessing the 3D model. This ensures that exported files match the snapshot of the model stored in the document publication.

We recommend the following policy:

  • Always publish the document when you finish editing.

  • Always export 2D files from the latest publication, not from the drawing.

Exporting document publications to eShare

After a designer has published a document in CADMATIC Plant or CADMATIC Outfitting, the document can also be published to eShare. For details, see Working with CADMATIC eShare.

Related topics

Document revisioning