pub.synchronization.xref:insertXReference

WmPublic. Inserts a cross-reference between a native ID and a canonical key.

Input Parameters

appId	String A unique identifier for the resource for which you want to establish a cross-reference between a native ID and a canonical key.
nativeId	String A unique identifier for the resource record with which you want to establish a cross-reference to canonicalKey.
canonicalKey	String The canonical key with which you want to establish a cross-reference to nativeId.
objectId	String A unique identifier for the object or process being synchronized. Typically, the objectId field is set to the name of the business process for which you are performing synchronization, such as "order" or "customer."

Output Parameters

None.

Usage Notes

Use this service on the target side of a synchronization to create a cross-reference between the new record in the target resource and the canonical document.

Most resources generate a unique ID for a new record. Invoke the insertXReference service after you add the new record in the resource.

After you insert the cross-reference between the new native ID and the canonical key, use pub.synchronization.latch:closeLatch to close the latch for the record to prevent circular updates (echoes).

For more information about using the insertXReference service in synchronizations, see the Publish-Subscribe Developer’s Guide.