Inactivating custom keys


Custom keys must be unique but after record merges or other data processes an active custom key might exist on the "wrong" entity. You can inactivate the custom key on that entity so you can use the same key on another entity. Inactivating keys is also useful if custom keys were incorrectly created during an integration.

Custom keys can be inactivated using source subscriptions or using the Network API.

Source subscription

Use a source subscription to load a .csv file that will inactivate the custom keys.

Create the file

Create a .csv file named entity.csv and add the custom keys that you need to inactivate.

The file must contain the following columns:

  • entity_vid__v - The Veeva ID (VID) of the entity that owns the key. For example, this might be the merge winner.

  • entity_type__v - The entity type.

  • vid__v - The Veeva ID of the custom key.

  • custom_key_status__v - The key status. The value in this column must be I (Inactive).

Sample file

Create the subscription

To create the source subscription:

  1. In the Admin console, click System Interfaces > Source subscriptions.

  2. Click Add Subscription > Use Classic Mode.

  3. Type a Name and Description for the subscription.

  4. Choose the System.

  5. Note: In the Settings section, accept the default selections.

  6. In the Source Files section, define the FTP Path.

  7. Below the File Definitions heading, click Add File. Add these file definitions to the subscription.

    File definitions

  8. In the Modelling & Normalization section, copy and paste this model map to the Model Map field.

    Model map

            "entity": "HCP",
            "from": "KEYOWNER WHERE KEYOWNER.entity_type__v = 'HCP'",
            "attributes": [
                "KEYOWNER.VDM_* AS *",
                "KEYOWNER.entity_vid__v as vid__v"
            "entity": "HCO",
            "from": "KEYOWNER WHERE KEYOWNER.entity_type__v = 'HCO'",
            "attributes": [
                "KEYOWNER.VDM_* AS *",
                "KEYOWNER.entity_vid__v as vid__v"
            "entity" : "CUSTOMKEY",
            "from": "ENTITY JOIN KEYOWNER ON ENTITY.entity_vid__v = KEYOWNER.entity_vid__v",
            "attributes": [
    			"ENTITY.VDM_* AS *",
    			"ENTITY.vid__v as vid__v",
    			"ENTITY.custom_key_status__v as custom_key_status__v",

    Note: Network Expression Rules and Match Configuration are not required for this subscription.

  9. In the Job Schedule section, choose Manual, so you can start the job when the configuration is complete.

  10. Click Advanced Mode and add the following advanced property to the Module Properties field:

    "": "entity_vid__v",
  11. Save the subscription.

  12. Click Start Job to run the subscription.

When the subscription runs, the custom key status will be set to Inactive.

Network API

Network administrators and Integration Users can use the Network API to inactivate custom keys.

For more details, see the Disassociate custom key and Batch disassociate custom key API details in the Veeva Network API Reference: