Transformation rules

The following enhancements are added for transformation rules in this release. They are enabled by default in your Network instance.

Network widget support


Transformation rules can now be used to transform data that is downloaded from Network widgets. For example, you can use rules to limit type of addresses that display on downloaded records.

Transformation rules are supported for Search widgets, and the Profile DCR widget.

Note: Transformation rules are not applied to the data displayed in the widget.

Configure transformation rules for widgets

To support Network widgets, transformation rules can be applied to Search and Retrieve API calls for a system. This enables the rules to be applied for any user that uses the widget. Previously, rules could be applied to the API calls for individual integration users only.

This can be specified in the rule configuration.

On the transformation rule configuration, you can apply rules to the Search and Retrieve API calls that use the defined system.

  1. Select Apply to Search and Retrieve API.

  2. Choose Apply to Search and Retrieve API calls that use the System.

This will apply the rules to the system defined in the transformation rule configuration.

The system is applied to the API call when widget users download records.

Example widget scenario

The following transformation rules are applied to the system used for a Search widget.

Address rules

  • Set Mail Only address types to Inactive

  • Limit postal codes to 5 characters

HCP rules

  • Uppercase HCP first name

  • Uppercase HCP last name

A user searches for an HCP account, Jack Diamond, in the Search widget.

Jack Diamond has two addresses: one Professional address and one Mail Only address.

When the user downloads the record, the data is transformed in the downstream application and in the JSON that is returned.

  • HCP first and last name is uppercase

  • Postal code is limited to 5 characters

  • Mail only address is inactive so it does not display to end users

Downstream application

JSON results

Transformation rules list

The Transformation Rules page is updated to display any systems that are applied to the Search and Retrieve API calls for the rules (API User/System column).

Widget configurations

A Transformation Rules section is added to Search widget and Profile widget configurations so Administrators can see the rules that are applied. This section is read-only.

Available actions:

  • Create a rule - Click Create a New Transformation Rule to navigate to the Transformation Rules page.

  • Edit a rule - Click the rule name in the Transformation Rule column to open the rule configuration page.

  • View rule - Click View Rule to open a pop-up that displays the object, field, description, and rule name.

Network API


Transformation rules can be applied to the Search and Retrieve calls for your system.

Supported API calls

Example system name = HealthPortal

API Request
Search API https://{DNS}/api/version/search?q=john&systemName=HealthPortal
Search API + Supplemental https://{DNS}/api/version/search?q=john&supplemental={ONE,ALL}&systemName=HealthPortal
Retrieve Entity API https://{DNS}/api/{version}/entity/{vid_key}?systemName=HealthPortal
Retrieve Child Entity https://DNS/api/version/child/vid_key?systemName=HealthPortal
Batch Retrieve Entity https://{DNS}/api/{version}/entities/batch?systemName=HealthPortal
Batch Retrieve Child Entity https://DNS/api/version/children/batch?systemName=HealthPortal
Retrieve HCO https://DNS/api/version/hcos/vid_key?systemName=HealthPortal
Retrieve HCP https://{DNS}/api/{version}/hcps/{vid_key}?systemName=HealthPortal
Retrieve Change Request
Batch Retrieve Change Request

Exporting configurations


Transformation rules can now be included in export packages. Add the rules to export package so you can import them on the target environment.


Most of the rule dependencies are added to the export package. This includes the system, custom fields, and custom objects. Integration users that are specified in the rules cannot be included in the export package.

Target subscriptions

When target subscriptions are added to an export package, any applied transformation rules are also included.