Locked Fields

Requirements

1. Connector has to be a level 3 connector. Meaning that has to have support for source and destination.

2. IMPORTANT: The locked Fields will only run on a second or later sync. If you are running a first sync, the locked fields will not work as expected. This is because the locked fields need to have a previous version of the content to compare against.

What are Locked Fields?

Locked fields are fields that will not be updated on the destination content. This is useful when you want to keep some fields on the destination content, but you want to update other fields.

Locked Fields

When editing a mapping for a job, you can set the destination locked fields. If the connector for the endpoint supports listing fields, a dropdown can be opened to select the fields.

mapping-locked-fields-dropdown.png

This is a comma separated list of fields. Each field listed will be locked at the destination.

mapping-locked-fields-value.png

Handling Languages/Locales

If the connector supports languages/locales, the locked fields will be applied to the fields following this priority:

1. If the destination endpoint has only one language, the locked fields will be applied to that one, even when the source endpoint language doesn't match.

2. If the destination endpoint has more than one language, the locked fields will be applied to the language that matches the source endpoint.

How to use Locked Fields via API?

To use locked fields, you need to create a content mapping config with the locked fields. The locked fields are defined in the destinationLockedFields array. If the uniqueName attribute is set, then the destination field will not be updated.

Example

{
    "endpointId": "8eb1794f-b0e7-45f0-911d-45c2dd2798c6",
    "destinationContentTypeUniqueName": "iMapped",
    "fieldMappings": [
        {
            "sourceFieldUniqueName": "body",
            "destinationFieldUniqueName": "wysiwyg"
        }
    ],
    "destinationLockedFields": ["headline,myLockedField"]
}