These properties are used to control what happens to related objects when an object is claimed into a lower configuration. The related objects can be left where they are, automatically claimed along with the parent object or presented in a confirmation dialog box for user selection. Options are:
-
Null
-
Required (stored in XML as ReqdObj)
-
Optional (stored in XML as OptionalObj)
-
Expand - Used to handle retrieve scope definition
-
Include - Used to handle retrieve scope definition (only allowed for to-one relationship edges).
SPFDocRevisionPlantItem is configured with Claim12=OptionalObj to support optional claiming of related plant items when the document is revised into a lower configuration.
In the following, the examples are for the development layer.
-
DEVTagTag is configured with Claim12=ReqdObj. This relationship is the parent-child tag relationship. When the parent tag is claimed into a lower configuration, the child tags are automatically claimed.
-
DEVSystemTag is configured with Claim12=OptionalObj. When a system is claimed into a lower configuration, the user is presented with a dialog box to claim related tags.
The following explain the logic behind these options:
-
If the claim flag is ReqdObj or Expand, then all objects across the relationship definition are retrieved.
-
After all the ReqdObj and Expand objects have been fetched, then a second pass is made to determine if there are any additional objects that need to be included (by checking for Include flags). If any objects are found that have not previously been fetched, they are NOT expanded per the previous bullet. However, they are legitimate objects for further inclusion checks.
-
A third set of objects, objects across relationships that apply to the data flow (such as, 3D AsBuilt), but for which the claim flag is not set, is also be returned but neither expanded nor included.