Xoom.DataProcessing.ShouldCorrectMismatchedReferences

Specifies whether, in the case of there being an inconsistency between optional key values in the representation and the target, those mismatched references should be corrected in the target on deployment or marked as bad references.

Takes values: true/false
Default: false
Release: 3.7

Details

Prior to Xoom 3.7, when multiple key-values are used to determine the referenced item during retrieval, Xoom used the required key-values to determine the targeted items, ignoring the optional key-values. If the targeted item was found successfully, then the optional key-values were recreated on the target environment so as to be consistent with the targeted item, regardless of their values in the source environment.

This is almost always exactly the desired behaviour. However, there are cases where optional key-values in the source environment are inconsistent with required key-values due to misconfiguration, and the desired targeted item is the one that is actually referenced by the optional key-values (it all depends on how the setting was originally created and transported into the source environment). In those cases, automatic correction of those key values during transportation is not the desired behaviour. In response to this, we made the decision to err on the side of caution from 3.7 onwards.

Now:

If the required key-values are inconsistent, you’ll get a bad reference without a warning, just as with previous versions of Xoom.
If the required key-values are consistent but the optional key-values are inconsistent with the targeted item, then Xoom will place a warning with the description of the problem on the reference, including the key-values that are mismatched. The type of reference created will then depend on the value of this parameter. By default the parameter is set to false: the reference will be marked as a bad reference, and will show as such during deployment (for example in Settings Migration Tool), allowing the user to address the problem at source. To restore the behaviour as it was in previous versions of Xoom, change the value of the parameter to true: the reference will be ‘good’ and the optional key-values will be recreated during deployment, consistent with the targeted item.