Unlike metadata, business data only exists in the environment where it was created and does not migrate to other environments. However, some application configurations and business processes require a reference to a specific business data record to function correctly.

For example, you may want to deliver a workflow definition that references a message definition which notifies everyone with a particular role when a record transitions to a workflow state. While a workflow definition is metadata that migrates through your normal process, message definitions are business data and cannot. Without delivered data, your customers would encounter workflow errors because the message definition does not exist in their environments.

Configure your data 

Create your delivered data definitions and setup records in your staging environment. From here they migrate downstream automatically.

To configure the business data you need to deliver, use the following applications:

Promote delivered data

Delivered Data Definition records are handled like other metadata for promotion purposes. Add them to a Metadata Manifest application record, then use the Promotion Manager application to move them into a promotable environment. Once promoted, the delivered data objects included in the configuration are automatically pulled into those environments and delivered downstream on the regular patch cadence.

Considerations for delivered data

There are several considerations for the delivered data process, including: 

  • If you deliver records that have table lookup fields pointing to other delivered tables, those fields must either be empty, or you must also deliver the referenced record.
  • If you deliver records that have table lookup fields pointing to tables that are not delivered, the field's value is cleared on delivery and the target sets it going forward. The target's value is never overwritten by future deliveries. These fields must be configured as unlocked.
  • You can only deliver records in tables of type Settings, Header Detail, or Main.
  • In production environments, delivered records can be identified with the DeliveredDataType field in applications.

Delivered Data Definitions application

Use the Delivered Data Definitions application to define the table that contains the business data you need to deliver into testing environments. 

Delivered data can either be completely locked, completely unlocked, or partially locked. If you select a Delivered Data Type of Delivered - Partial, you can use the Field Configurations subtable to specify specific fields as Locked.

Additionally, you can specify a logic block to run when records are delivered. The logic block must be in the same product family as the table, and it must be Public-Secured. If you specify an Insert logic block, it only runs the first time a record is delivered to an environment. Update logic blocks run each time there's a patch.

Subtables

Subtables can be configured as locked or unlocked. A locked subtable delivers and overwrites the subtable's contents in the target, which means the target cannot edit it. An unlocked subtable ships without its data, and the target's existing contents are retained. 

Header Detail tables 

To deliver records into Header Detail structures, you must specify the Header table in your delivered data configuration. Header fields can be locked, unlocked, or partially locked, like fields from other delivered table types. Detail table records deliver automatically alongside the header and are always fully locked in the target. You cannot individually configure detail fields.

Table lookups

If a delivered record has a table lookup field that points to another delivered table, that field must either be empty or you must also deliver the referenced record. 

If the lookup instead points to a table that isn't delivered, the field's value is cleared on delivery and the target sets it going forward. The target's value is never overwritten by future deliveries and these fields must be configured as unlocked.

Specify the behavior for record contention with the Yield to existing records checkbox.

Delivery indicators

The configuration record uses color to show what happens to a field or subtable on delivery: 

  • Yellow indicates the value is locked and can't be changed in the target
  • Blue indicates the value is cleared on delivery, with the target expected to set it. 
  • A field with no highlight is delivered but never overwritten once the target changes it. 

Indicators only display in the source environment where the record is defined and assigned. An unassigned record shows no highlights.

Delivered Data Setup application

Use the Delivered Data Setup application to specify the specific business data records you need to deliver.

For each record, select the table where the data is being delivered, and then identify the record by NwId. This ensures that the correct records delivered in each downstream environment.

Learn more in Deliver business data to customers and Delivered Data Definitions application.

Delivered Data Delivery application

Use the Delivered Data Delivery application to move your delivered data records from your development environment to one where you can test the configuration.

Specify a Source Zone, Source Tenant, Target Zone, Target Tenant, and the Delivered Data Tables. Then, select the Deliver Data form action.

You should only use this app for situations where you do not use the Promotion Manager to promote metadata between environments.  One example would be for moving delivered data records from a development environment to a child _test environment.  For all other movements where you would normally move metadata using the Promotion Manager, you should use the Promotion Manager to move delivered data via a manifest of type Delivered Data.