Before synchronizing the objects generated from within Connect with the parsed map schema objects, the GetSynchronizeOptions method will be called. This method allows the metadata adapter to define the default behavior to be used during the synchronization process.
eOnlyInGeneratedMapSchemaOption identifies the option that should be applied to objects that only exist in the generated map schema. The values that the metadata adapter can specify for this option are: (1) AddToContainer2 and (2) DeleteFromContainer1. If the metadata adapter specifies AddToContainer2, then any object in the generated map schema that is not in the parsed map schema will be added to the parsed map schema. If the metadata adapter specifies DeleteFromContainer1, then the object will be deleted from the generated map schema container.
eOnlyInParsedMapSchemaOption identifies the option that should be applied to objects that only exist in the parsed map schema file. The values that the metadata adapter can specify for this option are: (1) AddToContainer1 and (2) DeleteFromContainer2. If the metadata adapter specifies AddToContainer1, then any object in the generated map schema that is not in the generated map schema will be added to the generated map schema. If the metadata adapter specifies DeleteFromContainer2, then the object will be deleted from the parsed map schema container.
An important item to note is that relationships that relate the map schema objects to and from the SmartPlant schema objects are excluded from the comparison and will not be impacted by the value for eOnlyInParsedMapSchemaOption.
eInBothButDifferentOption identifies the option that should be applied to objects that exist in both the generated map schema and the parsed map schema but that have different property values. The values that the metadata adapter can specify for this option are: (1) UseValuesFromContainer1, (2) UseValuesFromContainer2, (3) UseValuesFromContainer1IfSet and (4) UseValuesFromContainer2IfSet. If the metadata adapter specifies UseValuesFromContainer1, then for all cases where the property values are different, the value from the generated map schema object will be used to update the value for the parsed map schema object. Likewise, if the adapter specifies UseValuesFromContainer2, then the value from the parsed map object will always be used to update the value for the generated map schema object. If the adapter specifies UseValuesFromContainer1IfSet, then the value from the generated map schema object, if set, will be used to update the parsed map schema object. If not set, the parsed map schema object’s property will not be updated. Likewise, the UseValuesFromContainer2IfSet option will update the generated map schema object if the value is set for the parsed map schema object.
Properties that are not expected to be managed by the application such as MappingStatus, MapNote and the Unmapped* properties will be ignored during the comparison and will not be updated based on the eInBothButDifferentOption value.