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

Integration Help

Language
English
Product
Integration
Search by Category
Help
Smart 3D Version
12.1 (2019)
Smart Construction Version
2019(7.0)
SmartPlant Foundation / SDx Version
10
Smart Electrical Version
2019 (9.0)
Smart Materials/Smart Reference Data Version
2020 (10.0)
Smart P&ID Version
9 (2019)
Smart Review Version
2020 (15.0)
Smart Engineering Manager Version
10 (2019)
Smart Interop Publisher Version
13.1 (2019 R1)
Smart Isometrics Version
7.0(2019)
Spoolgen Version
9.0(2019)

When you retrieve documents into an authoring tool, you are retrieving the document data that was published by another authoring tool. For example, in Smart Instrumentation, you can retrieve engineering information from a published P&ID into the Smart Instrumentation database.

Using the SmartPlant > Retrieve command in the authoring tools allows you to select a document and retrieve it into that tool.

When you publish a 3D model, you must enable the Scheduler and Loader to make the 3D model data document retrievable. The load, consolidate, and merge tasks must complete successfully before the 3D model document can be retrieved. For more information, see Schedulers and Queue Management.

You can retrieve a document in three different ways:

  • As published - Retrieves only the data the authoring tool originally published with the selected revision and version of the document. Retrieving as-published data retrieves the .xml file the authoring tool published from the appropriate vault.

  • With the latest data - Retrieves the latest data associated with the selected document. If another, more-recently published document contains updates to objects in the selected document, the software retrieves the most current data for those shared objects. When you retrieve the latest data, SmartPlant generates an .xml file containing the published data.

  • CDW data - Retrieves the data by updating the property values contained in a published XML with those contained on the corresponding CDW object. This allows you to synchronize the design based on a single source of master design basis.

Document Types for Retrieval

The types of documents that you can retrieve depend on the authoring tool you are using 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. The following lists include the documents that each authoring tool can retrieve by default. You can configure the software to retrieve additional types of data and documents.

PDS

  • Does not retrieve

Smart 3D

  • Cable Schedule Reports

  • P&IDs

  • Smart Electrical cable schedules

  • Smart Instrumentation dimensional datasheets (DDPs)

  • Plant Breakdown Structure (PBS)

Smart Electrical

  • 3D Model Data Filtered for Cable Schedule Data

  • Electrical Tag Signal List

  • Enhanced SmartLoop Reports (view files only)

  • Instrumentation Requiring Electrical Power Supply

  • P&IDs (Electrical Consumer Lists)

Smart Engineering Manager

  • Plant Breakdown Structure (PBS)

Smart Instrumentation

  • Electrical Power Element Reports

  • Electrical Signal I/O Lists

  • Instrument Process Data Sheets (IPDs)

  • P&IDs

  • Plant Breakdown Structure (PBS), if Smart Engineering Manager is not used)

  • Schematics (view files only)

Smart P&ID

  • Equipment Data Sheets

  • Equipment Lists (published as Equipment Data Sheets)

  • Instrument Indexes

  • Instrument Master Lists (published as Instrument Indexes)

  • Process Flow Diagrams (PFD)

  • Stream Data Sheets (published as Equipment Data Sheets)

Aspen Basic Engineering

  • P&IDs

  • Plant Breakdown Structure (PBS)

All Authoring Tools

From the authoring tools, you can retrieve the plant breakdown structure (PBS) and project documents. The PBS and project documents, created in and published by SmartPlant Foundation, are retrieved by authoring tools to provide information about the plants, areas, units, projects, and contracts that need to be created in the authoring tool so that the information is consistent across all authoring tools.

The PBS document published by SmartPlant Foundation contains information about the physical plant whose structure consists of plants, areas, and units. The default structure is plant/area/unit, but you can define a custom hierarchy in the Schema Editor.

  • Retrieving the project breakdown documents and the PBS into Smart Engineering Manager creates the appropriate structures automatically for Smart P&ID, Smart Electrical, or Smart Instrumentation (if Smart Engineering Manager is used).

  • When using the Smart Instrumentation Administration module instead of Smart Engineering Manager to define the PBS for Smart Instrumentation, you must create the plant hierarchy according to the PBS information in SmartPlant Foundation before you retrieve the PBS. You must create at least one plant hierarchy item at the lowest level, such as a unit, before you can retrieve the PBS.

  • To allow the placement of piping components from a retrieved P&ID, you must specify the value Smart 3D for the Use Piping Specification property in Smart P&ID Options Manager.

Data Handling After Retrieval

The authoring tool that you use also determines how the software deals with changes in downstream data when you retrieve a document. Smart P&ID, Smart Instrumentation, Smart Electrical, and Aspen Basic Engineering analyze the impact of the newly retrieved data on the existing database, and then place tasks on the authoring tool To Do list that allow you to create, delete, or modify items at the appropriate time in the design process. The To Do list gives you the opportunity to view and understand potential changes before accepting, deleting, or modifying those changes. In Smart 3D, you can view the P&ID using the View > P&ID command to pull in the data and correlate items.

Design Basis

Objects that tools retrieve from other authoring tool documents can become the design basis for objects in downstream documents. Objects that become the design basis for other objects can be specific objects that accumulate more data as they move through the lifecycle or can be schematic or logical objects in one application that evolve into more detailed objects downstream.

Design basis is implicitly based on retrieval, which means you do not have to define it. For example, a pump retrieved from a Process Flow Diagrams becomes the design basis for a pump in the Smart P&ID document. When you change common properties for the pump and retrieve the changes into Smart P&ID, tasks to update property values are automatically added to the To Do List. The same process works for logical items that are a design basis for other items, such as a stream in Aspen Basic Engineering that results in multiple pipe runs in Smart P&ID.

Retrieve and Restore

The retrieval process in Smart 3D supports restore. For example, when another application has been restored to a previous state, the Smart 3D design basis objects are deleted and re-created upon retrieve. To avoid duplicating 3D objects, the retrieval process checks systems, pipelines, and projects/contracts to see if they already exist with the same name and type as design basis objects. If so, the software correlates to the objects upon retrieve rather than creating new objects.

After the retrieve operation, you must re-correlate the other 3D objects (besides systems, pipelines, and projects/contracts) with the new design basis objects.