Data Adaptation

There are ways to adapt the data being read or written by the Common Model. For example, if one system displays data as a decimal number, but you want the data to show as a monetary value, you can transform that data as the Common Model reads and/or writes it. Adapting data is more likely to be done on the subscribing side, but it is possible to execute on both.

NOTE

Only available adaptation options will be displayed based on your configured Endpoints and Mapping Actions.

Advanced Tab

In the advanced settings, you can dictate when data gets transferred from the Common Model to other systems. For instance, on the subscribing side, you may want some functionality to only execute when a new record is created or only when data is updated. Also, data taken from the Common Model that is a string, but needs to be written to a Connector as a double or decimal value, changing the output, can be done here.

Read Action

Setting	Description
FK System Override	When the data that is read from the Connector creates a Foreign Key on the Schema, it will by default set the system of Connector. This override allows you to override the key as a value from another system.

Write Action

Setting	Description
FK System Override	When the data is written to the Connector, it will by default pull the Foreign Key value of the Connector it is writing to. This override allows you to override the key as a value from another system.
Supported Operations	By default, the map will execute for both Create and Updates; however, Supported Operations allows you to direct the map to only execute on a specific Write Operation, Create or Update.
Value Type	Allows you to format the data for a given type numeric, date, etc.
Supported Systems	By default, the map will execute for any system that posts a message that this Connector receives; however, Supported Systems allow you to only execute this map if the message came from a specific list of systems.
FK Use Label	By default, the Foreign Key map writes the value of the Foreign Key; however, this setting allows you to override the default and instead use the Label of the Foreign Key that is stored inside the Central Index.

WARNING

Users should implement the Supported Systems functionality infrequently and only in necessary instances, as this will isolate the data transfer to that specific Mapping.

Transforms Tab

Transforms can be added to either subscribe or publish Mapping; however, they are more commonly used to modify the data being consumed by a system (on the subscribe side). Transforms can be strung together to manipulate data in multiple ways.

Transform	Description	Inputs
Addition	Adds a value to a property on the Schema and outputs the result.	Add -- the value to be added
Autonumber Children	Generates a unique identifier for each child on a message (starts at 1, 2, and so on).	None (only used on primary key maps)
Business Logic Map	Adds conditional logic to a single property. Within a BizLogicMap, you can add Groups for more complex scenarios, where you can achieve And/Or scenarios, but between groups it supports only Or. For example, if the property value equals X or the property value equals Y, then return Z.	Group: And/Or, Operator, Value, Return Value. Else Return Value: If all of the groups return false, this value is returned from the map.
Business Logic Map -- Simple	Adds conditional logic to a single property. This is the same concept as BizLogicMap, but only matches for equality and does not allow for more complex logic with groupings (e.g. if equals this value then return that value).	Comparison: The value you are comparing the property to be equivalent to; then Return: If the value of the property equals the value of the Comparison, then return this value. Return Null, Return Original Value, Else Return Value.
Compute Expression	This transform can be used to take in multiple properties and perform conditional logic or computation and return a value. Uses the syntax for .NET DataTable.Compute.	Expression
Convert from Base64	Used to convert a property from a Base64 encoded string, typically in file upload scenarios.	None
Convert UTC to TimeZone	Used to convert a date time that is in UTC format to a specific time zone, most likely on a subscriber.	Time Zone
Csv To List	A single property that is a character delimited list of values, split into a List. This transform will only work when mapping into values on the Common Model that is a list of strings.	Make Distinct, Trim Items, Character Separator
Default To Current Date	If the incoming property value is null, it will default to UTC date/time. Typically used on saves for a create record.	None
Default Value	If the incoming property value is null, it will default to this value. Typically used on saves for a create record.	A predetermined value
Division	Takes a property on the Schema and divides by a value; then, outputs the result.	A Divisor (the value of what you are dividing by)
Flatten Date/Time	Used to break a date apart into individual properties on a Save, or to combine them on a Read. For example: `{ "year": 2023, "month": 1, "day": 1 }`	Include Time, Protocol, Year, Month, Day
Formatting Template	Takes one to many properties on the Schema and does a string format; then, returns the result. The format of the template uses placeholders like `{0}-{1}-{2}`. The mapping engine replaces `{0}` with the value of the first property, and so on.	Template
JSON Contains	Executes a JSONPath. If it finds a value, it returns true, else returns false.	JSONPath
Math Truncate	Trims off all decimal values.	None
Multiplication	Multiplies a value to a property on the Schema and outputs the result.	Multiplier (the value to be multiplied)
Parse to JSON	Takes a string value and generates a JSON object.	None
Regex Match	Pulls a value out of a string based on a pattern; returns text from within a string that matches the provided regular expression. Only the matching text will be used in the map (to find specific text within a string, such as a specifically formatted date that you want to pull just the month).	Match Pattern
Regex Replace	Formats a string of digits into a specific format; for example, formatting 10 digits into a specific phone number format.	Match Pattern: tells it what to find in the string. Replace Pattern: tells it how to reformat the string based on what has matched.
Round	Applies rounding on a numeric property.	Behavior: Always round up, Always round down, Default. Precision.
String Join	Takes multiple values from a Publisher and writes them as a single, delimited string to the Subscriber.	Delimiter
Substring	Retrieves a portion of a string. For example, if a field can only accept 30 characters, Substring can be used to return only the first 30 characters of a property and remove the rest.	Starting Index: the position on the string you want to start with (e.g. the starting position is 0). Number of Characters.
Subtraction	Subtracts a value from a property on the Schema and outputs the result.	Subtract -- the value being subtracted

Behaviors Tab

Behaviors are advanced level options to assist developers in further isolating data transfers. They are unique overrides, used to adapt the data so that it behaves differently than it typically would.

Behavior	Description
Allow Empty Fixed Value	Used primarily on Write Maps, it sets empty string on a field that we do not have mapped, but that needs to be included on the payload of a Save.
Bi-Directional Blocking Identifier	Used to select a field separate from the key that is unique and can be used to enforce bi-directional blocking on bi-directional endpoints.
Hide From Logging	Used to hide sensitive data (SSN, salaries, etc.) from the logs.
Allow Primary Key to Change	Used primarily on Read Maps to tell the engine it can update a value on a Primary Key in the Central Index. By default, Central prevents this from happening, so this acts as an override.
Map from Absolute Root	Used primarily on Read Maps, and mainly inside of nested maps, to path to the top level.
Map To Absolute Root	Used in nested lists to retrieve a value from the parent.
Skip if Null	Used primarily on Write maps, in instances where you want to ignore the map entirely if the incoming value on the property is null.

Overrides

Overrides allow you to define different connector properties based on operations (Create vs Update). For example, you may want a different mapping behavior on creating a new record vs. updating an existing record.

Data Adaptation ​

Advanced Tab ​

Read Action ​

Write Action ​

Transforms Tab ​

Behaviors Tab ​

Overrides ​

See Also ​