Exporting third-party master DCRs

AD
DM

Data change requests (DCRs) for third party master are assigned to the third party system that owns the record in Network. These DCRs must be extracted and exported to the third-party provider to process. If they are not exported, the records will not be updated in Network with the requested changes.

DCR process for third-party mastered records

Extract the DCRs for the third-party master system.

This can be done through the following methods:
- Target subscription - The DCR export job creates two files (DCR_BATCH, DCR_FIELD_BATCH) that contain the requested changes and any add requests.
- Network API - For details, see the API: Third-party integration topic in the Veeva Network Developer Help.
Retrieve the files from the Network FTP server and send them to the third-party data provider.
Third-party data stewards update the DCR_BATCH file by adding CHANGE_ACCEPTED or CHANGE_REJECTED to the Results column.
Receive the updated DCR file from the third-party data provider and add it to the Network FTP server.
Use the third party master feed (source subscription) to import the updated DCR file back into Network. The contents of the file will update the DCR tasks in Network. The data files included with the master feed will make any updates to the affected third-party records.

About the DCR export file

Only fields that are identified as externally managed by the third-party master system are included in the exported DCR file. Fields that are managed by local data stewards (gray fields) are filtered out.

Note: During a DCR export, no data (including data entities, source data, or reference data) is exported.

DCR export subscription

To configure the subscription:

In the Admin console, select System Interfaces > Target Subscriptions. At the top of the Target Subscriptions page, click Add Subscription.
In the Details section, provide the following information:
- Name: This value is mandatory and must be short.
  Special characters and spaces are not supported. Use underscores in place of spaces.
- Code: Displays after the target subscription is saved.
  The code is automatically generated from the name of the target subscription and is used for exporting Network configurations. The code does not change if the subscription name changes.
- System: Select the third-party master system.
  Network will extract the DCRs for the records owned by this system.
- Description: Provide a meaningful description that is helpful to other users.
- Status: New subscriptions are Enabled by default. They can be inactivated when they are no longer regularly used. For more information, see Inactive subscriptions.
In the General Export Options section, define the DCRs and details to export.
- Full Data Extract
  - Full - Export all DCRs submitted for this third-party provider.
  - Delta - (recommended) Export only the DCRs that were created since this subscription ran last.
- DCR Status
  - Pending Only - (recommended) Export DCRs that have not yet been processed.
  - All DCRs - Export DCRs with all task statuses.
- Save Delta State - (Applies to Full DCR exports only). Choose this option if you want the export to save the last delta ID A number assigned to a record that is incremented every time that a record is updated in any way. that is exported as the delta state.
- Include Parent HCO Master Key - Include the master key of the parent HCO when a DCR with a relationship is exported.
  
  This is helpful so a third-party provider can easily identify the parent HCO and process the DCR.
  
  Three columns will be added to the exported file:
  - PARENT_ENTITY_CUSTOM_KEY_SOURCE
  - PARENT_ENTITY_CUSTOM_KEY_TYPE
  - PARENT_ENTITY_CUSTOM_KEY_VALUE
  The columns contain the active custom key of the related parent HCO object for the selected third party system. If there are no active custom keys on the parent HCO object, or if the ENTITY_TYPE of the row is not "RELATION", these columns are empty.
- Multiple value fields delimiter - Define the delimiter for multivalued fields that are sent to downstream systems.
  
  Change the delimiter if the downstream system expects a different delimiter.
  
  The following delimiters are supported:
  - , (comma) (default)
  - : (colon)
  - ; (semi-colon)
  - tab
  - | (pipe)
- Format and Encoding is automatically set to CSV and UTF-8 respectively.
- Network FTP Path - Choose the Default path or identify a Custom path.
  - Default path: outbound/<system_name>.
  - Custom path - Administrators can give users specific access to FTP folders, so identifying a custom path for this subscription enables you to protect the data.
    
    Custom paths are not validated, so ensure that they are correct so your job does not fail.
    
    For more information about identifying FTP folder access for users, see Add a user profile.
  For information about accessing the files in your Network file system, see File Explorer.
