CompareLatestRetrievedData client API - 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)

The CompareLatestRetrievedData client API is used to compare the latest retrieved data. The actual data that is used for the comparison is the data held within the file that was last retrieved into the user's To Do List. The method is run from a drop-down menu.

Argument

Description

Parameter 1

Tool Component

Parameter 1 default

None

Parameter 1 description

Name of the tool (or authoring) component schema that any items selected will be loaded into. The name of this component schema will be used in the header of any loaded XML file that is then submitted to the server.

Parameter 1 type

String

Parameter 2

Tool Domain

Parameter 2 default

None

Parameter 2 description

Name of the authoring domain in which the data is instantiated. When the comparison is made, the UIDs contained in the file are checked against the authoring database in the domain specified.

Parameter 2 type

String

Parameter 3

Adapter Code

Parameter 3 default

None

Parameter 3 description

Adapter code or document type that is used to identify the map file.

Parameter 3 type

String

Parameter 4

Assembly Name

Parameter 4 default

None

Parameter 4 description

Name of the compare assembly that is loaded to perform the compare operations and is usually SPFCompare.dll.

Parameter 4 type

String

Parameter 5

ClassName

Parameter 5 default

None

Parameter 5 description

Code class that processes the compare and it typically SPFCompare.TEF.Compare.SPFCompareClass.

Parameter 5 type

String

The following methods use the CompareLatestRetrievedData client API to compare the latest retrieved data against the data in the authoring domain.

  • CompareLatestRetrievedDataForIPD

  • CompareLatestRetrievedDataForProcessCase