Publishing in an Integrated Environment - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

When the SmartPlantĀ® Enterprise authoring tools are integrated, 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 necessary). For most documents, the associated data is included in the publishing process.

When using Background publish to publish a large number of documents simultaneously, some documents may not be published. This is usually the result of not having enough available computer memory (RAM) to complete all the publishing tasks.

The authoring tools publish data in XML format. The publishing process places the XML file in the appropriate vault and loads the data from the XML files to the SmartPlant Foundation plant. 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:

  • Creates a new master document and the first revision on the initial publish for 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 Hexagon applications, this is the application's native format. The viewable file can also be an Excel workbook or another viewable file type, such as PDF or DOC. You can review the visual representation of the document, which is attached to the document revision, using SmartPlant Markup Plus or Smart Review. You can also mark up the visual representation of the document using SmartPlant Markup Plus.

  • 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 authoring tools retrieve the latest data. The published data is not enough to re-create the document in the originating authoring tool. Some document types are published without the associated data, such as reports from authoring tools (for example, instrument specification sheets in Smart Instrumentation). You can submit documents published without data to workflows just like documents with data. The document types and data that you can publish depend on the authoring tool you are using.

  • 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.

Reasons to Publish

You can publish documents and associated data for several reasons:

  • Exchange and enhance data among tools, to avoid creating data multiple times in multiple authoring tools.

  • Report on common data originating in multiple tools.

  • Provide enterprise-wide accessibility to published documents.

  • 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 is made available to other authoring tools 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 loads the document as soon as it reaches the top of the Loader queue.

Publishing Documents

Each authoring tool publishes different documents and data.

The plant breakdown structure (PBS) document, published by SmartPlant Foundation, contains information about the physical plant with a structure consisting of a plant, areas, and units. The default structure is plant/ functional area/ functional unit, but you can define a custom hierarchy by using 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 following list contains each SmartPlant Enterprise authoring tool and the document types published by each of those tools by default. The types of documents that you can publish depend on the authoring tool you are and whether you are using a full integration system or a basic integration system. Full integration includes SmartPlant Foundation as the data repository; basic integration uses SmartPlant Basic Integrator for data exchange and has no data repository. You can configure the software to publish additional types of data and documents.

PDS

  • Design Review Files

  • Isometric Drawings (view files only)

  • Orthographic Drawings (view files only)

  • Reports (view files only)

Smart 3D

  • 3D Model Data (Smart Review File Type, Smart Interop Publisher File Type)

  • Model Data Filtered for Cable Schedule Data (Smart Review File Type)

  • Isometric Drawings (view files with links to data)

  • Orthographic Drawings (view files with links to data)

  • Reports (view files with links to data)

  • 3D Cable Data (Smart Review file type)

  • Piping Isometric Drawings (viewable file with links to data)

Smart Electrical

  • Cable Schedule Reports

  • Electrical Signal I/O Lists

  • Excel Reports

  • Instruments and Cabinets Requiring Electrical Power Supply

  • Schematics (view files only)

  • Single-Line Diagrams (view files only)

  • Power Distribution Board Layout Drawings

  • Cable Block Diagrams

  • Wiring Diagrams

Smart Engineering Manager

  • Does not publish

SmartPlant Foundation

  • Equipment Lists (published as Equipment Data Sheets; full integration only)

  • Instrument Process Data Sheets (IPDs; full integration only)

  • Instrument Master Lists (published as Instrument Indexes; full integration only)

  • Plant Breakdown Structures (PBS)

Smart Instrumentation

  • Browsers (view files with links to data)

  • Dimensional Data Sheets (DDPs)

  • Electrical Tag Signal Lists

  • Enhanced SmartLoop Reports (view files only)

  • Instrumentation Requiring Electrical Power Supply

  • Instrument Indexes

  • Instrument Process Data Sheets (IPDs; view files only)

  • Instrument Specification Sheets (view files only)

  • Select Wiring Reports (view files only)

Smart P&ID

  • P&IDs

  • Reports (view files only)

Aspen Basic Engineering

  • Equipment Data Sheets

  • Equipment Lists (published as Equipment Data Sheets)

  • Process Flow Diagrams (PFD)

  • Stream Data Sheets (published as Equipment Data Sheets)

Publishing Files without Data

You can also browse to and publish other file types, such as Microsoft Word or Microsoft Excel 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.

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 Smart 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. 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.

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 Create a View Definition.

Publishing to projects

With Intercompany Collaboration 2 (ICC2), you can publish a document to the SmartPlant Foundation configuration that corresponds to the authoring tool plant or project that it was published from. With ICC2, owner operators can find and manage inconsistencies across projects or disciplines within projects, such as:

  • Data inconsistencies across schematics tools

  • Project scope inconsistencies across schematics tools

  • Overlaps in scopes across projects

In an integrated environment, the authoring tool can claim or unclaim objects into a project, and then publish to a SmartPlant Foundation project. Claiming and unclaiming objects is managed during the publish operation.

Claim instructions

  • You can claim an object from the authoring tool plant to an authoring tool project and then modify the claimed object. You can publish the modified object to a SmartPlant Foundation project that corresponds to the authoring tool project. The SmartPlant Client creates claim instructions with reference to the authoring tool to claim the object into the project in SmartPlant Foundation.

Unclaim instructions

  • After publishing an object to a project, you can unclaim it in the authoring tool project before publishing it again from the plant project. The SmartPlant Client creates unclaim instructions to unclaim the object in SmartPlant Foundation.

Where to find more information

See Also

Publish Documents .NET
Publish Documents
Find Documents to Publish Dialog Box
Publish Command