DM
Enabling Network Address Inheritance
To simplify address management, use Network Address Inheritance to automatically apply the address of a parent HCO to its child HCP or HCO address. Any changes made to the parent HCO's address are also made to the inherited address on the child HCO or HCP.
Enable the feature
To enable the feature, contact Veeva Support.
Enable the address inheritance fields
After Veeva Support enables the feature, Administrators can enable the fields in their Network instance.
- From the Admin console, select Settings.
- On the General Settings page, click the Edit button.
- In the Address Inheritance section, select Enable Address Inheritance Data Model Fields.
- Click Save.
The fields required for address inheritance are now enabled on the Address object (Data Model).
- parent_address_vid__v
- parent_address_sync__v
- parent_address_entity_vid__v
Note: Turning off the Enable Address Inheritance Data Model Fields setting will disable the fields.
Parent address sync field
The parent_address_sync__v field uses the following reference codes:
Code | Status | Description | Action |
---|---|---|---|
S | Synced | The address has been copied from a parent address. | Addresses can be copied from parent addresses in DCRs, through data load, or through the Refresh Job on the Network Address Inheritance page (Data Model). |
U | Unsynced | The copied address from the parent has been changed. | The status is set if users change a synced address on the profile page, or if the address is changed through data load. |
R | Re-sync | Triggers the address to be copied from the parent address again. | The status can be set by data stewards from the record profile. It can also be set through data loading so that an unsynced address can be synced back to its parent address. |
D | Disqualified | Indicates that the previously copied (synced) address no longer meets the address inheritance criteria. The address status will be updated to Inactive | This is set by Network when the parent address or relationship is inactivated or no longer meets the Network Address Inheritance criteria. |
Parent address entity VID field
Use the field to quickly identify where the address was copied from.
Updating the field
The parent_address_entity_vid__v
field is read-only.
It is populated whenever the record is changed through the following methods:
-
Changes to any field (HCP, HCO, or sub-object field) will trigger it to be populated.
-
Running the Refresh Job on the Network Address Inheritance page (Data Model) will update the field on existing synced addresses.
Configure address inheritance
Address inheritance configurations can apply to one country or multiple countries. You can configure the behavior to copy addresses for specific circumstances; for example, only copy Professional addresses for selected countries.
Considerations for multiple countries
When configurations apply to multiple countries, the available choices include the full list of reference codes and address fields for those countries. However, the address inheritance configuration will only copy addresses if the reference code applies to the country.
Define a configuration
-
From the Admin console, select Data Model > Network Address Inheritance.
-
Countries - Define the countries to include in the configuration.
-
Automatically create link - Select this option to link existing addresses on records to the parent HCO's address if the addresses match.
When an HCP or HCO is updated, Network reviews the existing addresses and searches the associated Parent HCOs on the record for an identical address. If a match is found, Network links the addresses. Any changes to the Parent HCO address will be reflected on the child record's address.
-
HCP- HCO and HCO-HCO hierarchy types - Define the types that will apply to the countries.
For each Type field:
-
Choose specific values.
-
All Reference Values
- Select all values. -
No Value
- Use if data is missing for HCP Type or Relationship Type type fields so address inheritance can be applied to a record. A blank field does not specify a null value.
Note: If you select All Reference Values and No Value in a Type field, all types (including null values) are included in address inheritance.
-
-
Address Fields Sync- Select the fields to include when addresses are updated.
Use the Arrow (< >) icons to move the fields in the Available Columns pane to the Selected Columns pane.
To remove fields, select fields in the Selected Columns pane and click the < button to remove them from the list of fields to include.
Note: Mandatory address fields cannot be removed from the Selected Columns pane.
- To create configurations for other countries, click the +Add Countries.
-
Schedule or run the Refresh Job Schedule to update addresses that become out of sync.
For more information, see Refreshing addresses.
-
Save your changes.
Configuration changes
If the Network Address Inheritance configuration no longer complies for an address, the address will be inactivated on update.
For example, if the address inheritance configuration is changed to update only Professional addresses, all Mail-Only addresses will be inactivated and the parent_address_sync__v
field value will be updated as Disqualified.
Link parent and child addresses to establish inheritance
After Network Address Inheritance is configured, link existing addresses on child HCPs and HCOs to affiliated parent addresses so the child addresses become inherited.
Use the following methods:
-
Automatically link addresses
-
Link addresses by data loading
Both methods might be required. If the Automatically create link option is set, parent and child addresses are linked only if they are an exact match. For addresses that are not identical, use a source subscription to populate the parent_address_vid__v and parent_address_sync__v fields for the addresses to become inherited.
Automatically link addresses
Select the Automatically create link option in the Network Address Inheritance configuration to create inherited addresses.
How it works
When an HCP or HCO record is updated in any way, Network will check if it has a Parent HCO with an identical address. Address comparison rules are used to find matching addresses.
If matching addresses are found, Network automatically links the addresses by populating the Network Address Inheritance fields on the child address:
-
parent_address_vid__v
-
parent_address_sync__v
The child address becomes inherited.
Link addresses by data loading
To establish links between parent addresses and child addresses, use a source subscription to populate the following fields on the child address:
-
parent_address_vid__v - The VID of the address on the Parent HCO.
-
parent_address_sync__v - Set the value to S to indicate that the address is synced to the parent address.
Prerequisite
Administrators must enable address inheritance in the subscription’s module properties.
- From the admin console, select System Interfaces > Source Subscriptions.
- Select a source subscription and click the Advanced Mode button.
- In the Edit Module Properties dialog, add or update the following property:
"job.nai.enabled": "true"
- Click Ok.
- Click Save.
Run subscription
Run the subscription to create the link between the addresses. The child addresses become inherited.
Report on the Parent Address Entity VID field
The parent_address_entity_vid__v
field is included in the Network reporting tables so you can use it in SQL queries.
Example query
Use the following SQL query to report on records that have the Parent Address Entity VID field populated.
SELECT vid__v, parent_address_entity_vid__v FROM address WHERE parent_address_entity_vid__v IS NOT NULL
Example results
Considerations for Chinese instances
For Chinese instances, if a user adds a new parent HCO relationship to a Chinese record (where the primary country is set to China) for a parent HCO that is not Chinese, a warning message is displayed.