ISPFTEFPublishedDocVersion interface - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

This interface is used to identify a document version as being a published document and exposes a number of properties which are used when data is published.

The following properties are found on this interface.

Name

Description

Set on

SPFTEFObjectUIDSet

The UIDs of the objects contained within the file

Framework client will read the file and add this in

SPFTEFRelUIDSet

The UIDs of the relationships contained within the file

Framework client will read the file and add this in

SPFTEFDataLoadStatus

Indicates whether the contents of the associated files have been loaded or not

Initially set in the Framework client but set again when the document is loaded

SPFTEFHasBeenCorrelated

Indicates whether the contents of the associated file have been correlated using one of the correlation workflows.

Set in the Correlate workflow

SPFTEFConsolidateStatus

Indicates whether the contents have been consolidated (whether the shared objects have been generated)

Set to True when the consolidate task has successfully been run

SPFTEFIsRetrievable

Indicates that the document can be retrieved by other tools. You can use this property (with custom code) to control the availability of a document version for retrieval by other tools.

This property is not set by default. When this property is not set, the document version is available for retrieval. When this property is set to False, the document version becomes unavailable for retrieval by other tools. When this property is set to True, the document becomes available for retrieval in the Retrieve dialog box

SPFTEFLoadDataPercentComplete

Indicates the percentage of data loaded

Set to 100% when the data consolidation is complete. The current consolidation percentage is displayed when the object is refreshed

SPFTEFConsolidateDataPercentComplete

Indicates the percentage of data consolidated (percentage complete of building and populating the shared objects that exist between various tools and SmartPlant Foundation)

Set to 100% when the data consolidation is complete. The current consolidation percentage is displayed when the object is refreshed

SPFTEFTagItmGrpCnt

Indicates the total number of tagged item groups published in the document.

Set by the SmartPlant Foundation server when either the load or the consolidation fails

SPFTEFTagItmGrpLoadCnt 

Indicates the number of tagged item groups that were loaded successfully into the database before the load failed.

Set by the SmartPlant Foundation server when the load fails

SPFTEFTagItmGrpConsCnt  

Indicates the number of tagged item groups that were consolidated successfully before consolidation failed.

Set by the SmartPlant Foundation server when the consolidation fails

SPFTEFAutoCorrelationEnabled

Indicates whether the contents of the associated file have been correlated using the Auto-Correlate workflow.

Set by SmartPlant Foundation during the Auto-Correlate workflow.

Functionality Configured on ISPFTEFPublishedDocVersion

The following commands are configured on this interface: Attach File, Compare, View and Compare, Generate a Map File, Remove Task, Retry Task, Show failure, Consolidate Document, Load Published Data, and Load Published Data into Document Configuration.