CompareRecord Parameters and Valid Execution Modes

The Compare Record activity is not enabled for DRAFT records. Therefore, you cannot compare the previous draft version of a record. You can only compare with the previous confirmed or last version. When the last version is indicated, last confirmed or unconfirmed version is selected.

The valid execution mode for CompareRecord is SYNCHR.

The parameters of CompareRecord are as follows:

CompareRecord Parameters
Name Semantics Type Valid Values Multi–

plicity

Direction: In
InDocument
(Mandatory) See Common Parameters.      
CompareKeyword
(Optional) The version to compare with. You can compare with the last valid confirmed version or last version (confirmed or unconfirmed). There is no default. string PREVIOUS_CONFIRMED_VERSION (Default) 
PREVIOUS_VERSION
 1
FullCompareFlag
(Optional) Indicates if the output should include fields which have not changed. If true, even if there is no difference in the attributes of the two products, attributes are listed. string True

False (Default)

1
CompareMode

(Optional)

Indicates the difference between related records if they are added, modified, or removed. To know the difference between related records, specify the BUNDLE value.

Consider the scenario, if the Customer repository is related to the Address repository, and a1 record in the Customer repository is related to b1 record in Address repository.

  • If you modify the a1 record by creating a new b1 related record. The output document shows the details of the newly added related record
  • If you modify the a1 record by deleting the b1 related record. The output document shows the information about the deleted related record.

    The difference details are displayed under <ChangedRelationshipData> element in the <ActionLog/> tag.

string The valid value is BUNDLE. 1
Direction: Out
OutDocument
(Optional) See Common Parameters.

A copy of InDocument with differences. If no differences found, this will return null.