pub.synchronization.xref:createXReference
WmPublic. Creates a cross-reference between a canonical key and a native ID.
Input Parameters
appId | String A unique identifier for the resource (application) for which you want to create a cross-reference to a canonical key. |
nativeId | String A unique identifier for the resource record for which you want to create a cross-reference to a canonical key. |
canonicalKey | String Optional. A canonical key. If a canonical key is not provided as input, createXReference creates the canonical key and the cross-reference. |
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
canonicalKey | String The canonical key. This key correlates native IDs of records from different resources. This will be a new, unique key if canonicalKey was not provided as an input parameter. If canonicalKey was provided as input, this output parameter returns the same value. |
Usage Notes
The canonical document is the standard format that a document assumes while it travels through webMethods components. A source resource will convert or map data from its proprietary data format into the canonical format before publishing the document. A target resource (a subscriber to the canonical document) will map the canonical document to the target resource's proprietary data format before processing the document. The canonical document acts as the intermediary data format between resources.
On the source side of the synchronization, use the createXReference service to create the canonical key for the canonical document and establish a cross-reference between the record in the source application and the canonical document. Before publishing the canonical document, link the generated canonicalKey to the canonical document.
On the target side of synchronization, use the
pub.synchronization.xref:insertXReference service to insert the cross-reference between a canonical key and the native ID for the record in the target resource.
For more information about using the createXReference service to create synchronizations, see the Publish-Subscribe Developer’s Guide
See Also