Exchanging published documents - SmartPlant Foundation - IM Update 48 - Help - Hexagon

When data is published from multiple tools into the SmartPlant Foundation domain, the published document or consolidated objects from the published document can be exported to a target site using Data Validator. For more information, see Mappings for published documents.

Published documents exported from a SmartPlant Foundation system into an SDx system cannot be moved back to a SmartPlant Foundation system using the Exchange Data functionality.

Here are two ways to export published data and documents to CSV files.

• Using publish instructions: When your source system schema matches with the target system schema, you can export the published document in its entirety with all its data using publish instructions. Configure a view definition to construct a publish instructions object, similar to the one used by SmartPlant Client to create a published document in SmartPlant Foundation. This publish instructions object uses the view definition to filter the document properties that you want to export to a CSV file. The CSV file is generated for the complete document with the tool data, tombstones, metadata, and the drawing file information. The CSV file is processed by Data Validator.

• Using a custom CDW data transfer: If your source system schema is different from the target system schema, you can selectively export the consolidated CDW objects in a published document using a custom data transfer. Configure a graph definition with the required objects and relationship traversals, and use it to generate inverted CSV files for the selected objects. For example, select the required class definitions of consolidated objects in a published document in a CDW system and transfer them to an FDW system or an HxGN SDx system using Data Validator mappings.

  

  • You can restrict the properties that you don't want to export by using the Ignore Property check box during mapping in the Generate Raw Attribute Properties for Export wizard in the Data Validator Administration module. For more information, see Generate raw attribute property mappings for export.

  • We recommend setting the CDWEnabled property to True in the Server Manager site Settings node before initiating the custom data transfer to avoid any unexpected results.

There may be cases where different versions of a document need to be exchanged between the source and target systems during the plant lifecycle. The changes made to the document and its data at the source system must be updated correctly in the target system. Delete instructions are generated in a tombstone XML file to update the information about the deleted objects at the target site. To process delete instructions, the tombstone files from the last exported version to the current version being exported are merged.

The tombstone instructions from different versions will be merged only when at least one version of the document has been previously exported to the target system.

The published object is linked to the CDW object with a ComprisedOf relationship; delete instructions are read, and if no ComprisedOf relationship exists with the CDW object, the object UID is exported to a CSV file. The CSV file is validated by Data Validator and exported to the target system for deletion.

For example, if a piece of equipment is deleted, delete instructions are generated in a tombstone XML file. During the exchange of data, the delete instructions in the tombstone file are read and the equivalent CDW object UID is exported into the CSV files and deleted at the target site.

The following table illustrates a couple of scenarios on delete instructions and the corresponding resolutions:

P1, P2, P3, and P4 are properties on the published object.

• When the Export CDW objects option is selected, we recommend that you export only published documents where the Consolidate Status is set to Successful.

• The Export CDW objects option and the Is published data option in the Report Configuration form must be selected to export the deleted objects into CSV files from the merged tombstone files of different versions.

Regenerate graphic map files in the target system

When published documents are exchanged from the source system to the target system using the custom CDW data transfer process, the graphics map files have to be created or regenerated and attached to the document objects in the target system. This is required so that hotspots can be created to link the objects in the graphics map files for viewing in the Desktop Client.

To regenerate the graphics map files after the document objects are exported to the target system, use the CDWGenerateGraphicsMapFile sample workflow, which contains the SDVCDWGenerateGraphicsMapFile custom process step.

The sample workflow is provided through Smart Community. For more information, see Find sample data on Smart Community. To load the sample file, use the Loader in the Desktop Client. During the custom CDW data transfer, the documents that are exported to the target system are attached to the CDWGenerateGraphicsMapFile workflow automatically, which regenerates the graphics map file.

For more information on the process step, see Regenerate graphics map files in a target system.

For more information on attaching the document objects to the workflow using Data Validator, see Workflow.

Automatically transfer published documents and data using a sample workflow

Use the sample workflow, Auto-CorrelateWithExchangeData, to configure automatic transfer of published documents and data to a target system. This workflow is delivered through Smart Community. For more information, see Find sample data on Smart Community.

You can load this workflow using the Desktop Client Loader. This workflow is similar to the Auto-Correlate workflow, but an additional process step, RunSPFExchangeData, is available. This process step allows you to trigger the transfer of published documents and data by configuring a load job and exporting the documents and data to the target system automatically after they are loaded and consolidated successfully at the source system. This process step is configured using a single argument, the name of the user-defined method used for transferring data. It can be used in any of the publish workflows.

For more information on the user-defined method, see Create a user-defined method for exchanging data.

For more information on the Auto-Correlate workflow, see Publish Workflows.

For more information on the RunSPFExchangeData process step, see Configure a load job for exchanging documents and data automatically.

After loading the sample workflow using the Desktop Client Loader, you can select the workflow from the Workflow list in the Publish dialog box of the common UI or SmartPlant Client while publishing.

Exception messages for any errors in the workflow are logged on the SPFWorkflowStatusErrorMessage property, exposed by the ISPFWorkflowItem interface definition realized by the published document.

Automatically generate WebGL viewer files for Hexagon 2D and 3D files

Any Hexagon 2D and 3D files that are exported to an SDx system using the Exchange Data functionality can be converted into WebGL viewer files. The Auto generate WebGL viewer files option in the Update - SPF System Options dialog box in the Desktop Client must be enabled before data exchange is initiated. If automatic generation fails, you can generate the files using the Actions menu in the Web Client. For more information, see Enable automatic generation of WebGL viewer files for Hexagon 2D and 3D files (retired).

Sample data for exchange of published documents

Use the Desktop Client Loader to load the sample data provided at Smart Community. For more information, see Find sample data on Smart Community. Use this sample data for the exchange of published documents. The following sample files are provided:

• Exchange PublishInstructions View Graph EdgeDef.xml - This file contains the sample view definition, graph definition, and edge definition needed for generating basic and inverted CSV files.

• ReportConfiguration And ExportDetails.xml - This file contains the sample report configuration and export details object.

• Exchange PublishInstructions RHM Method.xml - This file contains the sample method for configuring the shortcut menu command to exchange published documents.