Record Migration Mode allows you to migrate large numbers of object records by only enforcing minimal constraints such as data type and length. You can create records in any lifecycle state and manually set standard and system-managed fields such as Name, ID, or Created By.
You can apply Record Migration Mode when creating or updating object records using the Vault REST API, Vault Loader, the Vault Loader Command Line Tool, configuration migration packages, and test data packages. You must have the Record Migration permission to apply migration mode using these options.
Note: Record Migration Mode is separate from Configuration Mode and has different functionality.
When Record Migration Mode is enabled, Vault allows you to set or edit values for fields that are normally not editable when creating and updating records. However, you cannot set formula fields with Record Migration Mode.
| Item | Requirements |
|---|---|
| Standard and custom fields | Must be a valid data type and length. Record Migration Mode applies default values to omitted fields. To make a field value blank, include the field but leave the value empty. |
| ID | Supported in Create actions only. Must be a unique sequence of 15 uppercase alphanumeric characters, where:
For example, 00PZA1B2C3D4E5F. |
| Global ID | Must be valid and in the format {vault id}_{record id}. |
|
If you include either Created By or Modified By, you must include both. If you include either the Created Date or the Modified Date, you must include both, and neither date can be in the future. The Created Date must be earlier than or equal to the Modified Date. If omitted, Created By and Modified By default to the currently authenticated user, and Created Date and Modified Date default toNow(). |
| Picklist values | Must exist but can be inactive. |
| Object type fields | Fields must exist on the Object Type. |
| Object references | Must exist but can point to inactive records. |
| Lifecycle, lifecycle state, and lifecycle stages | Must exist but can be inactive. If omitted, Record Migration Mode applies default values. The default value for a lifecycle state is its initial state. If you include any lifecycle stage fields, you must include all lifecycle stage fields. |
| Lookup fields | Must be the correct data type. You must include the related record ID. For standard volume objects, if a Lookup field value does not match the source record, Record Migration Mode does not overwrite the field value until the related record ID is updated. Raw objects always overwrite the field value with the correct lookup value. |
| Roll-up fields | Must be the correct data type. If a Roll-up field value does not match the specified child records, Record Migration Mode does not overwrite the field value until the child records are updated. |
How to Use Record Migration Mode
You must have the Record Migration permission to apply migration mode using these options.
Create Object Records API
Use the Vault REST API’s Create Object Records and set the X-VaultAPI-MigrationMode header to true, which applies Record Migration Mode to any object record created or updated in that request.
Set the X-VaultAPI-NoTriggers header to true to bypass triggers when Record Migration Mode is enabled.
Vault Loader API
Use the Vault REST API’s Load Data Objects endpoint and set the recordmigrationmode parameter to true. To also bypass record triggers, set the notriggers parameter to true.
Vault Loader UI
When creating or updating records in bulk with Vault Loader, select the Record Migration Mode checkbox to apply migration mode. The No Triggers option allows you to bypass record triggers.
Vault Loader CLI
Use the -recordmigrationmode parameter in the Vault Loader Command Line tool. To also bypass record triggers, use the -notriggers parameter.
Configuration Packages & Test Data Packages
When editing the settings for a data object in a configuration migration package or test data package, select the Record Migration Mode checkbox to apply Record Migration Mode.