- Export to Cloud Storage - Export the data directly to your private cloud storage. Exporting to Amazon S3 buckets are supported.
  
  The Amazon S3 bucket must be created with write access so you can export the files. For more information, see Exporting data to cloud storage.
  
  External Credential Location - If you chose Export to Cloud Storage, this setting displays. Select the Amazon S3 credential from the list or click the link to create the credential. Click Test Connection to ensure that the credentials are valid.
  
  Note: The files are always exported to your FTP folder so Network FTP Path remains selected if you also choose Export to Cloud Storage.
Transformation Rules (optional) - Apply rules to transform the data before it's exported to the third-party system. Create transformation rules using Network Expressions for the third-party system, object, and field.

For details, see Transformation rules.
Transformation Queries (optional) - Apply queries to the target subscription to post-process the DCR export files (third-party owned DCRs). For example, you can transform the third-party DCRs in a format that a third-party system might expect to receive. For example, see Transform DCR export files.

The queries will transform the data within Network before exporting it in the target subscription.

Example
In the Job Schedule section, choose to run the subscription manually or on a scheduled basis. If you select Manual, the subscription only runs when you click the Start Job button on the subscription page.
You can choose to trigger other actions to start after a job runs. For more information, see Subscription job triggers.
Save your changes and run the job.

Job history

The job history for the subscription indicates the number of DCRs processed for each entity type along with the export path for the DCR files. The DCR Line Items count indicates the number of rows in the DCR_FIELD_BATCH file.

Exported files

After the job runs, the exported archive files are saved in the Network FTP path for the target subscription, within a sub-folder named for the third-party system.

The archive file, for example, Third_party_DCRS_180109T112242447, contains two files:

DCR header file (DCR_BATCH) - Contains the DCR header information. The file is timestamped in Epoch time.
DCR line items file (DCR_FIELD_BATCH) - Contains information for each field added or changed through the DCR. The file is timestamped in Epoch time.

DCR header

File details

Column Name	Explanation
DCR ID	Unique identifier of the DCR generated in Network Example: 908541658826540032
DCR SECTION ID	Unique identifier of the DCR section (HCO, HCP, Address, Relation, or License) Example: 908541649959781376
DCR TYPE	Describes whether the DCR is an add request or a change request (ADD_REQUEST or CHANGE_REQUEST)
SUBJECT	The name of the entity or sub-object in the DCR. Example (HCP): Megan Grass
ENTITY TYPE	Type of added/changed Network entity (HCO, HCP, Address, Relation, License)
ENTITY ID	Unique identifier of the Network entity (can be NULL) Example: 908138316476449792 There will be no value if the DCR was an add request and the Create Unverified setting (Workflow Settings) in Network is off. In this case, the VID will be added when the DCR is updated in Network and the record is created.
CUSTOM KEY SOURCE	Unique identifier of the third-party master system. Example: TPM The value is NULL for add requests.
CUSTOM KEY TYPE	Name of the entity in the third-party master system. Example: HCP The value is NULL for add requests.
CUSTOM KEY VALUE	Unique identifier of the entity in the third-party master system. Example: 20151027100 The value is NULL for add requests.
RESULT	No value for pending DCRs. The third party master data stewards add a value to this column to accept or reject the changes. For full exports, the value is the final result of a processed DCR. Possible values: CHANGE_ACCEPTED - all changes for this request have been accepted CHANGE_REJECTED - no changes for this request were accepted CHANGE_PARTIAL - at least one field change was accepted
COMMENT	No value for pending DCRs. Third party data stewards can optionally add a comment.
DCR STATUS	Workflow status of the DCR in Network Possible values: CHANGE_PROCESSED - change request was processed and a result issued CHANGE_NEW - change request has been received, but not yet run CHANGE_PENDINGREVIEW - change request was received and processed, but is pending review by data stewards or other upstream sources CHANGE_INQUEUE - the received change request is made on an unverified object and is pending for the parent task to be processed CHANGE_PARTIALLYPROCESSED - change request was partially processed by third party master data stewards CHANGE_CANCELLED - change request was canceled
CREATED AT	Date when the DCR was created. The date format uses the ISO8601 standard and is the timezone of the Network instance server. Example: 2016-05-03T02:45:22.000-05:00
COMPLETED AT	No value for pending DCRs. Date when the DCR was completed. The date format uses the ISO8601 standard and is the timezone of the Network instance server. Example: 2016-05-06T05:53:56.000-05:00
CREATOR	Network user name of the creator of the DCR Example: edward.cole@verteo.com
CREATOR NOTE	Notes by creator of the DCR Example: Adding new HCP
RESOLUTION NOTES	Workflow notes (system generated) Example: System approved - Created by data steward.
COUNTRY	The country code of the entity. Example: GB (United Kingdom)
PARENT_ENTITY_CUSTOM_KEY_SOURCE	The source for the active custom key of the related parent HCO object. This column displays only if the Include Parent HCO Master Key option is selected in the target subscription configuration. If there are no active custom keys on the parent HCO object, or if the ENTITY_Type of the row is not RELATION, the column is empty.
PARENT_ENTITY_CUSTOM_KEY_TYPE	The type for the active custom key of the related parent HCO object. This column displays only if the Include Parent HCO Master Key option is selected in the target subscription configuration. If there are no active custom keys on the parent HCO object, or if the ENTITY_Type of the row is not RELATION, the column is empty.
PARENT_ENTITY_CUSTOM_KEY_VALUE	The value for the active custom key of the related parent HCO object. This column displays only if the Include Parent HCO Master Key option is selected in the target subscription configuration. If there are no active custom keys on the parent HCO object, or if the ENTITY_Type of the row is not RELATION, the column is empty.

