Publishing Documents - Intergraph Smart P&ID - Help - Intergraph

SmartPlant P&ID Drawing Manager Help

Intergraph Smart P&ID
2014 (7.0)

In an integrated SmartPlant environment, you must publish documents containing the drawing data and relationships before the authoring tools can share this information. The publishing process involves selecting a document to publish, assigning it to a workflow (if necessary), and specifying a revision and version of the document if specified in SmartPlant Foundation. For most documents, the associated data is included in the publishing process.

The authoring tools publish data in XML format. The software then places the .XML file in the appropriate SmartPlant Foundation vault and loads the data from the .XML files to the SmartPlant Foundation database. After the document is published, users can retrieve the data from the .XML file in the SmartPlant Foundation vault into other authoring tools.

When you publish documents, the software does the following things:

  • Creates a new master document and the first revision in SmartPlant Foundation the first time you publish a particular document. From that point on, the software creates new versions and revisions when the document is subsequently published. The software relates revisions to the master document. You can publish subsequent revisions into a workflow, which can be a different workflow than assigned in the original publish. Changes in the document status of a related revision change the status of the subsequently published versions and revisions of the document.

  • Publishes a visual representation of the document that you can view without the authoring tool. For many applications, this is an Intergraph proprietary file, called a RAD file. The viewable file can also be an Excel spreadsheet or another viewable file type, such as .pdf or .doc. You can review and mark up the visual representation of the document, which is attached to the document revision, using SmartPlant Markup.

  • Publishes associated data, depending on workflow approval. If the data is approved and loaded, it is used for reporting and subsequent retrieval by downstream applications when the tools retrieve latest data. The software publishes only meaningful engineering data. The published data is not enough to re-create the document in the originating tool.

  • Places the published .XML file and any view files in the appropriate SmartPlant Foundation vault. This .XML file can be retrieved when users in the authoring tools retrieve as-published data.

  • Sends notification to the publishing tool.

For more information about revisions and versions, see the SmartPlant Foundation Web Client User's Guide or the SmartPlant Foundation Desktop Client User's Guide.

Reasons to Publish

You can publish documents and associated data for several reasons:

  • To exchange and enhance data among tools, to avoid creating data multiple times in multiple authoring tools

  • To report on common data originating in multiple tools

  • To provide enterprise-wide accessibility to published documents

  • To manage change, including workflow history and document revision management

You can also publish documents to share information with users in other tools without going through a formal workflow. To share data, you can publish a document to a "for sharing" workflow that has only a load step, so that the data in loaded into SmartPlant Foundation as soon as you publish the document.

You can also publish a document by not assigning the document to a workflow, but rather by using the default workflow from SmartPlant Foundation. When you do not select a workflow for a document during publishing, the SmartPlant Loader Manager loads the document into SmartPlant Foundation as soon as it reaches the top of the Loader queue.

Publishing Documents

Each authoring tool publishes different documents and data. The following list contains each authoring tool that is part of integration, the document types that each tool publishes, and information about whether data is also published with each document type.

Aspen Basic Engineering

  • Process Flow Diagrams (PFD)

  • Equipment Datasheets — documents and data

  • Equipment Lists (published as Equipment Datasheets) — documents and data

  • Stream Datasheets (published as Equipment Datasheets) — documents and data

SmartPlant P&ID

  • Piping and Instrumentation Diagram (P&ID) — documents and data

SmartPlant Electrical

  • SPEL Electrical I/O Lists — documents and data

  • SPEL Electrical Power Elements — documents and data

  • Cable Schedules — documents and data

SmartPlant Instrumentation

  • Instrument Index — documents and data (limited)

  • Instrument Specification Sheets — documents

  • Dimensional Data Sheets (DDP) — documents

  • Instrument Process Data Sheets (IPD) — documents

  • Instrument Loop Drawings

  • I/O Assignments — documents

  • SmartPlant Instrumentation Electrical Signal Lists

  • Browsers (viewable file with links to data) — documents and data

SmartPlant Engineering Manager

  • Does not publish

SmartPlant 3D

  • 3D Model Data (SmartPlant Review File Type)

  • 3D Cable Data (SmartPlant Review File Type)

  • Orthographic Drawings — viewable file with links to data

  • Isometric Drawings — viewable file with links to data

  • Reports — viewable file with links to data


  • Model

  • Orthographic Drawings

  • Isometric Drawings

  • Reports

SmartPlant Foundation

  • Plant Breakdown Structures (PBS)

  • Project Breakdown Structure

  • Project Definition Documents

  • Project Lists

  • Instrument Process Datasheets (IPD)

  • Equipment Lists

  • Instrument Master Lists

Among the documents that SmartPlant Foundation publishes are the plant breakdown structure (PBS), project breakdown structure, project definition document, and project list. These documents are used by the authoring tools to create the plants, areas, units, projects, and contracts that are necessary to make integration possible.

The PBS document published by SmartPlant Foundation contains information about the physical plant with a structure consisting of plants, areas, and units. The default structure is plant/area/unit, but you can define a custom hierarchy in the Schema Editor. When a PBS document is published from SmartPlant Foundation, the authoring tools are notified about the plant, areas, and units that need to be created in each authoring tool.

The project breakdown structure, project definition document, and project list contain information about projects and their statuses. When these documents are published from SmartPlant Foundation, the authoring tools are notified of projects and contracts that need to be created in the authoring tools.

The project breakdown structure contains a single project and the hierarchy of contracts under that project in a plant/project structure. The project definition document contains information for a single project that needs to be created in the authoring tool. The project list contains a list of all projects in a plant, and it is used by those authoring tools that create all projects at one time.

  • The plant breakdown structure and project breakdown structure used in the authoring tools must match the structure in SmartPlant Foundation for publishing from the authoring tools and object correlation to work correctly.

  • When you publish data from an authoring tool, you may not be able view all the properties that you published in the SmartPlant Foundation client. You can customize view definitions to allow you to see additional properties. For more information about defining view definitions in the SmartPlant schema, see Working with View Definitions and Create a View Definition in the Schema Editor User's Guide. For further assistance with visualizing data in SmartPlant Foundation, contact Intergraph Support Services.

Publishing Files without Data

You can also browse to and publish other file types, such as Microsoft Word, Microsoft Excel, or SmartSketch files. These documents are always published without data. The primary reason to publish documents without data is so that you can manage document changes and reviews using workflows and view the document electronically using the SmartPlant Foundation Change Management functionality.

Revisions and Versions of Published Documents

The first time you publish a document, the software creates a new document master and the first revision in SmartPlant Foundation. A revision (major) is an officially recognized change to a document. A version (minor) is an intermediate update that you have published. Revisions can be published for sharing, or they can go through the approval process, depending on your needs. Each revision of a document can have multiple versions in the SmartPlant Foundation database.

After the first publish of a document, the software creates new versions and revisions. Subsequent revisions are related to the master document and stored as revisions. Subsequent revisions are also published into a workflow, which may be a different workflow than the original publish. It is not possible to publish into a specific step of a workflow, so each overall workflow must be divided into logical sub-workflows.

Some tools, such as SmartPlant Instrumentation, provide the ability to manage revision information and display it in the title block. When you enter the revision information (revision number, description, and so on) in the tool, that information is published with the document and is used to define the revision in the SmartPlant Foundation database. If the tool does not provide this, you can select this information from the available list during the publish process.

Changes in the document status of a related revision change the status of the master document.