MergeRecord Parameters and Valid Execution Modes

The valid execution mode for MergeRecord is SYNCHR.

The parameters of MergeRecord are as follows:

MergeRecord Parameters
Name Semantics Type Valid Values Multi-plicity
Direction: In
AllowMerge
AttributeList
(Optional) List of record attributes to be merged.

You can specify either the SkipMergeAttributeList or the AllowMergeAttributeList parameter. If both the parameters are specified, an error message is displayed.

Required to pass the matchRecordProcessLogID as ReferenceStepID.

ArrayList Any valid attribute name. 0..1
SkipMerge
AttributeList
(Optional) List of record attributes to be skipped from merging.

You can specify either the SkipMergeAttributeList or the AllowMergeAttributeList parameter. If both the parameters are specified, an error message is displayed.

Required to pass the matchRecordProcessLogID as ReferenceStepID.

ArrayList Any valid attribute name. 0..1
InDocument
(Optional) The document that contains the source record to be merged.
  • If InDocument is not specified, the record from the current event is used for merging.
  • If the document contains relationships, the source relationships are not merged. However, target record relationships are always maintained.
Document Any valid MLXML document. 0..1
IncludeDraft
Records
(Optional) See Common Parameters. Boolean TRUE (Default) 
FALSE
 0..1
ReferenceStepID

(Mandatory only in case of Bulk Import, otherwise Optional)

The ReferenceStepID is mapped to the MatchRecordProcessLogID out parameter of the MatchRecord activity. Long Any valid integer 0 or 1
RejectFlag
(Optional)
  • When you add a record and if this parameter is set to TRUE, the source record is rejected after merging the data.

    When you modify a record and if the source record is in the CONFIRMED state, the state can not be changed to REJECTED.

  • If this parameter is set to FALSE, the source record is merged with the target record, but it will not be rejected. However, in case of Modify record, its version will be changed.
Boolean 
TRUE
(Default)

FALSE

0..1
SaveFlag (Optional) Applicable for all modes, such as, Bulk, InDocument, and Legacy.
  • If this parameter is set to SAVE, target record is saved after it is merged.
  • If this parameter is set to NOSAVE,
    • Target record is not saved after it is merged.
    • By default, the OutDocument is generated. That is, merged data is returned in the MLXML format. The OutDocument is generated only for a single record merge single record hierarchy merge.
    • The FILE attributes are not merged in the resultant OutDocument.
String SAVE

(Default) 

NOSAVE
 0..1
SourceRecordKey(Optional) The record key of the source record to be merged.
  • This parameter accepts only one record key as input.
  • If InDocument is specified, the SourceRecordKey must match one of the records from the InDocument.
  • If the source record key is not found in the InDocument or the current event, an exception is not thrown and the activity will skip processing.
String Any valid record key. 1
TargetRecordKey (Optional) The record key of the target record with which the source record needs to be merged.
  • This parameter accepts only one record key as the input.
  • If the target record key is not found, an exception is not thrown and the activity will skip processing.
String Any valid record key. 1
VersionOption
(Optional) See Common Parameters.

Only applicable in case of a single record add.

String CONFIRMED (Default) 
LATEST
 0..1
ImplicitRelationship
Merge

(Optional)

Indicates if any non-matching relationships must be merged between source and target record(s).

This works only for direct merge.

For more information on using the Implicit Relationship Merge, refer to TIBCO MDMCustomization Guide.

Boolean True (Default)

False

0..1
MergeRecordUsing
LegacyProcess

(Optional)

If this parameter is set to TRUE, you can merge only one level of data. You cannot merge hierarchy data. For relationship merge, this feature is backward compatible with 8.0. Using this parameter, you can specify target and source records directly without invoking MatchRecord activity. Boolean True

False (Default)

0..1
MergeTargetIn
Outdoc

(Optional)

Use to replace the source record values with the target record values. By default, the Outdoc consists of the source record values. Boolean True

False (Default)

1
Direction: Out
OutDocument Merged data is returned in a format specified by the user. Document N/A 0..1
RecordKey Contains record key IDs of the matching records merged.

Not applicable in case of a single record.

Arraylist   0..1