Example file

DCR line items

File details

Column Name	Explanation
DCR ID	Unique identifier of the DCR generated in Network Example: 908541658826540032
DCR SECTION ID	Unique identifier of the DCR section (HCO, HCP, Address, Relation, or License) Example: 908541649959781376
DCR TYPE	Describes whether the DCR is an add request or a change request (ADD_REQUEST or CHANGE_REQUEST)
SUBJECT	The name of the entity or sub-object in the DCR. Example (HCP): `Temple Practice`
ENTITY TYPE	Type of added/changed Network entity (HCO, HCP, Address, Relation, License)
ENTITY ID	Unique identifier of the Network entity (can be NULL) Example: 908138316476449792 There will be no value if the DCR was an add request and the Create Unverified setting (Workflow Settings) in Network is off. In this case, the Veeva ID will be added when the DCR is updated in Network and the record is created.
CUSTOM KEY SOURCE	Unique identifier of the third-party master system (can be NULL) Example: TPM_Data The value will be null if this is an add request - the data is not in the third party system yet so a custom key has not been defined.
CUSTOM KEY TYPE	Name of the entity in the third-party master system (can be NULL) Example: HCO
CUSTOM KEY VALUE	Unique identifier of the entity in the third-party master system (can be NULL) Example: 20151027100
FIELD NAME	Name of the changed field Example: specialty_1__v
OLD VALUE	Field value before the requested change (can be NULL)
CHANGE REQUESTED	New field value Example: GP
FINAL VALUE	No value for pending DCRs. Final field value after the DCR is processed Example: GP
FIELD STATUS	No value for pending DCRs. Final status of the field after the DCR is processed (CHANGE_ACCEPTED or CHANGE_REJECTED)

Example file

Next steps

To complete the DCR process:

Send the exported DCR files to the third-party data provider to process.

The third-party data stewards must update the Results column in the DCR_BATCH file with one of the following values:
- CHANGE_ACCEPTED
- CHANGE_REJECTED
Retrieve the completed DCR_BATCH file from the third-party data provider.
Import the updated DCR_BATCH file back into Network using the source subscription that is the third-party master data feed. For details, see Importing third-party DCRs.