Starting with version 3.7, a new status, UIDUpdated, is added to ObjectStatusInTool enumeration as shown below.
enum (
Deleted = 1,
Moved = 2,
Unclaimed = 3,
UIDUpdated = 4
} ObjectStatusInTool
The tools that can support UIDUpdated status in GetObjectStatusInTool and GetRelationshipStatusInTool must implement the IEFAdapter4 interface.
If the tool supports the IEFAdapter4 interface, the SmartPlant Client will call the
GetObjectStatusInTool and GetRelationshipStatusInTool methods on IEFAdapter4 interface
instead of the same methods found on IEFAdapter interface.
UIDUpdated status
An object’s identity can change in the tool between publishes for any of several reasons. One such reason is a tool data restore, which forces users to recreate objects and results in a new identity for the object. Since the tool cannot publish the old UID and the UID is found to be missing from the publish, the GetObjectStatusInTool method is called. If the tool has enough knowledge to know the new ID of the object, it should return UIDUpdated status with the sObjNewUID argument set to the new UID of the object. The SmartPlant Client will generate an UpdateUIDInstruction for UIDUpdated returned status, and the SmartPlant Server will update the UID of the object from the old to the new in the SmartPlant Foundation database.